IBM Cloud API Docs

Introduction

Last updated: 2020-01-09

The Secure Gateway Service brings Hybrid Integration capability to your IBM Cloud environment. It provides secure connectivity from IBM Cloud to other applications and data sources running on-premise or in other clouds. A remote client is provided to enable secure connectivity.

For more, see: Getting started with Secure Gateway.

Region API endpoint
US South sgmanager.us-south.securegateway.cloud.ibm.com
US East sgmanager.us-east.securegateway.cloud.ibm.com
United Kingdom sgmanager.eu-gb.securegateway.cloud.ibm.com
Germany sgmanager.eu-de.securegateway.cloud.ibm.com
Sydney sgmanager.au-syd.securegateway.cloud.ibm.com

Prerequisites

  1. Install the IBM Cloud Command Line Client.
  2. Login to your org and space using the CLI.
    $ ibmcloud login
$ ibmcloud target --cf-api <ENDPOINT> [-o <ORG>] [-s <SPACE>]
  3. Find Your Org ID and Space ID
    $ ibmcloud iam org <ORG> --guid
$ ibmcloud iam space <SPACE> --guid
  4. Find your UAA token
    $ ibmcloud iam oauth-tokens

IAM token: Bearer XXXXXXXXXXXX
UAA token: Bearer TOKEN #copy this TOKEN
  5. When invoke some API method to configure the Secure Gateway instance, you will need to pass your UAA token to authenticate your IBM Cloud Identity. For example:
    $ curl -H "Authorization: Bearer $UAATOKEN

Authentication

Beside that UAA token, you can still use your API Key to to authenticate your IBM Cloud Identity. For example:

If you pass in an API key, use apikey for the username and the value of the API key as the password. For example, if the API key is 0a1A2b3B4c5C6d7D8e9E in the service credentials, include the credentials in your call like this:

$ curl -u "apikey:0a1A2b3B4c5C6d7D8e9E"

Or

$ TOKEN=`echo -n "apikey:0a1A2b3B4c5C6d7D8e9E" | base64`
$ curl -H "Authorization: Basic $TOKEN"

However, for security concern, it is recommended to use the UAA token instead of the API Key.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Check whether your credentials is valid or whether it is expired.
403 Forbidden The supplied authentication is not authorized.
404 Not Found The requested resource could not be found.
409 Conflict The entity is already in the requested state.
500 Internal Server Error Your request could not be processed. Wait a few minutes and try again.

Methods

Import Service or Gateway

Import .gateway or service.config file to recreate the gateway(s) and destination(s) they were initially created from.

PUT /v1/import

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

Form Parameters

  • state
    Required*
    file

    The imported .gateway or service.config file

  • curl -X PUT   -H 'Authorization: Bearer <UAA token>'   -F 'state=@{imported_file}'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/import?org_id={org_id}&space_id={space_id}'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Export Service

Export the gateway(s) and destination(s) from the service

GET /v1/export

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

  • curl -X GET   -o service.config   -H 'Authorization: Bearer <UAA token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/export?org_id={org_id}&space_id={space_id}'

Response

Response Body

object

Status Code

  • 200

    The exported service service.config

No Sample Response

This method does not specify any sample responses.

List all existing gateway(s)

Retrieve existing gateway(s) in a service

GET /v1/sgconfig

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

  • type
    string

    Whether to only include enabled or disabled gateway(s). Should be a Boolean. If not specified all gateway(s) will be returned.

    Allowable values: [enabled,disabled]

  • curl -X GET   -H 'Authorization: Bearer <UAA token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig?org_id={org_id}&space_id={space_id}'

Response

Response Body

object[]

The list of the gateway(s)

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Create a new gateway

Create a new gateway

POST /v1/sgconfig

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

  • acknowledgeOverage
    boolean

    Whether you acknowledge that creating overage gateway might incur an addtional monthly cost.

Request Body

Required*
object

