REST management resources summary

You use URIs to work with appliance resources.

The root URI begins with the /mgmt/ resource. All available resources are positioned below this resource.

The GET https://address:5554/mgmt/ request returns a structure with the available resources.

Configuration resources

Use the configuration resources for the following actions:
  • Viewing appliance configuration
  • Configuring the appliance

Query parameters are available for use with these resources, see Query parameters.

Table 1. Configuration resources
URI Supported HTTP methods Supported query parameters Description
/mgmt/config/ GET none List of appliance configurations
/mgmt/config/default/class GET, POST state List of all configurations of a specific object class
/mgmt/config/default/class/object GET, PUT, DELETE depth, state, view configuration of the specified instance in the object class
/mgmt/config/default/class/object/scalar_property GET, PUT state The value of the specified scalar property belonging to the specified object in the class.
/mgmt/config/domain/class/object/vector_property GET, PUT, POST state The value of the specified vector property belonging to the specified object in the class.

Status resources

Use the status resources to access appliance status information.

Table 2. Status resources
URI Supported HTTP methods Description
/mgmt/status/ GET List of all available status providers on the appliance
/mgmt/status/default/class GET The status provider of the specified object class

Actionqueue resources

Use the actionqueue resources to trigger operations on the appliance.

Table 3. Actionqueue resources
URI Supported HTTP methods Description
/mgmt/actionqueue/ GET Usage information for an actionqueue resource.
/mgmt/actionqueue/default/ POST Run any action
/mgmt/actionqueue/default/operations GET List of all supported operations. The only actions that are supported are listed in the /mgmt/actionqueue/domain/operations URI. The actions that are excluded from the AnyActionElement type are specified in store:///xml-mgmt.xsd.
/mgmt/actionqueue/default/operations/operation GET JSON metadata information for the operation

Filestore resources

Use the filestore resources to work with files and directories on the appliance.

Table 4. Filestore resources
URI Supported HTTP methods Description
/mgmt/filestore/ GET List of available URIs
/mgmt/filestore/default/ GET List of available directories
/mgmt/filestore/default/directory GET Contents of the specified directory
/mgmt/filestore/default/directory/file GET, PUT, POST, DELETE Contents of the specified file

Metadata resources

Use these resources to access the metadata of appliance objects.

Table 5. Metadata resources
URI Supported HTTP methods Description
/mgmt/metadata/ GET List of valid URIs for fetching metadata
/mgmt/metadata/default/class GET Complete metadata for a specific appliance configuration or status object in the specified object class
/mgmt/metadata/default/class/property GET Metadata for a specific property of an object class
/mgmt/metadata/default/operations/operation GET, PUT, POST, DELETE Metadata information for the specific actionqueue operation

Type resources

Use these resources to access object types.

Table 6. Type resources
URI Supported HTTP methods Description
/mgmt/types/ GET List of all types in use on the appliance, including base types
/mgmt/types/default/type GET