List audit log entries

GET

/api/audit

curl --request GET \
  --url 'https://gateway.example.com/api/audit?page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 20 >= 1 <= 100

action

Any of:

string

string

Array<string>

Array<string>

resourceType

Any of:

string

string

Array<string>

Array<string>

userId

Any of:

string

string

Array<string>

Array<string>

from

string format: date-time

to

string format: date-time

excludeAction

Any of:

string

string

Array<string>

Array<string>

excludeResourceType

Any of:

string

string

Array<string>

Array<string>

Responses

200

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
  }
}

400

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"
    }
  ]
}

401

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"
}

403

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"
}

404

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"
}

409

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"
}

422

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"
}

500

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"
}