Audit

Get audit logs

Fetch audit logs from your Port account (also viewable in Port's UI).<br/><br/>All query parameters are combined with logical AND.<br/><br/>Non-admin users have limited access. They can only:<br/>- Pass an identifier to access a specific log.<br/>- Pass an entity to retrieve logs of entities they have access to.<br/>- Pass a run_id to retrieve logs of action runs they have access to.<br/><br/>Non-admin users cannot view logs of deleted entities.<br/><br/>Performance: The optional limit parameter defaults to 10000. Omitting limit previously used a default of 100000, which often caused 504 Gateway Timeout on large accounts. For very broad queries you may still need a lower limit or narrower from/to time windows.

get/v1/audit-log

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/audit-log
  • Auth: API key in header Authorization

Query parameters

identifierstring

An identifier of the log event you want to fetch.

entitystring

Fetch all audit logs related to the specified entity.

include_deleted_entitiesboolean

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.

blueprintstring

Fetch all audit logs related to the specified blueprint.

run_idstring

Fetch all audit logs related to the specified action run.

webhookIdstring

Fetch all audit logs related to the specified webhook.

webhookEventIdstring

Fetch all audit logs related to the specified webhook event.

originstring[]

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.

InstallationIdstring

Fetch all audit logs related to the specified integration.

string[]
OR
'entity' | 'blueprint_permission' | 'blueprint' | 'run' | 'webhook' | 'action' | 'action_permission' | 'scorecard' | 'integration' | 'secret'

Fetch all audit logs related to the specified resource type/s.<br/>Possible values: [blueprint, entity, run, webhook, scorecard, action, integration]<br/>The integration value is experimental and may change in future API versions.

includesstring[]

The fields you want to include in the response. If used, only the specified fields will be included in the response.

fromstring date-time

The starting timestamp of the audit logs you want to fetch, in the ISO format 2022-04-23T18:25:43.511Z.

tostring date-time

The ending timestamp of the audit logs you want to fetch, in the ISO format 2022-04-23T18:25:43.511Z.

actionstring

Fetch all audit logs with the specified action type - CREATE, UPDATE, or DELETE.

status'SUCCESS' | 'FAILURE'

Fetch all audit logs with the specified status.

limitnumber

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.

actionType'automation' | 'self-service'

Changes

No recorded changes to this operation across all 1 revision of this API.