Get all action runs

GET 
/v1/actions/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.

To learn more about action runs, check out the documentation.

Request

Query Parameters

entity string

The identifier of the entity associated with the action run.


blueprint string

The identifier of the blueprint associated with the action run.


active boolean

If true, only running action runs will be fetched.


user_email string

The email of the user who initiated the action run.


limit number

Possible values: >= 1 and <= 50

The maximum number of action runs to fetch.


external_run_id string

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.

Responses

200

Retrieved successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

runs

object[]

Array [

idstringrequired

blueprint

object

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

entity

object

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

action

object

required

identifierstringrequired

titlestring | null

iconstring | null

deletedboolean

propertiesobjectrequired

endedAtdate-time

sourcestring | objectrequired

requiredApproval

boolean,object

required

typestringrequired

Possible values: [ALL, ANY]

statusstringrequired

statusLabelstring | null

linkstring[]

summarystring

approval

object,null

descriptionstring

userIdstring | null

statestring

payload

object,null

typestring

urluri

agentboolean

synchronizedboolean

methodstring

headers

object

RUN_IDstring

body

object

port_context

object

runIdstring

responseundefined[]

createdBystring

updatedBystring

createdAtdate-time

updatedAtdate-time

]

Example (from schema)

{
  "ok": true,
  "runs": [
    {
      "id": "string",
      "blueprint": {
        "identifier": "string",
        "deleted": true
      },
      "entity": {
        "identifier": "string",
        "deleted": true
      },
      "action": {
        "identifier": "string",
        "deleted": true
      },
      "properties": {},
      "endedAt": "2024-07-29T15:51:28.071Z",
      "status": "string",
      "summary": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }
  ]
}

422

One of the following errors occurred:

Error	Description
invalid_request	The data provided does not match the route schema

500

One of the following errors occurred:

Error	Description
internal_error	An internal error occurred