Sign in

v2

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

Get single API Event by it's ID

Get single API Event by it's ID

Get specific single API Event.

get/environments/{envId}/apis/{apiId}/events/{eventId}

Response

Single Event

idstring

The internal UUID of the event.

createdAtstring date-time

The date when the event has been created.

environmentIdsstring[]

The id of the environments.

type'ALERT_NOTIFICATION' | 'DEBUG_API' | 'DEPLOY_API_PRODUCT' | 'DEPLOY_CLUSTER' | 'DEPLOY_SHARED_POLICY_GROUP' | 'GATEWAY_STARTED' | 'GATEWAY_STOPPED' | 'PUBLISH_API' | 'PUBLISH_API_RESULT' | 'PUBLISH_DICTIONARY' | 'PUBLISH_ORGANIZATION' | 'PUBLISH_ORGANIZATION_LICENSE' | 'START_API' | 'START_DICTIONARY' | 'STOP_API' | 'STOP_DICTIONARY' | 'UNDEPLOY_API_PRODUCT' | 'UNDEPLOY_CLUSTER' | 'UNDEPLOY_SHARED_POLICY_GROUP' | 'UNPUBLISH_API' | 'UNPUBLISH_API_RESULT' | 'UNPUBLISH_DICTIONARY' | 'PUBLISH_AUTHZ_POLICY' | 'UNPUBLISH_AUTHZ_POLICY' | 'PUBLISH_AUTHZ_ENTITY' | 'UNPUBLISH_AUTHZ_ENTITY' | 'PUBLISH_AUTHZ_PDP' | 'UNPUBLISH_AUTHZ_PDP'

The type of the event.

payloadstring

The event payload.

propertiesobject

Properties of the event.

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "createdAt": "2023-05-18 12:40:46.184000+00:00",
  "environmentIds": [
    "1719d8d1-8d01-48f6-99d8-d18d0178f6d4"
  ],
  "initiator": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "displayName": "John Doe"
  },
  "type": "START_API",
  "payload": "{\"id\":\"023d7a64-b5de-4e1a-bd7a-64b5dede1adb\"}"
}