Versions Compared

Old Version 3

changes.mady.by.user The Force

Saved on

compared with

New Version 4

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Converted from version 5.1.3

...

addTags

URL 
Description 
Returns

Examples

SUCCESSFUL 
ERROR{ "success":0, "message":"error message" }
Required Parameters
NameTypeExampleDescription
XXXX
Optional Parameters
NameTypeExampleDescription
XXXX
Example URL 

smartAssign

URL api/v1/api.php?target=vlan&action=smartAssign
Description Finds and enables an unassigned VLAN matching the provided search parameters and optionally renames it.
Returns

Examples

SUCCESSFUL

Return Data:  the full domain description, plus the chosen VLAN with its new name (optional)

{"success":1,"message":"VLAN enabled. ","data":{"21":{"id":"21","domain":"Swisscom Demo","attr_6c":"{\"range\":\"E\"}","attr_custom":null,"vlans":[{"id":"46183","vlan":"1808","name":"RESERVED_DEV"}]}}}

ERROR{ "success":0, "message":"error message" }
Required Parameters
NameTypeExampleDescription
domainIdINTEGER15The Id number of the domain you would like to Smart Assign from.
Optional Parameters
NameTypeExampleDescription
tagsSTRING5,7,12A comma-separated list of the Tag Ids being used for the Smart Assign. 
nameSTRINGCustomerName_13, RESERVED_DEVThe name that will be assigned to the VLAN matching the given search parameters. 
Example URL api.php?target=vlan&action=smartAssign&domainId=21&name=RESERVED_DEV&tags=5,7,12