RunBooks

List RunBooks

List workflows

List workflows matching the optional filter

get

/v1alpha1/workflows

Query parameters

reqHdr.tidany

tid is the unique request id.

filterany

filter expression.

pageSizeany

page_size specifies the maximum number of results to be returned.

pageTokenany

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

isUnskriptany

is_unskript describes whether to list unSkript or or custom workflows.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflows": [
    {
      "name": "text",
      "id": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "currentVersion": "text",
      "createTime": "2025-03-08T16:07:40.408Z",
      "lastRun": "2025-03-08T16:07:40.408Z",
      "lastUpdated": "2025-03-08T16:07:40.408Z",
      "proxyId": "text",
      "inputSchema": "text",
      "requiresApproval": true,
      "runningDisabled": true,
      "parentId": "text",
      "isFolder": true,
      "path": "text",
      "enableEnvironment": true,
      "executionDisabled": true,
      "connectorTypes": [
        "text"
      ],
      "categories": [
        "text"
      ],
      "icon": "text",
      "environmentStatus": [
        {
          "environmentName": "text",
          "status": "text",
          "reason": [
            "text"
          ]
        }
      ],
      "runningDisabledByFloatingEnv": true
    }
  ],
  "nextPageToken": "text",
  "pageCount": 1,
  "totalCount": 1,
  "categoryCounts": [
    {
      "name": "text",
      "count": "text"
    }
  ]
}

A successful response.

Curl Example (to get personal runBooks: isUnskript=false)

curl  'https://<domain>/v1alpha1/workflows?pageSize=100&isUnskript=false' \
      -H "X-unSkript-API-Key:<apikey>" 

Curl Example (isUnskript=true):

https://tenant-staging.alpha.unskript.io/v1alpha1/workflows?pageSize=100&isUnskript=true' \
-H "X-unSkript-API-Key:<apikey>"

Get RunBook Details

Get workflow details.

Get workflow details.

get

/v1alpha1/workflows/{workflowId}

Path parameters

workflowIdanyrequired

workflow_id is the id of the requested workflow.

Query parameters

reqHdr.tidany

tid is the unique request id.

isUnskriptany

is_unskript describes if the workflow to get is default or custom.

tenantIdany

tenant_id is the tenantID of the workflow.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1alpha1/workflows/{workflowId}'

200

default

200

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflow": {
    "name": "text",
    "id": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "currentVersion": "text",
    "createTime": "2025-03-08T16:07:40.408Z",
    "lastRun": "2025-03-08T16:07:40.408Z",
    "lastUpdated": "2025-03-08T16:07:40.408Z",
    "proxyId": "text",
    "inputSchema": "text",
    "requiresApproval": true,
    "runningDisabled": true,
    "parentId": "text",
    "isFolder": true,
    "path": "text",
    "enableEnvironment": true,
    "executionDisabled": true,
    "connectorTypes": [
      "text"
    ],
    "categories": [
      "text"
    ],
    "icon": "text",
    "environmentStatus": [
      {
        "environmentName": "text",
        "status": "text",
        "reason": [
          "text"
        ]
      }
    ],
    "runningDisabledByFloatingEnv": true
  },
  "url": "text"
}

A successful response.

Curl Example:

This example gets the details of an unSkript XRunBook. To get a custom/personal xRUnBook, use the workflowId, and remove the isUnskript parameter.

'https://<domain>/v1alpha1/workflows/79c167af0209e60fc45455bf4943b733904d4ab8654028d8434d193d1bf8c16c?isUnskript=true' \
      -H "X-unSkript-API-Key:<apy key>" 

Run a RunBook

Runs workflow

Runs created workflow

post

/v1alpha1/workflows/{workflowId}/run

Path parameters

workflowIdanyrequired

workflow_id is the id of the requested workflow.

Body

reqHdrobject

req_hdr is the common request header.

tenantIdstring

tenant_id is the id of the tenant (is taken from token in case of http call).

proxyIdstringrequired

proxyId is the id of proxy.

paramsstring

params describes the input parameters to this particular run.

scheduleIdstring

schedule_id is the id of the scheduler. A workflow can have multiple schedules (is omitted if called by user).

userIdstring

requestIdstring

request_id is the id of the request. Is present only in case of running workflow after request approval.

userEmailstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1alpha1/workflows/{workflowId}/run' \
  --header 'Content-Type: application/json' \
  --data '{
    "reqHdr": {
      "tid": "text"
    },
    "tenantId": "text",
    "proxyId": "text",
    "params": "text",
    "scheduleId": "text",
    "userId": "text",
    "requestId": "text",
    "userEmail": "text"
  }'

200

default

200

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "executionIds": [
    "text"
  ]
}

A successful response.

Curl Example:

This xRunBook requires no parameters.

curl  -X POST 'https://<domain>/v1alpha1/workflows/14fac589-5849-403b-afcf-ed8079099500/run' \
	-H "X-unSkript-API-Key:<apitoken>" \
-d '{"proxyId":"<proxyid>"}'

This xRunBook has input Parameters:

curl -X POST '<domain>/v1alpha1/workflows/c5030e77-7b0a-6c4ca/run'
-H "<apitoken>"
-d '{"proxyId":"<proxyid)", "inputs":"{"tag_key":"Service","tag_value":"MongoDB", "user_name":"test123"}"}'