ProcessDeployments

List Process deployments

get

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

Authorizations
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

Responses
200

Success

application/json
get
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-09-07T10:06:06.548Z",
      "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
Body
agentGroupIdinteger · int64Optional
activateTriggersbooleanOptional

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

deploymentDescriptionstringOptional
Responses
201

Process deployed successfully

application/json
post
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-09-07T10:06:06.548Z",
      "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
Path parameters
idinteger · int64Required

Deployment identifier

Responses
200

Success

application/json
get
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-09-07T10:06:06.548Z",
    "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
Path parameters
idinteger · int64Required

Deployment identifier

Responses
204

Process undeployed successfully

No content

delete
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
Path parameters
idinteger · int64Required

Deployment identifier

Body
Other propertiesstringOptional
Responses
202

Process start message sent

text/plain
Responsestring
post
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
Path parameters
idinteger · int64Required

Deployment identifier

Responses
204

Trigger activation successful

No content

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

No content

Deactivate Process triggers

delete
Authorizations
Path parameters
idinteger · int64Required
Responses
204

Trigger deactivation successful

No content

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

No content

Update Process variables

post
Authorizations
Path parameters
agentGroupIdinteger · int64Required

Target agent group

processGuidstring · uuidRequired
Bodyobject[]
namestring | nullableOptional
valuestring | nullableOptional
isSecretbooleanOptional
modestring | nullableOptional
descriptionstring | nullableOptional
Responses
400

Bad Request

application/problem+json
post
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
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
get
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"
      }
    ]
  }
}

Was this helpful?