Operations

The available operations vary depending on the type of object involved. See the sections below for details about the available options for each type of resource, and the HTTP method that is used to complete each operation.

Elements

The table below lists the supported operations for element resources.

Supported Operations for aXAPIv3 Elements
Operation HTTP Method Description
Get Object GET Returns the JSON data of a configured element.
Modify Object POST Modifies an element that has already been created. Note that this usage of the HTTP POST method is idempotent, as all elements have a unique name or identifier in the form of their Object Key.
Replace Object PUT Replaces a configured element’s configuration with a new configuration. This operation is idempotent. However, unlike Modify Object, it is not additive. This means that if a particular parameter was previously configured, but you do not specify a value for it while performing a Replace Object operation, that parameter will be reset to its default value.
Delete Object DELETE Removes the element from its collection and from the ACOS device.

Collections

The table below lists the supported operations for collection resources.

Operation HTTP Method Description
Get List GET Returns a JSON representation of all elements inside a collection, and their parameters and child elements.
Create List POST This method allows you to either create new elements or modify existing elements in this collection.
Replace List PUT Similar to Replace Object, this operation replaces all values inside the collection. This means that any element not in the Replace List operation’s JSON data will be removed from the collection and the ACOS device.
Delete List DELETE Deletes all elements within the collection, removing them from the ACOS device’s configuration. Note that the collection itself cannot be deleted - it will continue to exist as an empty list.

Intermediate Resources

The table below lists the supported operations for intermediate resources.

Operation HTTP Method Description
Get Object GET Returns configuration information for the elements and collections contained in the module.

Note

You cannot modify an intermediate resource, or use it to configure any elements or collections contained within it.

Configuration Resources

The table below lists the supported operations for configuration resources.

Operation HTTP Method Description
Get Object GET Returns a representation of the current configuration of this resource.
Modify Object POST Specify values other than the default settings for this configuration object. You can only configure one of each configuration object. This use of the POST method is idempotent.
Replace Object PUT Replaces the settings object’s attributes completely. This means that if a particular parameter was previously configured, and is not in the Replace Object’s parameters, that parameter’s values will be set to the default.
Delete Object DELETE Deletes the configuration resource, returning all attributes to their default values.

Statistics Data Resources

The table below lists the supported operations for statistics data resources.

Operation HTTP Method Description
Get Object GET Returns statistics counters and their current values for the element or collection resource specified in the URI.
Modify Object POST Reset specific counters to zero for the element or collection resource.
Delete Object DELETE Clear all counters for the element or collection resource.

Note

You cannot modify statistics data resources. You can only get or reset the values of the counters.

Operational Data Resources

The table below lists the supported operations for operational data resources.

Operation HTTP Method Description
Get Object GET Return information about the operational status of the element, such as Up or Down, or any current sessions or dynamically assigned attributes.
Delete Object DELETE Reset the operational status of a resource that contains sessions or dynamically assigned attributes, such as IP or MAC addresses.

Note

You cannot always modify an operational data resource directly. In those cases, you would modify the element’s status through the element’s own URI. (For example, a virtual port can be enabled or disabled via its own URI, but its operational data resource only indicates whether it is Up or Down.)

Baseline Data Resources

The table below lists the supported operations for baseline data resources.

Operation HTTP Method Description
Get Object GET Returns baseline counters and their current values for the element or collection resource specified in the URI.

Note

You cannot modify baseline data resources.

Rate Data Resources

The table below lists the supported operations for rate data resources.

Operation HTTP Method Description
Get Object GET Returns rate counters and their current values for the element or collection resource specified in the URI.

Note

You cannot modify rate data resources.