{
"opencollection": "1.0.0",
"info": {
"name": "Port Action Runs Audit API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "Audit",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get audit logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/audit-log",
"params": [
{
"name": "identifier",
"value": "",
"type": "query",
"description": "An identifier of the log event you want to fetch."
},
{
"name": "entity",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified entity."
},
{
"name": "include_deleted_entities",
"value": "",
"type": "query",
"description": "Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day."
},
{
"name": "blueprint",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified blueprint."
},
{
"name": "run_id",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified action run."
},
{
"name": "webhookId",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified webhook."
},
{
"name": "webhookEventId",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified webhook event."
},
{
"name": "origin",
"value": "",
"type": "query",
"description": "Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`."
},
{
"name": "InstallationId",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified integration."
},
{
"name": "resources",
"value": "",
"type": "query",
"description": "Fetch all audit logs related to the specified resource type/s.
**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]
The `integration` value is **experimental** and may change in future API versions."
},
{
"name": "includes",
"value": "",
"type": "query",
"description": "The fields you want to include in the response. If used, only the specified fields will be included in the response."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The starting timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "The ending timestamp of the audit logs you want to fetch, in the ISO format `2022-04-23T18:25:43.511Z`."
},
{
"name": "action",
"value": "",
"type": "query",
"description": "Fetch all audit logs with the specified action type - `CREATE`, `UPDATE`, or `DELETE`."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Fetch all audit logs with the specified status."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of logs to return. Optional; defaults to `10000`. The previous default was `100000`, which could cause `504 Gateway Timeout` on large accounts. Use a lower value or narrow `from` and `to` if you still hit timeouts."
},
{
"name": "actionType",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Fetch audit logs from your Port account (also viewable in [Port's UI](https://app.getport.io/settings/AuditLog)).
All query parameters are combined with logical `AND`.
**Non-admin users** have limited access. They can only:
- Pass an `identifier` to access a specific log.
- Pass an `entity` to retrieve logs of entities they have access to.
- Pass a `run_id` to retrieve logs of action runs they have access to.
Non-admin users **cannot** view logs of deleted "
}
]
}
],
"bundled": true
}