Get all action runs

GET 
https://api.port.io/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 | nullnullable
iconstring | nullnullable
deletedboolean
entity object
identifierstringrequired
titlestring | nullnullable
iconstring | nullnullable
deletedboolean
action objectrequired
identifierstringrequired
titlestring | nullnullable
iconstring | nullnullable
deletedboolean
propertiesobjectrequired
endedAtdate-time
sourcestring | objectrequired
requiredApproval booleanobjectrequired
typestringrequired
Possible values: [ALL, ANY]
statusstringrequired
statusLabelstring | nullnullable
linkstring[]
summarystring
approval objectnull
descriptionstring
userIdstring | nullnullable
statestring
payload objectnull
typestring
urluri
agentboolean
synchronizedboolean
methodstring
headers object
RUN_IDstring
body object
port_context object
runIdstring
responseundefined[]
createdBystring
updatedBystring
createdAtdate-time
updatedAtdate-time
]

Example (auto)

{
  "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

Authorization: Authorization

name: Authorizationtype: apiKeyscopes: read:runsin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.port.io/v1/actions/runs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.port.io

Auth

bearer

Parameters

entity — query

blueprint — query

active — query

---truefalse

user_email — query

limit — query

external_run_id — query

ResponseClear

Click the Send API Request button above and see the response here!