Workflow Engine `isActive` API Deprecated

Prev Next

Beginning in the 2023.1 release, the workflow_engine/active API is deprecated from Workflow Engine (WFE) and scheduled to be replaced by the /workflow_engine/workers/status API.

API Endpoint Description Deprecation Release Scheduled Removal Release Replacement
POST /workflow_engine/active Gets the status and configured startup values for jobWorker and taskWorker. 2023.1 Platform 7 GET /workflow_engine/workers/status

What should I do?

Review any apps and adapters that might reference the deprecated API and change it to the replacement call.

Deprecated Route

"route": {
    "path": "/workflow_engine/active",
    "verb": "POST"
},

Output

true

Replacement Route

"route": {
    "path": "/workflow_engine/workers/status",
    "verb": "GET"
},

Output

{
  "jobWorker": {
    "running": true,
    "clusterValue": "not defined",
    "localValue": "not defined",
    "startupValue": true
  },
  "taskWorker": {
    "running": true,
    "clusterValue": "not defined",
    "localValue": "not defined",
    "startupValue": true
  }
}