RunBooks

List RunBooks

List workflows

List workflows matching the optional filter

GET/v1alpha1/workflows

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

workflowsarray of object

workflows is the details of all the Workflows.

nextPageTokenstring

next_page_token represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request.

pageCountinteger (int32)

page_count is the number of pages.

totalCountinteger (int32)

total_count is the Total number of workflows.

categoryCountsarray of object

category_counts is the list of count details for each present category.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1alpha1/workflows', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflows": [
    {
      "name": "text",
      "id": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "currentVersion": "text",
      "createTime": "2025-02-02T23:53:25.866Z",
      "lastRun": "2025-02-02T23:53:25.866Z",
      "lastUpdated": "2025-02-02T23:53:25.866Z",
      "proxyId": "text",
      "inputSchema": "text",
      "requiresApproval": false,
      "runningDisabled": false,
      "parentId": "text",
      "isFolder": false,
      "path": "text",
      "enableEnvironment": false,
      "executionDisabled": false,
      "connectorTypes": [
        "text"
      ],
      "categories": [
        "text"
      ],
      "icon": "text",
      "environmentStatus": [
        {
          "environmentName": "text",
          "status": "text",
          "reason": [
            "text"
          ]
        }
      ],
      "runningDisabledByFloatingEnv": false
    }
  ],
  "nextPageToken": "text",
  "pageCount": 0,
  "totalCount": 0,
  "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 workflow details.

GET/v1alpha1/workflows/{workflowId}

Path parameters

workflowId*string

workflow_id is the id of the requested workflow.

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

workflowobject

Workflow contains details about a workflow.

urlstring

url is the url to temporary file.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1alpha1/workflows/{workflowId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "workflow": {
    "name": "text",
    "id": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "currentVersion": "text",
    "createTime": "2025-02-02T23:53:25.866Z",
    "lastRun": "2025-02-02T23:53:25.866Z",
    "lastUpdated": "2025-02-02T23:53:25.866Z",
    "proxyId": "text",
    "inputSchema": "text",
    "requiresApproval": false,
    "runningDisabled": false,
    "parentId": "text",
    "isFolder": false,
    "path": "text",
    "enableEnvironment": false,
    "executionDisabled": false,
    "connectorTypes": [
      "text"
    ],
    "categories": [
      "text"
    ],
    "icon": "text",
    "environmentStatus": [
      {
        "environmentName": "text",
        "status": "text",
        "reason": [
          "text"
        ]
      }
    ],
    "runningDisabledByFloatingEnv": false
  },
  "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

Runs created workflow

POST/v1alpha1/workflows/{workflowId}/run

Path parameters

workflowId*string

workflow_id is the id of the requested workflow.

Body

application/json

reqHdrRequestHeader is the common header which every request (GRPC/HTTP) should have

tenantIdstring

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

proxyId*string

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).

userIduser_id is the ID of the user who ran workflow. (should be sent if userID cannot be retrieved from context)

requestIdstring

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

userEmailEmail of user who scheduled workflow execution

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

executionIdsarray of string

execution_id is the id of the execution entry.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1alpha1/workflows/{workflowId}/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "proxyId": "text"
    }),
});
const data = await response.json();

Response

200default

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