Page History

...

get

URL

/api/v1/api.php?target=DHCPServer&action=get

Description

Accepts search criteria to retrieve a list of all matching DHCP Servers.

Returns

Examples:

SUCCESSFUL:

{"success":1,"message":"Search Successful.","data":[{"DHCPId":"1","DHCPServer": "trace.foo.com","DHCPPort":"22","DHCPUsername":"benner","DHCPPassword": "h}kc))jwqhgd","DHCPType":"ISC","DHCPConfigPath":"\/usr\/local\/dhcp\/etc \/dhcpd.conf","DHCPServerStop":"sudo kill -9 `cat \/var\/run\/dhcpd.pid`", "DHCPServerStart":"sudo \/usr\/local\/dhcp\/sbin\/dhcpd -p 75","DHCPDefaultLease" :null,"DHCPMaxLease":null,"DHCPAuthoritative":"1","DHCPLogFacility":"local7", "DHCPDomainName":null,"DHCPNameServers":null,"DHCPUseText":"0","DHCPConfigText":null}]}

ERROR:

{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
DHCPId	INT	The ID of the DHCP Server entry.
DHCPServer	STRING	The address of the DHCP Server
DHCPPort	INT	The port the DHCP Server can be reached on.
DHCPUsername	STRING	The user name required to access the DHCP Server
DHCPPassword	STRING	The password required to access the DHCP Server
DHCPType	STRING	The type of DHCP Server
DHCPConfigPath	STRING	Path to DHCP Configuration file
DHCPServerStop	STRING	Commandto stop the DHCP Server
DHCPServerStart	STRING	Command to start the DHCP Server
DHCPDefaultLease	STRING	Default lease time for this server
DHCPMaxLease	STRING	Maximum lease time for this server
DHCPAuthoritative	BOOL	Whether or not this server is authoritative
DHCPLogFacility	STRING	Logging facility for this server
DHCPDomainName	STRING	Domain names servers used by this server
DHCPNameServers	STRING	Name servers used by this server
DHCPUseText	BOOL	Whether or not to use the entry builder or a config text file
DHCPConfigText	STRING	The text of the config text file

Optional Parameters

Name	Type	Example	Description
likeFlag	BOOL	1	When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
generalFlag	BOOL	1	When 1, searches over the provided parameters using OR. If 0 or omitted, uses AND.

Name	Type	Example	Description
DHCPId	INT	123	The DHCP Server ID to search for.
DHCPServer	STRING	IP/domain	The Server Name to search for.
DHCPPort	STRING	43	The Port to search for.
DHCPUsername	STRING	kjennings	The Username to search for.
DHCPType	STRING	MSDHCP	The DHCP Server Type to search for.
DHCPConfigPath	STRING	/where/is/it/	The Config Path to search for.
DHCPServerStop	STRING	/path/to/server/stop	Search by server stop command.
DHCPServerStart	STRING	/path/to/server/start	Search by server start command.
DHCPDefaultLease	INT	64000	Search by default lease.
DHCPMaxLease	INT	128000	Search by max lease.
DHCPAuthoritative	BOOL	1	Search by whether the server is authoritative.
DHCPLogFacility	STRING	local7	Search by logging facility.
DHCPDomainName	STRING	domain.name.server	Search by domain name servers.
DHCPNameServers	STRING	ns.domain.com	Search by name servers.
DHCPUseText	BOOL	1	Search by using text configs or not.
DHCPConfigText	STRING	Text File	Search by text file contents.

Example URL

/api/v1/api.php?target=DHCPServer&action=get&likeFlag=1&DHCPUsername=kjenn

update

URL

/api/v1/api.php?target=DHCPServer&action=update

Description

First performs a search based on the submitted DHCP Server criteria, then performs an Update across those entries based on new values.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Update Successful."}
ERROR:	{"success":0, "message":"error message"}

Optional Parameters

Name	Type	Example	Description
likeFlag	BOOL	1	When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.

Name	Type	Example	Description
SearchId	INT	123	The DHCP Server ID to search for.
SearchServer	STRING	IP/domain	The Server Name to search for.
SearchPort	STRING	43	The Port to search for.
SearchUsername	STRING	kjennings	The Username to search for.
SearchType	STRING	MSDHCP	The DHCP Server Type to search for.
SearchConfigPath	STRING	/where/is/it/	The Config Path to search for.
SearchServerStop	STRING	/path/to/server/stop	Search by server stop command.
SearchServerStart	STRING	/path/to/server/start	Search by server start command.
SearchDefaultLease	INT	64000	Search by default lease.
SearchMaxLease	INT	128000	Search by max lease.
SearchAuthoritative	BOOL	1	Search by whether the server is authoritative.
SearchLogFacility	STRING	local7	Search by logging facility.
SearchDomainName	STRING	domain.name.server	Search by domain name servers.
SearchNameServers	STRING	ns.domain.com	Search by name servers.
SearchUseText	BOOL	1	Search by using text configs or not.
SearchConfigText	STRING	Text File	Search by text file contents.

Name	Type	Example	Description
UpdateServer	STRING	IP/domain	The new server address.
UpdatePort	STRING	43	The new port.
UpdateUsername	STRING	kjennings	The new username.
UpdatePassword	STRING	********	The new password.
UpdateType	STRING	ISC	The new server type.
UpdateConfigPath	STRING	/where/is/it/	The new config path.
UpdateServerStop	STRING	/path/to/server/stop	The new server stop command.
UpdateServerStart	STRING	/path/to/server/start	The new server start command.
UpdateDefaultLease	INT	64000	The new default lease.
UpdateMaxLease	INT	128000	The new max lease.
UpdateAuthoritative	BOOL	1	The new Authoritative status.
UpdateLogFacility	STRING	local7	The new logging facility.
UpdateDomainName	STRING	domain.name.server	The new domain name servers.
UpdateNameServers	STRING	ns.domain.com	The new name servers.
UpdateUseText	BOOL	1	The new use text file setting.
UpdateConfigText	STRING	Text File	The new use text file content.

Example URL

/api/v1/api.php?target=DHCPServer&action=getupdate&likeFlagSearchPort=143&DHCPUsernameUpdatePort=kjenn48

add

URL

/api/v1/api.php?target=DHCPServer&action=add

Description

Adds a new DHCP Server.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Add Successful.","data":123}
ERROR:	{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
data	INT	The ID of the new DHCP Server.

Required Parameters

Name	Type	Example	Description
DHCPServer	STRING	IP/domain	The new server address.
DHCPPort	STRING	43	The new port.
DHCPUsername	STRING	kjennings	The new username.
DHCPPassword	STRING	********	The new password.
DHCPType	STRING	ISC	The new server type.

Optional Parameters

Name	Type	Example	Description
DHCPConfigPath	STRING	/where/is/it/	The new config path.
DHCPServerStop	STRING	/path/to/server/stop	The new server stop command.
DHCPServerStart	STRING	/path/to/server/start	The new server start command.
DHCPDefaultLease	INT	64000	The new default lease.
DHCPMaxLease	INT	128000	The new max lease.
DHCPAuthoritative	BOOL	1	The new Authoritative status.
DHCPLogFacility	STRING	local7	The new logging facility.
DHCPDomainName	STRING	domain.name.server	The new domain name servers.
DHCPNameServers	STRING	ns.domain.com	The new name servers.
DHCPUseText	BOOL	1	The new use text file setting.
DHCPConfigText	STRING	Text File	The new use text file content.

...

Page tree

Versions Compared

Old Version 3

New Version 4

Key

get

update

add