Action Runs

Get all action runs

This route allows you to fetch all action runs in your Port account. The route will perform a logical AND between all query parameters below, and return all action runs that match the criteria.<br/><br/>Pagination: Results are sorted by creation time (newest first). Use the next token from the response to fetch subsequent pages. When next is absent, there are no more results. Note that RBAC filtering may cause a page to contain fewer items than limit, or even return an empty runs array while next is still present — always use the absence of next as the signal that there are no more results.<br/><br/>To learn more about action runs, check out the documentation.

get/v1/actions/runs

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/actions/runs
  • Auth: API key in header Authorization

Query parameters

entitystring

The identifier of the entity associated with the action run.

blueprintstring

The identifier of the blueprint associated with the action run.

activeboolean

If true, only running action runs will be fetched.

user_emailstring

The email of the user who initiated the action run.

user_idstring

The id of the user who initiated the action run.

limitnumber

The maximum number of action runs to fetch.

excludestring[]

The fields to exclude from the response

external_run_idstring

The run id of your backend, for example the id that GitHub gives the workflow. This can be used to identify the action run instead of the run_id.

version'v1' | 'v2'

Specifies the API version to use. Please use v2 for the latest version of the API.

actionstring
sourcestring[]
nextstring

An opaque cursor for pagination. Pass the next value from the previous response to fetch the next page of results.

Response

Retrieved successfully.

okunknown required
nextstring

An opaque cursor for fetching the next page. Absent when there are no more results.

Changes

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