Search the audit log

GET

/audit-events

curl --request GET \
  --url 'https://example.com/api/v1/audit-events?outcome=SUCCESS' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Authorizations

• sessionCookie
• bearerToken

Parameters

Query Parameters

actorUserId

string format: uuid

targetKind

string

<= 64 characters

targetId

string

<= 128 characters

action

string

<= 64 characters /^[a-z_]+(\.[a-z_]+)*$/

An area (server, every server.… action) or one action (server.delete).

outcome

string

Allowed values: SUCCESS DENIED FAILURE

since

string format: date-time

until

string format: date-time

Only events before this time.

limit

integer

>= 1 <= 200

At most this many items (default 50).

cursor

string

<= 200 characters

The nextCursor of the previous page.

Responses

200

Audit events, newest first.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

integer format: int64

occurredAt

required

string format: date-time

actorKind

required

string

Allowed values: USER API_TOKEN SYSTEM

actorUserId

string format: uuid

action

required

string

targetKind

required

string

targetId

required

string

outcome

required

string

Allowed values: SUCCESS DENIED FAILURE

details

required

object

key

additional properties

any

nextCursor

string

Example

{
  "items": [
    {
      "actorKind": "USER",
      "action": "user.update",
      "outcome": "SUCCESS"
    }
  ]
}

400

The request is invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

403

Signed in, but not allowed.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}