Skip to main content

audit_records

Creates, updates, deletes, gets or lists an audit_records resource.

Overview

Nameaudit_records
TypeResource
Idpagerduty.escalation_policies.audit_records

Fields

The following fields are returned by SELECT queries:

Records matching the query criteria.

NameDatatypeDescription
idstring
actionstring (example: create)
actorsarray
detailsobjectAdditional details to provide further information about the action or the resource that has been audited.
execution_contextobjectAction execution context
execution_timestring (date-time)The date/time the action executed, in ISO8601 format and millisecond precision.
methodobjectThe method information
root_resourceobject
selfstringRecord URL.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_escalation_policy_audit_recordsselectidAccept, Content-Type, limit, cursor, since, untilThe 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.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read
_list_escalation_policy_audit_recordsexecidAccept, Content-Type, limit, cursor, since, untilThe 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.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
idstringThe ID of the resource.
AcceptstringThe Accept header is used as a versioning header.
Content-Typestring
cursorstringOptional 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.
limitintegerThe minimum of the limit parameter used in the request or the maximum request size of the API.
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.

SELECT examples

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.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

SELECT
id,
action,
actors,
details,
execution_context,
execution_time,
method,
root_resource,
self
FROM pagerduty.escalation_policies.audit_records
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
;

Lifecycle Methods

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.

For more information see the Audit API Document.

Scoped OAuth requires: audit_records.read

EXEC pagerduty.escalation_policies.audit_records._list_escalation_policy_audit_records 
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}',
@limit='{{ limit }}',
@cursor='{{ cursor }}',
@since='{{ since }}',
@until='{{ until }}'
;