REST Management API

A REST API is available for managing the Gateway. This API can be install either from the Policy Manager or it can be installed automatically on new Gateways using the auto-provisioning service.
gateway83
A REST API is available for managing the Gateway. This API can be install either from the Policy Manager or it can be installed automatically on new Gateways using the auto-provisioning service.
When you create a configuration initially, it is best to use the Policy Manager first, then use the REST Management API to manipulate the template. This is easier and less error prone than attempting to create the configuration solely using the REST Management API.
 
Observe the following when using the REST Management API:
  • Do not use encoded XML with the REST Management API, as it is not parsed correctly.
  • Do not use "%0A" in URLs. This string is translated into a line feed, which causes issues.
Install the REST Management Service
You can install the REST Management Service using
either
of the following methods:
  • Via the the GUI in the Policy Manager
  • Auto-provision via the command line (Policy Manager not required)
To install the REST Management API from the Policy Manager:
  1. In Policy Manager, select [
    Tasks
    ] > 
    Publish Internal Service
     from the main menu (in the browser client, [
    Manage
    ] > 
    Publish Internal Service
    ).
  2. From list of services, select 
    Gateway REST Management Service
    .
  3. Optionally, change the
    Routing URI
    if necessary.
    Note:
    The routing URI must always end with
    /*
    .
  4. Click [
    Finish
    ] to publish the service.
    The Gateway REST Management Service is created and resides in the root folder. 
To install the REST Management API using auto-provisioning:
Auto-provisioning can be used on new or restored Gateways with no other services installed. The
API Gateway
 machine must be accessible.
  1. Log in as
    ssgconfig
    and open a privileged command shell from the Gateway configuration menu.
  2. Run the following commands to create an empty file named "restman" in the specified folder:
    # mkdir -p touch /opt/SecureSpan/Gateway/node/default/etc/bootstrap/services/ # touch /opt/SecureSpan/Gateway/node/default/etc/bootstrap/services/restman
  3. Exit the privileged shell.
    The REST Management Service is auto-provisioned the next time the Gateway is restarted.
Access the REST Management API Documentation
To learn how to use the Gateway REST API, navigate to the following URL after installing the API:
https://<GatewayHostName>:<port>/<GatewayRESTRoutingURI>/1.0/doc/home.html
For example:
https://gateway.mycompany.com:9443/restman/1.0/doc/home.html
Log in with your Policy Manager credentials when prompted.
If you enter incorrect credentials, a message mentioning "Authentication Failed" is displayed. Trying to access the REST Management API documentation again may simply repeat this error and not prompt for credentials again. If this happens, try these troubleshooting tips:
  • Close the browser tab and open a new tab.
  • Clear your browser's cache.
  • Access the URL in "private browsing" or "incognito" mode in your browser.
The online documentation is organized across the following sections:
  • Getting Started:
    Shows how to make a basic REST API call. Provides basic navigation information about the API.
  • Authentication:
    Describes how to authenticate and how users are restricted.
  • Resources:
    Contains a list of all the API resource endpoints. Lists the URLs, parameters, responses, and anything else required to make an API call to the resource.
  • Migration:
    Describes the migration process. Includes information on how to bundle, how to import, and how to resolve mapping issues.