ProcessDeployments

List Process deployments

get

If response data is empty there were no deployed Processes found with the chosen filters

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 30.

agentGroupIdinteger · int64Optional

Filter Process deployments by Agent group

processNamestringOptional

Filter Process deployments by Process name

processGuidstring · uuidOptional

Filter Process deployments by Process Unique Identifier

tagsstring[]Optional

Filter Process deployments by tags

excludeSubprocessesbooleanOptional

Filter Process deployments to exclude subprocesses

Responses

200

OK

application/json

400

Agent group doesnt exist

application/problem+json

get

/api/v1/process-deployments

HTTPcURLJavaScriptPython

GET /api/v1/process-deployments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "deploymentId": 1,
      "processId": 1,
      "processName": "text",
      "processGuid": "123e4567-e89b-12d3-a456-426614174000",
      "processVersion": "text",
      "processBuildVersion": 1,
      "deployedAtUtc": "2025-12-18T15:30:00.561Z",
      "deployedBy": "text",
      "description": "text",
      "triggersActive": true,
      "agentGroup": {
        "id": 1,
        "displayName": "text"
      }
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Deploy Processes to an Agent group

post

Deploy up to 20 Processes to an Agent group. The following validation rules apply to deploying a Process: All used Environment variables need to have values set. All used Subprocesses need to be deployed to the target Agent group/Environment Process Target Framework needs to match Agent group framework. You can also deploy an older version of a Process to the 'Default' Agent group.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

agentGroupIdinteger · int64Optional

activateTriggersbooleanOptional

Whether to automatically activate Triggers for Processes on deployment. Default is true.

deploymentDescriptionstringOptional

Responses

201

Process deployed successfully

application/json

400

Agent group not found

application/problem+json

post

/api/v1/process-deployments

HTTPcURLJavaScriptPython

POST /api/v1/process-deployments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "agentGroupId": 1,
  "processes": [
    {
      "processGuid": "123e4567-e89b-12d3-a456-426614174000",
      "version": 1,
      "processVariables": [
        {
          "name": "text",
          "value": "text",
          "isSecret": true,
          "mode": "text",
          "description": "text"
        }
      ]
    }
  ],
  "activateTriggers": true,
  "deploymentDescription": "text"
}

{
  "data": [
    {
      "deploymentId": 1,
      "processId": 1,
      "processName": "text",
      "processGuid": "123e4567-e89b-12d3-a456-426614174000",
      "processVersion": "text",
      "processBuildVersion": 1,
      "deployedAtUtc": "2025-12-18T15:30:00.561Z",
      "deployedBy": "text",
      "description": "text",
      "triggersActive": true,
      "agentGroup": {
        "id": 1,
        "displayName": "text"
      }
    }
  ]
}

Get single Process deployment

get

Gets detailed information for a single Process deployment. Currently this is the same response model as 'List Process deployments'

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Deployment identifier

Responses

200

OK

application/json

404

Could not find Process deployment with requested identifier

application/problem+json

get

/api/v1/process-deployments/{id}

HTTPcURLJavaScriptPython

GET /api/v1/process-deployments/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "deploymentId": 1,
    "processId": 1,
    "processName": "text",
    "processGuid": "123e4567-e89b-12d3-a456-426614174000",
    "processVersion": "text",
    "processBuildVersion": 1,
    "deployedAtUtc": "2025-12-18T15:30:00.561Z",
    "deployedBy": "text",
    "description": "text",
    "triggersActive": true,
    "agentGroup": {
      "id": 1,
      "displayName": "text"
    }
  }
}

Undeploy a Process from an Agent group

delete

It is not possible to undeploy a Process from the Development Agent group. If you wish to remove the Process completely you should use the DeleteProcess endpoint.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Deployment identifier

Responses

204

Process undeployed successfully

400

Can not undeploy Process in Development Agent group

application/problem+json

404

Could not find Process deployment with requested identifier

application/problem+json

delete

/api/v1/process-deployments/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/process-deployments/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Run a Process in the selected Agent group

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Deployment identifier

Body

application/json

Other propertiesstringOptional

Responses

202

Process start message sent

text/plain

404

Process deployment not found

application/problem+json

post

/api/v1/process-deployments/{id}/execute

HTTPcURLJavaScriptPython

POST /api/v1/process-deployments/{id}/execute HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

text

Activate Process triggers

put

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Deployment identifier

Responses

204

Trigger activation successful

404

Process deployment not found

application/problem+json

put

/api/v1/process-deployments/{id}/activation

HTTPcURLJavaScriptPython

PUT /api/v1/process-deployments/{id}/activation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Deactivate Process triggers

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

Responses

204

Trigger deactivation successful

404

Process deployment not found

application/problem+json

delete

/api/v1/process-deployments/{id}/activation

HTTPcURLJavaScriptPython

DELETE /api/v1/process-deployments/{id}/activation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update Process variables

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

Target agent group

processGuidstring · uuidRequired

Bodyobject[]

application/json

namestring | nullableOptional

valuestring | nullableOptional

isSecretbooleanOptional

modestring | nullableOptional

descriptionstring | nullableOptional

Responses

400

Bad Request

application/problem+json

404

Not Found

application/problem+json

post

/api/v1/process-deployments/{processGuid}/agentGroup/{agentGroupId}/variableUpdate

HTTPcURLJavaScriptPython

POST /api/v1/process-deployments/{processGuid}/agentGroup/{agentGroupId}/variableUpdate HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

[
  {
    "name": "text",
    "value": "text",
    "isSecret": true,
    "mode": "text",
    "description": "text"
  }
]

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List Process variables for Processes in Agent group

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

agentGroupIdinteger · int64Required

Agent group from where to fetch Process variables from

Query parameters

processIdsinteger · int64[]Optional

List of Process ids

Responses

200

A dictionary mapping Process IDs to lists of Process Variables

application/json

404

Agent group not found

application/problem+json

get

/api/v1/process-deployments/{agentGroupId}/variables

HTTPcURLJavaScriptPython

GET /api/v1/process-deployments/{agentGroupId}/variables HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "value": "text",
        "isSecret": true,
        "mode": "text",
        "description": "text"
      }
    ]
  }
}