Generate a Gateway Installation Command

Generate a gateway installation command for an operating system. This API requires data source module permissions.

Endpoint: /openapi/v1/gateway/generateCommand

Method: GET

Request parameters

Parameter	Type	Required	Description
gatewayId	String	Yes	Gateway ID.
osType	String	Yes	Operating system of the gateway host: Windows, macOS, or Linux.
regionId	String	No	Preferred region. When omitted, NineData selects from the Stub endpoint list.

Response parameters

Parameter	Type	Description
data.endpoint	String	Connection endpoint.
data.stubEndpointListAddress	String	Stub endpoint list.
data.token	String	Gateway token.
data.proxy	String	Proxy gateway address.
data.command	String	Complete installation command.
data.windowsDownloadUrl	String	Download URL for the Windows gateway.

caution

data.token and data.command contain gateway registration information. Use them only in a controlled environment. Do not expose them or write them to logs.

Success response

{
  "success": true,
  "requestId": "<requestId>",
  "data": {
    "endpoint": "<endpoint>",
    "stubEndpointListAddress": "<stubEndpointListAddress>",
    "token": "<gatewayToken>",
    "proxy": "",
    "command": "<installationCommand>",
    "windowsDownloadUrl": "<windowsDownloadUrl>"
  }
}