SecureTransport REST APIs

SecureTransport provides different REST APIs based on the user roles - admin or end user. The base URI for the REST API has the following structure:

https://<host>:<port>/api/<version>/ where:

  • <host> is the hostname or the IP address of the SecureTransport server.
  • <port> is the one of the following:
    • administrator resources – Administration Tool port (default 444).
    • end-user resources – HTTP or HTTPS port (default 80 or 443).
  • <version> is the SecureTransport REST API version. Note that the Admin REST API version can differ from the end-user one.

The current version of the Admin REST API is v1.4. To see the Swagger UI documentation in the browser, follow the link.

The current version of the End-user REST API is v1.5. To see the Swagger UI documentation in the browser, follow the link.

SecureTransport Administrator API

With administrator credentials, you can use the SecureTransport REST API to query, create, modify, and delete user accounts and related SecureTransport configuration information including applications, business units, certificates, sites, subscriptions, and transfer profiles. You can also use the REST API to perform the following actions:

  • Query and kill FTP and HTTP sessions.
  • Query and export logs.
  • Query, create, modify, and delete network zones to configure the SecureTransport Edge protocol.

For more information about network zones, refer to the SecureTransport Administrator's Guide.

End-User REST API

The access to the end-user API is disabled by default. Permissions are granted by an administrator on an account basis either from the user account's Edit page by selecting the Allow this account to submit transfers using the Transfers RESTful API check box or using the Admin REST API /Accounts resource.

With user credentials, you can use the SecureTransport REST API to perform the following actions:

  • Perform and manage server-initiated transfers using your transfer sites.
  • Upload files to your home folder.
  • List your home folder.
  • Change your password.
  • Trigger an email from SecureTransport Server with instructions for resetting you password.

Useful URIs

The following are useful REST API URIs:

  • https://<host>:<port>/api/ – lists all available versions
  • https://<host>:<port>/api/v<1.4 or lower>/ – resource descriptions
  • https://<host>:<port>/api/v<1.4 or lower>/docs/index.html – API reference
  • https://<host>:<port>/api/v1.4/ – GET request returns yaml or json Swagger specification:
    • Returns Swagger yaml specification with no “Accept:” HTTP header or with “Accept: application/x-yaml” header.
    • Returns Swagger json specification with “Accept: application/json” HTTP header.
  • https://<host>:<port>/api/application.wadl – WADL application description
  • https://<host>:<port>/api/v1.4/docs/index.html – Swagger-UI API reference

HTTP methods

The HTTP methods used by the API are GET, PUT, POST, and DELETE. These methods and the provided resources allow access to a single object or an array of objects.

Internet media data types

The Internet media data types supported by the REST API are application/json and application/xml. For Java use of the REST API, the SecureTransport Java API provides a library called ws-representation, which includes Java classes that represent the data that can be accessed using the REST API. The ws-representation library depends on the jersey-core and jersey-server-linking libraries version 1.13 which are available from http://jersey.java.net/. In addition to them, Java programs require the jackson libraries version 1.9.2 and validation-api version 1.0.0 GA from J2EE 6. Representations are annotated according to JSR 303. Validation is done on the server side.

 

 

 

Related Links