Skip to content
Hayonix

API reference · Audit logs

Get an audit log entry

GET/v1/orgs/{org_id}/audit-logs/{audit_log_id}
Console sessionaudit_log:readOrganization

Returns one entry with the request that made the change. Changes made by platform operators show the actor as "Platform operator", without their identity, address or reason.

Console session only: no API key can be granted the audit_log:read permission it needs. Requires the audit_log:read permission (a key's scope, or a role that includes it).

Request

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

  • audit_log_idstringrequired

    ID of the audit log

    ID with prefix aud_

Response

200 AuditLogEntry — The entry

  • objectstringrequired

    Always `audit_log_entry`: the type of this object

    One ofaudit_log_entry

  • idstringrequired

    Unique ID (`aud_…`)

    ID with prefix aud_

  • org_idstring | nullrequired

    Organization it belongs to

  • project_idstring | nullrequired

    Project it belongs to

  • actorobjectrequired

    Who made the change

    Show 4 fields of actor
    • typestringrequired

      Finer kind of actor than `kind`: `user` or `playground` (a member, directly or through the console playground), `api_key`, `operator` (a platform operator) or the type of a platform component

    • idstringrequired

      The member’s user ID, the API key ID or the component; `platform` for every platform operator

    • kindstringrequired

      `member` (a person in the org), `api_key`, `platform` (a platform operator, never named) or `system` (the platform itself: billing enforcement, sign-in checks, the payment processor)

      One ofmemberapi_keyplatformsystem

    • namestring | nullrequired

      Who it was when the entry was written: a member’s name or an API key’s name. Kept after the member leaves or the key is revoked or renamed.

  • actionstringrequired

    What was done, as `resource:verb`

  • targetobjectrequired

    The resource the change was made to

    Show 2 fields of target
    • typestring | nullrequired

      Kind of resource the change was made to (null when there is none)

    • idstring | nullrequired

      Unique ID

  • metadataobject | nullrequired

    Your own key/value labels, returned as given

  • requestobjectrequired

    The API request that made the change (all null when none)

    Show 4 fields of request
    • idstring | nullrequired

      Unique ID

    • methodstring | nullrequired

      HTTP method

    • routestring | nullrequired

      Route that handled it, with path parameters as placeholders

    • statusinteger | nullrequired

      HTTP status code of the response

  • ipstring | nullrequired

    IP address the change came from (null when unknown or made by the platform)

  • user_agentstring | nullrequired

    User-Agent header of the request (null when none)

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example response
Example response
{
  "object": "audit_log_entry",
  "id": "aud_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "string",
  "project_id": "string",
  "actor": {
    "type": "string",
    "id": "string",
    "kind": "member",
    "name": "Ada Lovelace"
  },
  "action": "api_key:create",
  "target": {
    "type": "api_key",
    "id": "string"
  },
  "metadata": {},
  "request": {
    "id": "string",
    "method": "POST",
    "route": "string",
    "status": 1
  },
  "ip": "string",
  "user_agent": "string",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.