---
title: "Gateway Register or Heartbeat"
method: POST
path: "/notify-gateway"
tags: ["Gateway Lifecycle"]
---

# Gateway Register or Heartbeat

`POST /notify-gateway`

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

## Request body

- NotifyGatewayPayload
  - `payloadType` 'REGISTER' | 'HEARTBEAT', required — Indicates the type of payload. - "REGISTER": Gateway registration payload - "HEARTBEAT": Heartbeat update payload
  - `gatewayProperties` GatewayProperties — Technical properties of the gateway instance.
    - `ipAddress` string, ipv4 — The IP address of the gateway instance.
  - `loadingTenants` string[] — List of tenant names
  - `environmentLabels` string[] — A list of environments this gateway supports.
  - `gatewayId` string — The unique identifier assigned to the newly registered gateway.
  - `timeStamp` integer — The timestamp when the heartbeat was generated.

## Response `200`

Successful response for registration or heartbeat.

- NotifyGatewayStatusResponse
  - `status` 'REGISTERED' | 'ACKNOWLEDGED', required — Response status
  - `gatewayId` string — Returned if registration was successful.

## Other responses

- `400` — Invalid payload
- `500` — Internal server error while processing gateway status.
- `default` — Unexpected error

## Changes

- **2025-08-07** `b160d812e2c6` — 1 info
  - endpoint added
- **2024-01-29** `f2e9e07fd354` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/wso2/apis/internal-utility-api/changes/notify-gateway/post.md)

---

[API](https://skmtc.dev/wso2/apis/internal-utility-api.md) · [All operations](https://skmtc.dev/wso2/apis/internal-utility-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wso2/internal-utility-api/revisions/0be9aa8493bc/schema)