orchestrator
2024.10
false
Orchestrator API guide
- Getting started
- Authentication
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Get Audit Logs
- Download Audit Logs
API reference for downloading organization audit logs in CSV format via the Platform Management API.
Downloads the audit logs for an organization, based on the organization ID, to your machine, in a .CSV format.
API Endpoint
GET https://{yourDomain}/audit_/api/auditlogs/download
Scopes
Requires the following scopes:
- PM.Audit
- PM.Audit.Read
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Note:
To obtain the {access_token}, make sure to authenticate through one of the methods described here.
Query Parameters
| Query param | Data type | Description |
|---|---|---|
language (optional) | string | Specify the available display language, in the shorten form. For example, en, fr, de, ja etc. |
size (optional) | int32 | Specify the download size. |
Responses
200 OK
The list of audit events is downloaded to your machine, in the .csv format.
Example Request
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}is:https://{yourDomain}/{organizationName} - Your
{access_token}is:1234(for length considerations). - You set the following query params:
language=ensize= 13, to download top 13 entries.
The call should look like below (cURL):
curl --location --request GET ' https://{yourDomain}/{organizationName}/audit_/api/auditlogs/download/?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request GET ' https://{yourDomain}/{organizationName}/audit_/api/auditlogs/download/?language=en&size=13' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'