Supported REST management resources

Use these supported resources to send REST management requests.

Standard HTTP methods (GET, POST, PUT, and DELETE) are used with URIs to view and manage DataPower® Gateway resources.

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

The GET https://address:5554/mgmt/ request returns a structure with the available resources.
{
  "_links": {
    "self": {
      "href": "/mgmt/" },
    "config": { 
      "href": "/mgmt/config/" },
    "domains": {
      "href": "/mgmt/domains/config/" },
    "status": {
      "href": "/mgmt/status/" },
    "actionqueue": {
      "href": "/mgmt/actionqueue/" },
    "filestore": {
      "href": "/mgmt/filestore/" },
    "metadata": {
      "href": "/mgmt/metadata/" },
    "types": {
      "href": "/mgmt/types/" }
  }
}

Some of the resources can be accessed by using query parameters with the GET method. For more information, see REST management query parameters.

If an object cannot be accessed because of authorization, the error code Resource not found returns in the response and is written to the system log.

The details of the URI resources describe the actions that are supported within each resource.

Click the resource link for more details.

config URI resources

The config URI resources that access DataPower Gateway and system configuration data.

  • /mgmt/config/
    The list of all supported configurations on the DataPower Gateway.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/config/default/Domain/domain
    The domain-specific configuration for the target domain.
    • Supported HTTP methods - GET PUT DELETE
    • Supported query parameters - state
  • /mgmt/config/domain/class
    The list of all configurations of a specific object class within a specific domain, if any.
    • Supported HTTP methods - GET POST
    • Supported query parameters - state
  • /mgmt/config/domain/class/object
    The configuration of the specified instance in the domain and object class.
    • Supported HTTP methods - GET PUT DELETE
    • Supported query parameters - depth state view
  • /mgmt/config/domain/class/object/scalar_property
    The specified scalar property value of the specified configuration of the object in the domain and class.
    • Supported HTTP methods - GET PUT
    • Supported query parameters - state
  • /mgmt/config/domain/class/object/vector_property
    The specified vector property value of the specified configuration of the object in the domain and class.
    • Supported HTTP methods - GET PUT POST
    • Supported query parameters - state

domains URI resources

The domains URI resources that access data for existing domains.
  • /mgmt/domains/config/
    The list of all domains on the DataPower Gateway. This form is equivalent to /mgmt/config/Domain.
    • Supported HTTP methods - GET
    • Supported query parameters - state

status URI resources

The status URI resources that access status data of system resources.
  • /mgmt/status/
    The list of all available status providers on the DataPower Gateway.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/status/domain/class
    The status provider of the specified object class in the domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None

actionqueue URI resources

The actionqueue URI resources that access the queue for running actions.
  • /mgmt/actionqueue/
    The usage information for an actionqueue resource.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/actionqueue/{domain}
    Run any action in a domain.
    • Supported HTTP methods - POST
    • Supported query parameters - None
  • /mgmt/actionqueue/domain
    The usage information for an actionqueue resource.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/actionqueue/domain/operations
    The list of all supported operations in the specified domain. 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.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/actionqueue/domain/operations/operation
    The JSON metadata information for the operation in the specified domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/actionqueue/domain/operations/operation
    The JSON metadata information for the operation in the specified domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None

filestore URI resources

The filestore URI resources that access file and directory data.
  • /mgmt/filestore/
    The list of available URIs.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/filestore/domain
    The list of available directories for the specified domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/filestore/domain/directory
    The contents of the directory in the specified domain in the file system.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/filestore/domain/directory/file
    The contents of the file in the specified domain and directory.
    • Supported HTTP methods - GET POST PUT DELETE
    • Supported query parameters - None

metadata URI resources

The metadata URI resources that access the metadata of objects.
  • /mgmt/metadata/
    The list of valid URIs for fetching metadata.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/metadata/domain/class
    The complete metadata for a specific configuration or status object in the specified domain and object class.
    • Supported HTTP methods - GET
    • Supported query parameters - depth view
  • /mgmt/metadata/domain/class/property
    The metadata for a specific property of an object class in the specified domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/metadata/domain/operations/operation
    The metadata information for the specific actionqueue operation in the specified domain.
    • Supported HTTP methods - GET
    • Supported query parameters - None

types URI resources

The types URI resources that access objects types.
  • /mgmt/types/
    The list of all types in use on the DataPower Gateway, including base types.
    • Supported HTTP methods - GET
    • Supported query parameters - None
  • /mgmt/types/domain/type
    The list of all types in use on the DataPower Gateway, including base types.
    • Supported HTTP methods - GET
    • Supported query parameters - None