Sign in
latestOpenAPI 3.0.22026-07-144652931.4 MB

b679a8f3f02c

Audit

List audit records

List audit trail records matching provided query params or default criteria.

The returned records are sorted by the execution_time from newest to oldest.

See Cursor-based pagination for instructions on how to paginate through the result set.

Only admins, account owners, or global API tokens on PagerDuty account pricing plans with the "Audit Trail" feature can access this endpoint.

For other role based access to audit records by resource ID, see the resource's API documentation.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

get/audit/records

Query parameters

limitinteger

The minimum of the limit parameter used in the request or the maximum request size of the API.

cursorstring

Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.

sincestring date-time

The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

untilstring date-time

The end of the date range over which you want to search. If not specified, defaults to now(). May not be more than 31 days after since.

root_resource_types[]'users' | 'teams' | 'schedules' | 'escalation_policies' | 'services' | 'ip_allow_lists'
Example:users

Resource type filter for the root_resource.

actor_type'user_reference' | 'api_key_reference' | 'app_reference'
Example:user_reference

Actor type filter.

actor_idstring
Example:P123456

Actor Id filter. Must be qualified by providing the actor_type param.

method_type'browser' | 'oauth' | 'api_token' | 'identity_provider' | 'other'

Describes the method used to perform the action:

browser -- authenticated user session. Session value is not returned in the truncated_token field.

oauth -- access token obtained via the OAuth flow. Truncated token value is returned in the truncated_token field.

api_token -- Pagerduty API token. Truncated token value is returned in the truncated_token field.

identity_provider -- action performed by an Identity provider on behalf of a user. No value is returned in the truncated_token field.

other -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the truncated_token field.

Method type filter.

method_truncated_tokenstring
Example:3xyz

Method truncated_token filter. Must be qualified by providing the method_type param.

actions[]'create' | 'update' | 'delete'

The action executed on the aggregate

Action filter

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

Records matching the query criteria.

recordsAuditRecord[] required— unresolved $ref
limitinteger required

The minimum of the limit parameter used in the request or the maximum request size of the API.

next_cursorstring nullable required

An opaque string than will deliver the next set of results when provided as the cursor parameter in a subsequent request. A null value for this field indicates that there are no additional results.