v2

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

Get API Audit

Get API Audit

Get API Audit.

get/environments/{envId}/apis/{apiId}/audits

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

frominteger

The timestamp from which the logs will be returned.

tointeger

The timestamp to which the logs will be returned.

eventsstring[]

List of Audit event name to filter on.

Response

Page of Audit

Example response

{
  "data": [
    {
      "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "createdAt": "2023-05-18 12:40:46.184000+00:00",
      "organizationId": "1719d8d1-8d01-48f6-99d8-d18d0178f6d4",
      "environmentId": "1719d8d1-8d01-48f6-99d8-d18d0178f6d4",
      "reference": {
        "id": "1719d8d1-8d01-48f6-99d8-d18d0178f6d4",
        "type": "API",
        "name": "My API"
      },
      "user": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "displayName": "John Doe"
      },
      "event": "API_CREATED",
      "properties": [
        {
          "key": "API",
          "value": "1719d8d1-8d01-48f6-99d8-d18d0178f6d4",
          "name": "My API"
        }
      ],
      "patch": "[{ \"op\": \"add\", \"path\": \"/hello\", \"value\": [\"world\"] }]"
    }
  ]
}