REST management interface

The REST management interface provides access to the actions and to the configuration and status resources on the DataPower® Gateway.

With REST management requests, you can do the following activities.
  • Retrieve status or configuration data.
  • Create, modify, or delete a configuration.
  • Run actions.
In this respect, REST management is similar to the SOAP management with the XML management interface.

The REST management interface is available after you enable its administrative state. After you enable the REST management interface, you can send HTTP requests to the interface port and receive JSON-formatted responses with a payload and indication of success or failure. To send requests and receive responses, you can use the curl program, a similar shell tool, or a browser tool such as one for Firefox or Chrome. The response contains information about the resource at the URI target.

You can use REST management by incorporating REST managements requests in programs.

The management resources that REST management provides follow a URI structure that arranges resources based on domains, domain resources, and objects. The domain resources that are provided are config, domains, status, filestore, actionqueue, metadata, and types.

REST management uses the HTTP GET, POST, PUT, and DELETE methods on its URIs. Not every resource is available for all HTTP methods. The methods that are allowed in a particular URI are determined with an OPTIONS request. Resources available from any particular URI are displayed as embedded links.

The response payload conforms to the Hypertext Application Language standard. With this format, you can identify available resources in the JSON responses.

To use REST management, you must be able to read XML schemas to create a valid REST management request. If you submit a request without credentials, the DataPower Gateway returns an authentication error as the response.