This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Lists all LogFiles.
This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the nextPageToken field will be populated. To get the next page, make the same request again, but set the value of the pageToken query parameter to be value of the nextPageToken value of the previous response. If there is no nextPageToken field in the response, you are on the last page.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:audit-read.
stringstringList log files for audit events starting from this date. If absent, defaults to the current date.
stringList log files for audit events up until this date (inclusive). If absent, defaults to no end date. Use the returned nextPageToken to continually poll the listLogFiles endpoint to list the latest available logs.
integerThe page size to use for the endpoint.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
booleanEnables the use of preview functionality.
objectlist<LogFile>stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/audit/logFiles?organizationRid=ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa&startDate=2024-01-01&endDate=2025-01-01&preview=true"1
2
3
4
5
6
7
8
{
"data": [
{
"id": "S2VlcEV4cGxvcmluZw=="
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| Error Name | ||
|---|---|---|
List | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to list audit log files. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.