v1

latestOpenAPI 3.0.12026-07-17387979.8 KB

Gateway Monitoring

Notify API deployment (API Platform gateway format)

Invoked by the API Platform gateway when an API is successfully deployed. Uses the same path and JSON body as the platform control plane so the gateway can call this endpoint when connected to on-prem (BaseURL/apis/{apiId}/gateway-deployments). Authenticated via api-key header (platform gateway registration token).

post/apis/{apiId}/gateway-deployments

Path parameters

apiIdstring required

API UUID (must match the deployed API).

Query parameters

deploymentIdstring

Deployment/revision identifier.

Headers

api-keystring required

Platform gateway registration token.

Request body

idstring

API ID (deployed API).

statusstring

Deployment status (e.g. DEPLOYED).

configurationobject

API configuration snapshot.

createdAtstring date-time

updatedAtstring date-time

deployedAtstring date-time

deployedVersioninteger

projectIdentifierstring

Response

Deployment notification received.

status'RECEIVED' | 'DROPPED' required

Response status

Example response

{
  "status": "RECEIVED"
}