Versions Compared

Old Version 6

changes.mady.by.user The Force

Saved on

compared with

New Version 7

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed duplicate SearchID String entries, added example URLs

...

update

URL/api/v1/api.php?target=DHCPEntry&action=update
DescriptionFirst performs a search based on the submitted DHCP Entry criteria, then performs an Update across those entries and all found Options based on new values.
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Update Successful."}
ERROR:{"success":0, "message":"error message"}
Optional Parameters
NameTypeExampleDescription
likeFlagBOOL1When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
NameTypeExampleDescription
SearchIdINT123The ID of the DHCP Entry to search for.
SearchParentINT123The parent Entry to search for.
SearchServerIdINT123The DHCP Server to search for.
SearchTypeSTRINGsubnetThe Entry type to search for.
SearchNameSTRING30.20.10.1The name to search for.
SearchNetmaskSTRING255.255.255.0The subnet mask to search for.
SearchIdSTRING123The Option ID to search for.
SearchKeySTRINGrangeThe key portion of the option key-value pairing to search for.
SearchValueSTRING30.20.10.10 30.20.10.40The value portion of the option key-value pairing to search for.
NameTypeExampleDescription
UpdateParentINT123The new parent data.
UpdateServerIdINT123The new DHCP Server ID.
UpdateTypeSTRINGsubnetThe new Entry type.
UpdateNameSTRING30.20.10.1The new name.
UpdateNetmaskSTRING255.255.255.0The new subnet mask.
UpdateKeySTRINGrangeThe new key portion of the option key-value pairing.
UpdateValueSTRING30.20.10.10 30.20.10.40The new value portion of the option key-value pairing.
Example URL

/api/v1/api.php?target=DHCPEntry&action=update&SearchID=123&UpdateName=30.20.10.0

updateOption

URL/api/v1/api.php?target=DHCPEntry&action=updateOption
DescriptionFirst performs a search based on the submitted DHCP Entry criteria, then performs an Update across all found Options, without altering found Entries.
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Update Successful."}
ERROR:{"success":0, "message":"error message"}
Optional Parameters
NameTypeExampleDescription
likeFlagBOOL1When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
NameTypeExampleDescription
SearchIdINT123The ID of the DHCP Entry to search for.
SearchParentINT123The parent Entry to search for.
SearchServerIdINT123The DHCP Server to search for.
SearchTypeSTRINGsubnetThe Entry type to search for.
SearchNameSTRING30.20.10.1The name to search for.
SearchNetmaskSTRING255.255.255.0The subnet mask to search for.SearchIdSTRING123
The Option ID to search for.SearchKeySTRINGrangeThe key portion of the option key-value pairing to search for.
SearchValueSTRING30.20.10.10 30.20.10.40The value portion of the option key-value pairing to search for.
NameTypeExampleDescription
UpdateKeySTRINGrangeThe new key portion of the option key-value pairing.
UpdateValueSTRING30.20.10.10 30.20.10.40The new value portion of the option key-value pairing.
Example URL /api/v1/api.php?target=DHCPEntry&action=updateOption&SearchNetmask=255.255.255.0&UpdateValue=30.20.10.10 
addOption

add

URL/api/v1/api.php?target=DHCPEntry&action=add
DescriptionAdds a new DHCP Entry and returns the new ID.
Returns

Examples:

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


Data Detail:

NameTypeDescription
dataINTThe ID of the new DHCP Entry.
Required Parameters
NameTypeExampleDescription
EntryServerIdINT123The DHCP Server this new Entry belongs to.
EntryTypeSTRINGsubnetThe Entry type of this new Entry.
EntryNameSTRING30.20.10.1

The name of this new Entry.

EntryNetmaskSTRING255.255.255.0The subnet mask of this new Entry.
Optional Parameters
NameTypeExampleDescription
EntryParentINT123The parent Entry to search for.
Example URL 

addOption

URL/api/v1/api.php?target=DHCPEntry&action=add&EntryServerId=123&EntryType=subnet&EntryName=30.20.10.1&EntryNetmask=255.255.255.0

addOption

URL/api/v1/api.php?target=DHCPEntry&action=addOption
DescriptionDescriptionCreates a new DHCP Option and returns the new ID.
Returns

Examples:

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


Data Detail:

NameTypeDescription
dataINTThe ID of the new DHCP Option.
Required Parameters
NameTypeExampleDescription
OptionSubnetIdINT123The DHCP Entry this Option belongs to.
OptionKeySTRINGrangeThe key portion of the option key-value pairing to search for.
OptionValueSTRING30.20.10.10 30.20.10.40The value portion of the option key-value pairing to search for.
Example URL/api/v1/api.php?target=DHCPEntry&action=addOption&OptionSubnetId=123&OptionKey=range&OptionValue=30.20.10.10 

delete

URL/api/v1/api.php?target=DHCPEntry&action=delete
DescriptionPerforms a search over the DHCP Entry dataset and deletes all found matches, along with their associated Options.
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"DHCPEntries(s) Deleted."}
ERROR:{"success":0, "message":"error message"}
Optional Parameters
NameTypeExampleDescription
likeFlagBOOL1When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
NameTypeExampleDescription
EntryIdINT123The ID of the DHCP Entry to search for.
EntryParentINT123The parent Entry to search for.
EntryServerIdINT123The DHCP Server to search for.
EntryTypeSTRINGsubnetThe Entry type to search for.
EntryNameSTRING30.20.10.1The name to search for.
EntryNetmaskSTRING255.255.255.0The subnet mask to search for.
OptionIdSTRING123The Option ID to search for.
OptionKeySTRINGrangeThe key portion of the option key-value pairing to search for.
OptionValueSTRING30.20.10.10 30.20.10.40The value portion of the option key-value pairing to search for.
Example URL /api/v1/api.php?target=DHCPEntry&action=delete&EntryParent=123

deleteOption

URL/api/v1/api.php?target=DHCPEntry&action=deleteOption
DescriptionPerforms a search over the DHCP Entry dataset and deletes all found Options while leaving the Entries intact.
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"DHCP Option(s) Deleted."}
ERROR:{"success":0, "message":"error message"}
Optional Parameters
NameTypeExampleDescription
likeFlagBOOL1When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
NameTypeExampleDescription
EntryIdINT123The ID of the DHCP Entry to search for.
EntryParentINT123The parent Entry to search for.
EntryServerIdINT123The DHCP Server to search for.
EntryTypeSTRINGsubnetThe Entry type to search for.
EntryNameSTRING30.20.10.1The name to search for.
EntryNetmaskSTRING255.255.255.0The subnet mask to search for.
OptionIdSTRING123The Option ID to search for.
OptionKeySTRINGrangeThe key portion of the option key-value pairing to search for.
OptionValueSTRING30.20.10.10 30.20.10.40The value portion of the option key-value pairing to search for.
Example URL /api/v1/api.php?target=DHCPEntry&action=deleteOption&EntryNetmask=255.255.255.0