Resource URI Patterns

Resource URIs are case-sensitive.

The Traffic Manager provides access to its resources through a common base URI that identifies the root of the resource model:

https://<host>:<port>/api/tm/<version>

In this URI path:

•<host>: The hostname of the Traffic Manager whose REST API you are accessing.

•<port>: The port that the REST API is published on (typically "9070").

•<version>: The version number of the REST API you are accessing. Details of supported versions are contained in the release notes supplied with your product variant.

All client applications and scripts that access the Traffic Manager REST API must use the same supported major version of the API at any one time. The Traffic Manager does not support interactions using multiple versions concurrently.

In the previous example, a scheme of HTTPS is used to signify an encrypted connection from a remote client. HTTP is supported only where the connection is to a server on the same host. For further details, see Authentication.

The Traffic Manager presents different resource types at specific child nodes under this root URI.

Configuration Resources

Configuration resources map to objects in the Traffic Manager's configuration system. To access configuration resources, use the following URI pattern:

https://<host>:<port>/api/tm/<version>/config/active

Instances of a particular configuration resource, such as a virtual server, are persistently stored and alter the host Traffic Manager's behavior if changed. Additionally, changes you make here are synchronized automatically to all other Traffic Managers in the cluster.

To view or modify a stored configuration resource record, append the full path to the end of the base URI. For example, to issue a request for a virtual server resource named "Web", use the following URI:

https://myhost:9070/api/tm/8.3/config/active/virtual_servers/Web

Counter and Information Resources

Counter resources map to SNMP counter objects generated by the Traffic Manager. To access counter resources, use the following URI pattern:

https://<host>:<port>/api/tm/<version>/status/<tm>/statistics

Information resources provide basic information data about your cluster members. To access information resources, use the following URI pattern:

https://<host>:<port>/api/tm/<version>/status/<tm>/

Unlike configuration resources, instances of counter and information resources are specific to each Traffic Manager in the cluster. You can access the data for all of your cluster members from the base URI of any one of them by specifying the desired member hostname in the /<tm>/ child node.

For example, to request the SNMP counter data from cluster member "myhost2" for a pool named "P1", use the following URI:

https://myhost:9070/api/tm/8.3/status/myhost2/statistics/pools/P1

The child node <tm> also accepts the special node name “local_tm”, to refer to the REST API of the Traffic Manager you are accessing. For further information, see Traversing the Tree.