ProcessDeployments
If response data is empty there were no deployed Processes found with the chosen filters
Enter your bearer token in the format Bearer <token>
Current page number. Default value is 1.
Maximum page size is 200. Default page size is 30.
Filter Process deployments by Agent group
Filter Process deployments by Process name
Filter Process deployments by Process Unique Identifier
Filter Process deployments by tags
Filter Process deployments to exclude subprocesses
OK
Agent group doesnt exist
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-11-28T00:30:53.724Z",
"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 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.
Enter your bearer token in the format Bearer <token>
Whether to automatically activate Triggers for Processes on deployment. Default is true.
Process deployed successfully
Agent group not found
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-11-28T00:30:53.724Z",
"deployedBy": "text",
"description": "text",
"triggersActive": true,
"agentGroup": {
"id": 1,
"displayName": "text"
}
}
]
}Gets detailed information for a single Process deployment. Currently this is the same response model as 'List Process deployments'
Enter your bearer token in the format Bearer <token>
Deployment identifier
OK
Could not find Process deployment with requested identifier
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-11-28T00:30:53.724Z",
"deployedBy": "text",
"description": "text",
"triggersActive": true,
"agentGroup": {
"id": 1,
"displayName": "text"
}
}
}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.
Enter your bearer token in the format Bearer <token>
Deployment identifier
Process undeployed successfully
Can not undeploy Process in Development Agent group
Could not find Process deployment with requested identifier
DELETE /api/v1/process-deployments/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Enter your bearer token in the format Bearer <token>
Deployment identifier
Process start message sent
Process deployment not found
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"
}textEnter your bearer token in the format Bearer <token>
Deployment identifier
Trigger activation successful
Process deployment not found
PUT /api/v1/process-deployments/{id}/activation HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Enter your bearer token in the format Bearer <token>
Trigger deactivation successful
Process deployment not found
DELETE /api/v1/process-deployments/{id}/activation HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Enter your bearer token in the format Bearer <token>
Target agent group
Bad Request
Not Found
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"
}Enter your bearer token in the format Bearer <token>
Agent group from where to fetch Process variables from
List of Process ids
A dictionary mapping Process IDs to lists of Process Variables
Agent group not found
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?