Skip to main content

Create a Gateway

Create a data source access gateway. This API requires data source module permissions.

Endpoint: /openapi/v1/gateway/create

Method: POST

Request parameters

ParameterTypeRequiredDescription
tunnelIdStringNoPrivate-network connection ID. When provided, NineData creates and binds a private gateway.

Request example

Standard gateway:

{}

Private gateway:

{"tunnelId": "<tunnelId>"}

Response parameters

ParameterTypeDescription
successBooleanWhether the request succeeded.
requestIdStringRequest ID.
data.gatewayIdStringID of the new gateway.

Success response

{"success": true, "requestId": "<requestId>", "data": {"gatewayId": "<gatewayId>"}}