Executions

List all Executions

Lists execution

Lists executions matching the optional filter

get

/v1alpha1/executions

Query parameters

reqHdr.tidany

tid is the unique request id.

pageSizeany

page_size specifies the maximum number of results to be returned.

Example: {"value":25}

pageTokenany

page_token is used to request a specific page of the list results.

filterany

filter expression.

orderByany

order_by is used to sort the fields by ascending or descending.

timeRangeany

Time Range is used to filter the data by last month, last year and by default is all.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1alpha1/executions'

200

default

200

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": [
    {
      "id": "text",
      "workflowName": "text",
      "createTime": "2025-03-08T22:50:40.206Z",
      "startTime": "2025-03-08T22:50:40.206Z",
      "endTime": "2025-03-08T22:50:40.206Z",
      "duration": "text",
      "version": "text",
      "executionStatus": "EXECUTION_STATUS_UNSPECIFIED",
      "inputs": "text",
      "output": "text",
      "executor": "text",
      "approver": "text",
      "reason": "text",
      "executionType": "EXECUTION_TYPE_UNSPECIFIED"
    }
  ],
  "statusTable": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "nextPageToken": "text",
  "pageCount": 1,
  "aggregateTotalTable": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

A successful response.

Curl Example:

curl 'https://<domain>/v1alpha1/executions?pageSize=10' -H "X-unSkript-API-Key:<api token>"

Get Details of a Specific Execution

Get execution details

Gets execution details

get

/v1alpha1/executions/{executionId}

Path parameters

executionIdanyrequired

execution_id is the id of execution.

Query parameters

reqHdr.tidany

tid is the unique request id.

summaryany

summary gives the execution details without the output field.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1alpha1/executions/{executionId}'

200

default

200

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": {
    "id": "text",
    "workflowName": "text",
    "createTime": "2025-03-08T22:50:40.206Z",
    "startTime": "2025-03-08T22:50:40.206Z",
    "endTime": "2025-03-08T22:50:40.206Z",
    "duration": "text",
    "version": "text",
    "executionStatus": "EXECUTION_STATUS_UNSPECIFIED",
    "inputs": "text",
    "output": "text",
    "executor": "text",
    "approver": "text",
    "reason": "text",
    "executionType": "EXECUTION_TYPE_UNSPECIFIED"
  }
}

A successful response.

Curl Example:

curl  'https://<domain>/v1alpha1/executions/10007011-12a6-41c1-98ea-1b3ced62604e' \
      -H "X-unSkript-API-Key:<api token>"