RunBooks

List RunBooks

List workflows

get

List workflows matching the optional filter

Query parameters

reqHdr.tidstringOptional

tid is the unique request id.

filterstringOptional

filter expression.

pageSizeinteger · int32Optional

page_size specifies the maximum number of results to be returned.

pageTokenstringOptional

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

isUnskriptbooleanOptional

is_unskript describes whether to list unSkript or or custom workflows.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflows": [
    {
      "name": "text",
      "id": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "currentVersion": "text",
      "createTime": "2025-05-09T10:24:41.307Z",
      "lastRun": "2025-05-09T10:24:41.307Z",
      "lastUpdated": "2025-05-09T10:24:41.307Z",
      "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"
    }
  ]
}

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

Get workflow details.

Path parameters

workflowIdstringRequired

workflow_id is the id of the requested workflow.

Query parameters

reqHdr.tidstringOptional

tid is the unique request id.

isUnskriptbooleanOptional

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

tenantIdstringOptional

tenant_id is the tenantID of the workflow.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

HTTPcURLJavaScriptPython

GET /v1alpha1/workflows/{workflowId} HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflow": {
    "name": "text",
    "id": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "currentVersion": "text",
    "createTime": "2025-05-09T10:24:41.307Z",
    "lastRun": "2025-05-09T10:24:41.307Z",
    "lastUpdated": "2025-05-09T10:24:41.307Z",
    "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"
}

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

post

Runs created workflow

Path parameters

workflowIdstringRequired

workflow_id is the id of the requested workflow.

Body

RunWorkflowRequest is the request to run workflow.

tenantIdstringOptional

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

proxyIdstringRequired

proxyId is the id of proxy.

paramsstringOptional

params describes the input parameters to this particular run.

scheduleIdstringOptional

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

userIdstringOptional

requestIdstringOptional

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

userEmailstringOptional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

HTTPcURLJavaScriptPython

POST /v1alpha1/workflows/{workflowId}/run HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "reqHdr": {
    "tid": "text"
  },
  "tenantId": "text",
  "proxyId": "text",
  "params": "text",
  "scheduleId": "text",
  "userId": "text",
  "requestId": "text",
  "userEmail": "text"
}

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

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"}"}'