Execute scripts on remote servers¶

POST /execute/workflow/(path)?key=(key)&rev=(rev)¶

Execute workflow from path

Query Parameters:
	path (string) – Path to workflow key (string) – optional - ApiKey for identification, or just send the Auth headers rev (string) – optional - Specific version(revision) of the workflow. Default - the latest(HEAD) version
Form Parameters:
	something=value – Any key=value passed in form data will be available as Environment variables
Request Headers:
	X-Cr-User – User name (not needed if key is passed) X-Cr-Token – Auth token
Status Codes:	200 OK – no error

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "success": {
    "msg": "Dispatched",
    "task_uid": "c83146c41aa54d6fba80b55487bb3937",
    "group": 649
  }
}

POST /execute/script/(path)?key=(key)&rev=(rev)¶

Execute script from path

Query Parameters:
	path (string) – Path to workflow key (string) – optional - ApiKey for identification, or just send the Auth headers rev (string) – optional - Specific version(revision) of the workflow. Default - the latest(HEAD) version
Form Parameters:
	targets – (Mandatory) The target selector for nodes to run script on. something=value – Any key=value passed in form data will be available as Environment variables
Request Headers:
	X-Cr-User – User name (not needed if key is passed) X-Cr-Token – Auth token

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8


{
  "success": {
    "msg": "Dispatched",
    "task_uid": "c83146c41aa54d6fba80b55487bb3937",
    "group": 649
  }
}

Status Codes:	200 OK – no error

POST /execute/resume/(uuid)/(step)¶

Resume script. If the script has multiple steps, the step to be resumed can be passed as step

Form Parameters:
	something=value – Any key=value passed in form data will be available as Environment variables
Query Parameters:
	uuid (string) – UUID of the script run to be resumed step (int) – The step to resume. Default: 1
Request Headers:
	X-Cr-User – User name (not needed if key is passed) X-Cr-Token – Auth token

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8


{
  "success": {
    "msg": "Dispatched",
    "task_uid": "c83146c41aa54d6fba80b55487bb3937",
    "group": 649
  }
}

Status Codes:	200 OK – no error