Object Structure

When creating a new object using the REST API, you define the object’s properties in the body data of an HTTP PUT request. The URL defines the API version and name of the new object.

For example, to create a new IP-based session persistence class using the REST API, you use a PUT request with the following object to an endpoint such as "/api/tm/8.3/config/active/persistence/my_persistence_class":

{

"properties": {

"basic": {

"type": "ip"

}

}

}

The equivalent configuration document in YAML is as follows:

version: 6.1

persistence:

- name: my_persistence_class

properties:

basic:

type: ip

The configuration definition in both cases contains a top level object named "properties", with all the configuration keys nested below it in one or more sections.

All settings defined within the "properties" section follow the REST schema. To view the schema, see the Pulse Secure Virtual Traffic Manager: REST API Guide.