Executions

List all Executions

Lists execution

get

Lists executions matching the optional filter

Query parameters

reqHdr.tidstringOptional

tid is the unique request id.

pageSizeinteger · int32Optional

page_size specifies the maximum number of results to be returned.

Example: {"value":25}

pageTokenstringOptional

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

filterstringOptional

filter expression.

orderBystringOptional

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

timeRangestringOptional

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

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

HTTPcURLJavaScriptPython

GET /v1alpha1/executions HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": [
    {
      "id": "text",
      "workflowName": "text",
      "createTime": "2025-05-09T12:48:50.832Z",
      "startTime": "2025-05-09T12:48:50.832Z",
      "endTime": "2025-05-09T12:48:50.832Z",
      "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
  }
}

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

get

Gets execution details

Path parameters

executionIdstringRequired

execution_id is the id of execution.

Query parameters

reqHdr.tidstringOptional

tid is the unique request id.

summarybooleanOptional

summary gives the execution details without the output field.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

HTTPcURLJavaScriptPython

GET /v1alpha1/executions/{executionId} HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "execution": {
    "id": "text",
    "workflowName": "text",
    "createTime": "2025-05-09T12:48:50.832Z",
    "startTime": "2025-05-09T12:48:50.832Z",
    "endTime": "2025-05-09T12:48:50.832Z",
    "duration": "text",
    "version": "text",
    "executionStatus": "EXECUTION_STATUS_UNSPECIFIED",
    "inputs": "text",
    "output": "text",
    "executor": "text",
    "approver": "text",
    "reason": "text",
    "executionType": "EXECUTION_TYPE_UNSPECIFIED"
  }
}

Curl Example:

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