---
title: "Acknowledge an API Revision Deployment"
method: POST
path: "/notify-api-deployment-status"
tags: ["Gateway Monitoring"]
---

# Acknowledge an API Revision Deployment

`POST /notify-api-deployment-status`

This endpoint is invoked by the Gateway to notify the Control Plane about the status of an API revision deployment or undeployment.

## Request body

- GatewayDeploymentStatusAcknowledgmentList
  - `count` integer — Number of APIs returned.
  - `list` GatewayDeploymentStatusAcknowledgment[]
    - `gatewayId` string, required — The unique identifier assigned to the newly registered gateway.
    - `apiId` string, required — Unique identifier of the deployed API.
    - `tenantDomain` string, required
    - `deploymentStatus` 'SUCCESS' | 'FAILURE', required — The final status of the deployment action.
    - `timeStamp` integer, required — The timestamp when the heartbeat was generated.
    - `action` 'DEPLOY' | 'UNDEPLOY' — The action performed by the gateway.
    - `revisionId` string — Unique identifier of the API revision that was deployed or undeployed.
    - `errorCode` integer — A unique code identifying the error, present only if deploymentStatus is 'FAILURE'.
    - `errorMessage` string — A descriptive error message, present only if deploymentStatus is 'FAILURE'.

## Response `200`

Deployment acknowledgement received successfully.

- DeploymentAcknowledgmentResponse
  - `status` 'RECEIVED' | 'DROPPED', required — Response status

## Other responses

- `400` — Malformed deployment acknowledgment payload.
- `500` — Internal server error while processing deployment 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-api-deployment-status/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)