update |
|---|
| URL | api/v1/api.php?target=vlan&action=update |
| Description | Update properties of a VLAN: name, tags, or both. |
| Returns | Examples | SUCCESSFUL | {"success":1,"message":"VLAN (table ID 11735) updated","id":"11735","data":[{"id":"11735","vlan":"50","domain_id":"7","resource_id":null,"name":"","domain_name":"lax.com","tags":[],"tagsString":[]}]} | | ERROR | { "success":0, "message":"error message" } |
|
| Required Parameters | | Name | Type | Example | Description |
|---|
| id | INTEGER | 11735 | VLAN record ID (which is “id” of the VLANs in “get” action results) |
|
| Optional Parameters | | Name | Type | Example | Description |
|---|
| name | STRING or empty string | HQ | name of the VLAN | | tags | INTEGER or STRING or empty string | 111,112 | ID of tags to be assigned to this VLAN. Multiple tags IDs are assignable with a comma delimiter. Empty parameter will result in no tags being assigned. | | enabled | BOOLEAN | false | Set the VLAN as enabled (true) or disabled (false). |
|
| Example URL | api/v1/api.php?target=vlan&action=update&id=11735&name=OReilly&tags=156,159 api/v1/api.php?target=vlan&action=update&id=11735&name=OReilly api/v1/api.php?target=vlan&action=update&id=11735&tags=156,159 api/v1/api.php?target=vlan&action=update&id=11735&name= api/v1/api.php?target=vlan&action=update&id=11735&tags= |
