Introduction

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.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

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

Query Parameters

  • Path to file location

Response

Status Code

  • successful operation

No Sample Response

This method does not specify any sample responses.

This operation lists all existing Secure Gateway Configurations

Retrieves existing IBM Cloud Secure Gateway Configurations

GET /v1/sgconfig
Request

Query Parameters

  • IBM Cloud org id

  • IBM Cloud space id

  • Enabled/Disabled

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Creates a new IBM Cloud Secure Gateway Configuration

Creates a new IBM Cloud Secure Gateway Configuration.

POST /v1/sgconfig
Request

Query Parameters

  • IBM Cloud org id

  • IBM Cloud space id

A description of this gateway

Response

Status Code

  • OK

  • Missing Required Parameter

  • Internal Server error

No Sample Response

This method does not specify any sample responses.

Deletes a Secure Gateway Configuration

Deletes a Secure Gateway Configuration

DELETE /v1/sgconfig/{gatewayID}
Request

Custom Headers

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

Path Parameters

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Retrieves a Secure Gateway Configuration

Retrieves a Secure Gateway Configuration

GET /v1/sgconfig/{gatewayID}
Request

Custom Headers

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

Path Parameters

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Updates the enabled and description properties of the gateway configuration

Updates the enabled/description properties of a gateway configuration

PUT /v1/sgconfig/{gatewayID}
Request

Custom Headers

  • Expected in form Bearer JWT

Path Parameters

  • The Gateway ID

New description for the gateway

Response

Status Code

No Sample Response

This method does not specify any sample responses.

gets a list of destinations associated with given gateway ID

gets a list of destination information

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

Custom Headers

  • Expected in form Bearer JWT, where JWT is the security token of the gateway

Path Parameters

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Create a destination

Creates a destination
Protocol options are accepted as an array of strings matching the option name. See openssl's SSL_CTX_set_options for options.

POST /v1/sgconfig/{gatewayID}/destinations
Request

Custom Headers

  • Expected in form Bearer JWT, where the JWT is the security token of the Gateway

Path Parameters

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Deletes a destination

Deletes a destination

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

gets a destination's information

gets a destination's information

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Updates a destination

Updates a destination
Protocol options are accepted as an array of strings matching the option name. See openssl's SSL_CTX_set_options for options.

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Downloads certs for the destination under the given gateway configuration

Downloads certs for the destination under the given gateway configuration

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Uploads a cert for the destination under the given gateway configuration

Uploads a cert for the destination under the given gateway configuration.
NOTE: Accepts a server cert the cert in the form field 'cert' and a client cert under the form field 'client_cert'.

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Generates a cert and key for the destination

Generates a cert and key for the destination under the given gateway configuration. They can be downloaded with the get certs call.

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Removes an IP Table rule from a private destination.

Removes 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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

  • successful operation

No Sample Response

This method does not specify any sample responses.

Adds an IP Table rule to a private destination.

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. Use the describe destination call to view current IP Table Rules.

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

Path Parameters

  • The id of the destination

  • The Gateway ID

Response

Status Code

  • successful operation

No Sample Response

This method does not specify any sample responses.

Regenerate the cert/key pair associated with this gateway

Regenerate the cert/key pair associated with this gateway

PUT /v1/sgconfig/{gatewayID}/genAuth
Request

Path Parameters

  • Unique ID of the gateway to regenerate cert/key for

Response

Status Code

  • successful operation

No Sample Response

This method does not specify any sample responses.

Gets the usage statistics for the gateway configuration

Gets the usage statistics for the gateway configuration

GET /v1/sgconfig/{gatewayID}/stats
Request

Custom Headers

  • Expected in form Bearer JWT

Path Parameters

  • The Gateway ID

Response

Status Code

No Sample Response

This method does not specify any sample responses.