Skip to main content

Get audit logs

GET 
/v1/audit-log

This route allows you to fetch audit logs from your Port account. Your audit logs can also be viewed via Port's UI.

This route will perform a logical AND between all query parameters below, and return all logs that match the criteria.

Request​

Query Parameters

    identifier string

    An identifier of the log event you want to fetch.

    entity string

    Fetch all audit logs related to the specified entity.

    blueprint string

    Fetch all audit logs related to the specified blueprint.

    run_id string

    Fetch all audit logs related to the specified action run.

    webhookId string

    Fetch all audit logs related to the specified webhook.

    webhookEventId string

    Fetch all audit logs related to the specified webhook event.

    origin string[]

    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.

    InstallationId string

    Fetch all audit logs related to the specified integration.

    resources string[]

    Possible values: [blueprint, entity, run, webhook, scorecard, action]

    Fetch all audit logs related to the specified resource type/s.

    includes undefined[]

    Possible values: [action, context, diff, identifier, resourceType, status, trigger, additionalData, message]

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

    from date-time

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

    to date-time

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

    action string

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

    status string

    Possible values: [SUCCESS, FAILURE]

    Fetch all audit logs with the specified status.

    limit number

    The maximum number of logs to fetch.

Responses​

Default Response

Loading...
Last updated on