Sign in

v1

latestOpenAPI 3.0.12026-07-17387979.8 KB
Gateway Lifecycle

Gateway Register or Heartbeat

Accepts a payload indicating either a gateway registration or a heartbeat update. The payloadType field distinguishes the operation.

post/notify-gateway

Request body

payloadType'REGISTER' | 'HEARTBEAT' required

Indicates the type of payload.

  • "REGISTER": Gateway registration payload
  • "HEARTBEAT": Heartbeat update payload
loadingTenantsstring[]

List of tenant names

environmentLabelsstring[]

A list of environments this gateway supports.

gatewayIdstring

The unique identifier assigned to the newly registered gateway.

timeStampinteger

The timestamp when the heartbeat was generated.

Example request

{
  "payloadType": "REGISTER",
  "gatewayProperties": {
    "ipAddress": "192.168.1.100"
  },
  "loadingTenants": [
    "tenant1.com",
    "tenant2.org",
    "carbon.super"
  ],
  "environmentLabels": [
    "default",
    "production",
    "sandbox"
  ]
}

Response

Successful response for registration or heartbeat.

status'REGISTERED' | 'ACKNOWLEDGED' required

Response status

gatewayIdstring

Returned if registration was successful.

Example response

{
  "status": "REGISTERED",
  "gatewayId": "ID_1"
}