Audit
Community
Enterprise

List audit logs

Changed on

Returns a list of audit logs.

get/api/v2/audit

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/audit
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are id, actor_id, actor_name, actor_email, action, request_id, created_at, source, and status.

beforestring date-time

Return logs created before the specified time. Value should be in the RFC-3339 format. If not supplied, this will default to the current time.

afterstring date-time

Return logs created after the specified time. Value should be in the RFC-3339 format. If not supplied, this will default to 1 year before the current time. Must not be later than before.

idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

actor_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

actor_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

actor_emailstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

actionstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

request_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

sourcestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

statusstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter results by column value. Valid filter predicates are eq, neq. Valid values are success and failure.

Response

OK

Changes

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter action

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter actor_email

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter actor_id

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter actor_name

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter id

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter request_id

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter source

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter status

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

  • 6aaeba6ecdc5Revision changes
    • breaking

      for the query request parameter created_at, the format changed from no format to date-time

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter created_at

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter action

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter actor_email

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter actor_id

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter actor_name

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter id

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter request_id

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter source

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter status