Resource Model Reference

This chapter provides a complete reference listing for the Traffic Manager REST API resource model.

About the Resource Model Reference

This chapter lists all the configuration, counter, and information resources available through the REST API model.

Each section relates to a specific resource and lists its name, description, unique URI path, and a table of properties.

For each property, you can find the description and data type. Additional information is provided where applicable, such as default value, permitted values (for enumerated types), and SNMP counter name. For Table-type properties, a list of the Primary and Sub keys is provided.

The path to use in your URIs is listed for each resource. For example, the URI path for a virtual server configuration resource is “virtual_servers”, so to address a stored virtual server named "foo", you would use:

/api/tm/8.3/config/active/virtual_servers/foo

Getting Information About the Structure of Resources

To obtain information about the structure of resources through the REST API itself, use the “metadata” query string argument with any request URI. For example:

https://<host>:<port>/api/tm/8.3/config/active/virtual_servers?metadata

https://<host>:<port>/api/tm/8.3/config/active/virtual_servers/foo?metadata

https://<host>:<port>/api/tm/8.3/status/local_tm/statistics/pools/mypool?metadata

https://<host>:<port>/api/tm/8.3/status/myvtm/state?metadata

You can append ?metadata to a resource type (“/virtual_servers”) or to an instance of a resource (“/virtual_servers/foo”). The Traffic Manager returns the relevant details in a “metadata” element in the JSON response. For example:

“metadata”:{

   “description”: “description of the resource”,

   “properties”: {

      “sectionA”: {

         “property1”: {

            “description”: “description of property1”,

            “type”: “property type”,

            “default”: <default value>

         }

      }

   }

}

The response contains resource level metadata, along with a “properties” element. This follows the same structure as a typical “properties” element, with sections and properties. All properties contain values for the "description", "type", and "default" value. The default value matches the type of the property.