Sign in

v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
APIs

Debug an API on gateway instances

Debug an API on gateway instances

High risk operation: require explicit user confirmation before execution.

post/environments/{envId}/apis/{apiId}/debug

Request body

pathstring

The path of the request.

methodstring

The HTTP method of the request.

bodystring

The body of the request.

headersobject

The headers of the request.

Example request

{
  "path": "/my-api",
  "method": "GET",
  "body": "{\"key\":\"value\"}"
}

Response

API Debug request successfully sent

idstring

The ID of the event.

typestring

The type of the event.

createdAtstring date-time

The date (as timestamp) when the event was created.

payloadstring

The payload of the event.

propertiesobject

Properties of the event

Example response

{
  "id": "59327494-7258-4cd0-8715-144abe903531",
  "type": "DEBUG_API"
}