GET /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
Servers
- https://api.pagerduty.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Accept |
String | Yes |
The Default value: "application/vnd.pagerduty+json;version=2" |
Content-Type |
String | Yes |
Possible values:
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
method_type |
String | No |
Method type filter. Possible values:
|
actions |
String | No |
Action filter Possible values:
|
limit |
Integer | No |
The minimum of the |
actor_id |
String | No |
Actor Id filter. Must be qualified by providing the |
method_truncated_token |
String | No |
Method truncated_token filter. Must be qualified by providing the |
until |
String | No |
The end of the date range over which you want to search. If not specified, defaults to |
actor_type |
String | No |
Actor type filter. Possible values:
|
since |
String | No |
The start of the date range over which you want to search. If not specified, defaults to |
cursor |
String | No |
Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the |
root_resource_types |
String | No |
Resource type filter for the root_resource. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.