Skip to content

Prepare a filtered audit log export

POST
/api/audit/export
curl --request POST \
--url https://gateway.example.com/api/audit/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "actions": [ "example" ], "resourceTypes": [ "example" ], "userIds": [ "example" ], "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z", "excludedActions": [ "example" ], "excludedResourceTypes": [ "example" ] }'

JSON request body

Media typeapplication/json
object
actions
Array<string>
<= 100 items
resourceTypes
Array<string>
<= 100 items
userIds
Array<string>
<= 100 items
from
string format: date-time
to
string format: date-time
excludedActions
Array<string>
<= 100 items
excludedResourceTypes
Array<string>
<= 100 items
Examplegenerated
{
"actions": [
"example"
],
"resourceTypes": [
"example"
],
"userIds": [
"example"
],
"from": "2026-04-15T12:00:00Z",
"to": "2026-04-15T12:00:00Z",
"excludedActions": [
"example"
],
"excludedResourceTypes": [
"example"
]
}

Successful response

Media typeapplication/json
object
data
required

Resource object. Exact fields depend on the endpoint.

object
id
string
name
string
key
additional properties
Example
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"action": "proxy.create",
"resourceType": "proxy_host",
"createdAt": "2024-01-01T12:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"path": [
"name"
],
"message": "Required"
}
]
}

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNAUTHORIZED",
"message": "Authentication required"
}

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "FORBIDDEN",
"message": "Insufficient permissions"
}

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "NOT_FOUND",
"message": "Resource not found"
}

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "CONFLICT",
"message": "Resource already exists"
}

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNPROCESSABLE_ENTITY",
"message": "Request could not be processed"
}

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}