A description of this gateway

  • curl -X POST   -H 'Authorization: Bearer <UAA token>'   -H 'Content-Type: application/json'   -d '{ "desc": "My Gateway", "enf_tok_sec" : true, "token_exp" : 55 }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig?org_id={org_id}&space_id={space_id}&acknowledgeOverage=true'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Configure the activities of the gateway(s)

Configure the activities of the existing gateway(s)

PUT /v1/setActivity

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

Request Body

Required*
object

The list of activities

  • curl -X PUT   -H 'Authorization: Bearer <UAA token>'   -H 'Content-Type: application/json'   -d '{ "setActive": [ "ZgNBtYKCG66_prod_ng" ], "setInactive": [ "qCTv6Onseiy_prod_ng" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/setActivity?org_id={org_id}&space_id={space_id}'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Retrieve a gateway

Retrieve the configuration of a gateway

GET /v1/sgconfig/{gatewayID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Delete a gateway

Delete a gateway

DELETE /v1/sgconfig/{gatewayID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}'

Response

Response Body

string

Status Code

  • 200

    Request was successful

Example responses
  • Success

Update the enabled/description properties of a gateway configuration

Update the enabled and description properties of the gateway configuration, or regenerate the security token

PUT /v1/sgconfig/{gatewayID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Request Body

UpdatedConfigRequest

New description for the gateway

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "desc": "My New Gateway", "enabled": true, "enf_tok_sec": true, "regen_token": true, "token_exp": 44 }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Regenerate the legacy cert/key pair associated with this gateway

Regenerate the legacy cert/key pair associated with this gateway which used by the old Secure Gateway client

PUT /v1/sgconfig/{gatewayID}/genAuth

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/genAuth'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Export the gateway

Export the gateway

GET /v1/sgconfig/{gatewayID}/export

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   -o gateway_id.gateway   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/export'

Response

Response Body

object

Status Code

  • 200

    The exported .gateway file

No Sample Response

This method does not specify any sample responses.

Configure the activities of the destination(s)

Configure the activities of the destination(s)

PUT /v1/sgconfig/{gatewayID}/setActivity

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Request Body

Required*
object

The list of activities

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "setActive": [ "<destination_id>}" ], "setInactive": [ "<destination_id>" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/setActivity'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Delete a list of destination(s)

Delete a list of destination(s) associated with given gateway ID

DELETE /v1/sgconfig/{gatewayID}/bulkDestinations

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Request Body

Required*
object

The list of deleted destination

  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "destinations": [ "<destination_id>", "<destination_id>" ] }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/bulkDestinations'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get a list of destination information

Get a list of destination(s) associated with given gateway ID

GET /v1/sgconfig/{gatewayID}/destinations

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Query Parameters

  • type
    string

    Whether to only include enabled or disabled destination(s). Should be a Boolean. If not specified all destination(s) will be returned.

    Allowable values: [enabled,disabled]

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations'

Response

Response Body

DestinationResponse[]

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Create a destination

Create a destination

POST /v1/sgconfig/{gatewayID}/destinations

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Request Body

Required*
object

A description of this destination

  • curl -X POST   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "desc": "My Destination", "ip": "example.com", "port": "443", "protocol": "HTTPS", "enable_client_tls": true, "client_tls": "mutualauth", "tls": "mutualauth" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Import destination

Import destination

PUT /v1/sgconfig/{gatewayID}/destinations/import

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Form Parameters

  • state
    Required*
    file

    The imported .destination file

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -F 'state=@{imported_file}'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/import'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Export the destination

Export the destination

GET /v1/sgconfig/{gatewayID}/destinations/{destinationID}/export

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   -o gateway_id.gateway   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/export'

Response

Response Body

NewDestinationRequest

Status Code

  • 200

    The exported .destination file

No Sample Response

This method does not specify any sample responses.

Get a destination's information

Get a destination's information

GET /v1/sgconfig/{gatewayID}/destinations/{destinationID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Update a destination

Update a destination

PUT /v1/sgconfig/{gatewayID}/destinations/{destinationID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Request Body

UpdatedDestinationRequest

A description of this destination

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -d '{ "desc": "My Destination" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Delete a destination

Delete a destination

DELETE /v1/sgconfig/{gatewayID}/destinations/{destinationID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}'

Response

Response Body

string

Status Code

  • 200

    Request was successful

Example responses
  • Success

Download certs for the destination

Download certs for the destination

GET /v1/sgconfig/{gatewayID}/destinations/{destinationID}/cert

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Query Parameters

  • noZip
    boolean

    Whether the result need to be packed as zip file. Default to false

  • curl -X GET   -H 'Authorization: Bearer <security token>'   -o cert.zip   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/cert'

Response

Response Body

object[]

Status Code

  • 200

    Cloud be a zip file or the content of the required cert, which depends on the option noZip

No Sample Response

This method does not specify any sample responses.

Upload a cert for the destination

Upload a cert for the destination

PUT /v1/sgconfig/{gatewayID}/destinations/{destinationID}/cert

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Form Parameters

  • cert
    Required*
    file

    The CA which Secure Gateway trust when receiving the connection from the caller application. Up to one cert cloud be uploaded

  • dest_cert
    Required*
    file

    The cert which Secure Gateway client provide to identify itself for connecting to the endpoint. If uploading dest_key as well, this field is required. Up to one cert cloud be uploaded

  • dest_key
    Required*
    file

    The key for the dest_cert. If uploading dest_cert as well, this field is required. Up to one key cloud be uploaded

  • client_cert
    Required*
    file

    The CA which Secure Gateway trust when sending the connection to endpoint. Up to six certs cloud be uploaded

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -F 'cert=@{server_cert}'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/cert'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Delete certs for the destination

Delete certs for the destination

DELETE /v1/sgconfig/{gatewayID}/destinations/{destinationID}/cert

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Request Body

Required*
object

A list of names of the deleted certs

  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "filename": [ "{cert_name}" ] }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/cert'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Regenerate cert and key for the destination

Regenerates cert and key for Mutual Auth protocol

PUT /v1/sgconfig/{gatewayID}/destinations/{destinationID}/genCerts

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Query Parameters

  • client
    boolean

    The type of the cert which will be regenerated

    • true - Regenerate the cert cert.dest_cert/key
    • omitted - Regenerate the cert cert.server_dest_cert/key
  • curl -X PUT   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/genCerts'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Add an IP Table rule to a private destination.

Destination must be private to add IP Table rules Adds an IP Table ACCEPT rule to a private destination. Users accessing the destination from an IP and port described by this rule will not be rejected. The rule can contain a hostname, IP, or IP range and a port or port range. Adding the IP rule with the same app id, the previous one will be replaced

PUT /v1/sgconfig/{gatewayID}/destinations/{destinationID}/ipTableRule

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Request Body

IPRulesOption[]

The added Ip rules

  • curl -X PUT   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "spt": "<source_port>", "src": "<source_ip>", "app": "<source_uid>" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/ipTableRule'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Remove an IP Table rule from a private destination.

Remove an IP Table ACCEPT rule from a private destination. Users accessing the destination from an IP and Port described by this rule will now be rejected. Use the describe destination call to view current IP Table Rules.

DELETE /v1/sgconfig/{gatewayID}/destinations/{destinationID}/ipTableRule

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Query Parameters

  • all
    boolean

    Whether remove all IP rule

    • true - Remove all IP rule
    • omitted - Regenerate the cert cert.server_dest_cert/key

Request Body

IPRulesOption[]

The deleted IP rules, if the query param is defined, this field will be ignore

  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   -H 'Content-Type: application/json'   -d '{ "spt": "<source_port>", "src": "<source_ip>" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/ipTableRule'

Response

Response Body

DestinationResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get the usage statistics for all existing gateway(s)

Get the usage statistics for all existing gateway(s)

GET /v1/stats

Request

Custom Headers

  • Authorization
    Required*
    string

    IBM Cloud UAA Token

Query Parameters

  • org_id
    Required*
    string

    IBM Cloud Org ID

  • space_id
    Required*
    string

    IBM Cloud Space ID

  • curl -X GET   -H 'Authorization: Bearer <UAA token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/stats?org_id={org_id}&space_id={space_id}'

Response

Response Body

object

The description of the gateway(s) usage in 12 hours

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get the usage statistics for the gateway

Get the usage statistics for the gateway

GET /v1/sgconfig/{gatewayID}/stats

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/stats'

Response

Response Body

object

The description of the gateway usage in 12 hours

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get list of the connected clients info

Get list of the connected clients info for a gateway

GET /v1/sgconfig/{gatewayID}/clients

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/clients'

Response

Response Body

ClientResponse

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Delete a single connected client

Delete a single connected client

DELETE /v1/sgconfig/{gatewayID}/clients

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Request Body

Required*
object
  • curl -X DELETE   -H 'Authorization: Bearer <security token>'   -d '{ "deleteList": [ "<client_id>" ] }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/clients'

Response

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get the client warning and error logs

Get the client warning and error logs, please note that some warnings and errors message might be missing, to get the entire client logs, please read the logs in client env

GET /v1/sgconfig/{gatewayID}/clientLogs

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Query Parameters

  • type
    string

    The type of the logs

    Allowable values: [warn,error]

  • clientID
    string

    The Client ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/clientLogs'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get the info of the disconnected client

Get the info of the clients that disconnected from the gateway recently.

GET /v1/sgconfig/{gatewayID}/disconnectedClients

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/disconnectedClients'

Response

Response Body

object[]

An array of objects containing up to the last 10 clients that disconnected from the gateway.

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get connection status of a client

Get connection status of a client for a gateway

GET /v1/sgconfig/{gatewayID}/clients/{clientID}

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • clientID
    Required*
    string

    The Client ID

  • curl -X GET   -H 'Authorization: Bearer <security token>'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/clients/{client_id}'

Response

Response Body

string

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Get the list of installers we currently offer

Get the list of installers we currently offer

GET /v1/getClientList

Request

No Request Parameters

This method does not accept any request parameters.

  • curl -X GET   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/getClientList'

Response

Status Code

  • 200

    The list of installers we currently offer

No Sample Response

This method does not specify any sample responses.

Migrate the gateway to Satellite Connector

Migrate all destinations of this gateway to Satellite Connector

PUT /v1/sgconfig/{gatewayID}/migrate2connector

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

Query Parameters

  • force
    boolean

    Whether to force to rename the destination if it cannot satisfy the Satellite Connector endpoint naming policy

Request Body

Required*
object

The info of the Satellite Connector

  • curl -X PUT   -H 'Authorization: Bearer <IAM token>'   -H 'Content-Type: application/json'   -d '{ "connector_id": "A2FbRFtwNfatanQRLjrujBKmVmfOk7NjXYZIWAoVLNfd1PTXJ93aH3J", "token" : "fake_iam_token" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/migrate2connector'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.

Migrate the destination to Satellite Connector

Migrate this destination to Satellite Connector

PUT /v1/sgconfig/{gatewayID}/destinations/{destinationID}/migrate2connector

Request

Custom Headers

  • Authorization
    Required*
    string

    Expected in form Bearer JWT, where JWT is the security token

Path Parameters

  • gatewayID
    Required*
    string

    The Gateway ID

  • destinationID
    Required*
    string

    The destination ID

Query Parameters

  • force
    boolean

    Whether to force to rename the destination if it cannot satisfy the Satellite Connector endpoint naming policy

Request Body

Required*
object

The info of the Satellite Connector

  • curl -X PUT   -H 'Authorization: Bearer <IAM token>'   -H 'Content-Type: application/json'   -d '{ "connector_id": "A2FbRFtwNfatanQRLjrujBKmVmfOk7NjXYZIWAoVLNfd1PTXJ93aH3J", "token" : "fake_iam_token" }'   'https://sgmanager.us-south.securegateway.cloud.ibm.com/v1/sgconfig/{gateway_id}/destinations/{destination_id}/migrate2connector'

Response

Response Body

object

Status Code

  • 200

    Request was successful

No Sample Response

This method does not specify any sample responses.