Cisco Crosswork Workers API
The workers API from Cisco Crosswork — 4 operation(s) for workers.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cisco-crosswork-workers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: Cisco Crosswork Workflow Manager (CWM) 2.1 offers RESTful APIs that enable automation engineers and developers to create, deploy, and manage workflows, adapters, jobs, resources, events, and workers within the Cisco CWM platform.
title: Cisco Crosswork Workflow Manager Workers API
termsOfService: www.cisco.com
contact:
name: API Support
url: https://www.cisco.com/support
version: 2.1.0
x-provenance:
method: harvested
authored_by: Cisco Crosswork
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
note: 'Reconstructed verbatim from the per-operation Swagger 2.0 JSON fragments Cisco serves for the Crosswork Workflow Manager API reference at developer.cisco.com/docs/crosswork/workflow-manager/. info, basePath and securityDefinitions are Cisco''s own meta block; each path/method object is Cisco''s own spec object, unmodified except that inline schemas carrying the swagger-ui $$ref marker were hoisted back into #/definitions and replaced with a real $ref.'
servers:
- url: /crosswork/cwm/v2
tags:
- name: Workers
paths:
/worker:
get:
description: Retrieve a list of all workers managed by the system.
tags:
- Workers
summary: List all workers
operationId: list_workers
responses:
'200':
description: Workers retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/server.WorkerSimplified'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: list-workers
method: get
path: /worker
post:
description: Create a new worker by connecting to the worker manager via gRPC.
tags:
- Workers
summary: Create a new worker
operationId: create_worker
responses:
'201':
description: Worker created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.InitResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.InitResponse'
__originalOperationId: create-worker
method: post
path: /worker
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/server.InRequest'
description: Data required to create the worker.
required: true
/worker/{workerName}:
delete:
description: Delete a specific worker from the worker manager.
tags:
- Workers
summary: Delete a worker
operationId: delete_worker
parameters:
- description: Worker name.
name: workerName
in: path
required: true
schema:
type: string
responses:
'200':
description: Worker deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'404':
description: Worker not found.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: delete-worker
method: delete
path: /worker/{workerName}
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/server.stopRequest'
description: Delete request payload for the worker.
required: true
get:
description: Retrieve detailed information about a specific worker by its name.
tags:
- Workers
summary: Get a specific worker
operationId: get_worker
parameters:
- description: Worker name.
name: workerName
in: path
required: true
schema:
type: string
responses:
'200':
description: Worker details retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/models.Worker'
'404':
description: Worker not found.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: get-worker
method: get
path: /worker/{workerName}
put:
description: Update the configuration of an existing worker.
tags:
- Workers
summary: Update a worker
operationId: update_worker
parameters:
- description: Worker name.
name: workerName
in: path
required: true
schema:
type: string
responses:
'200':
description: Worker updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'404':
description: Worker not found.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: update-worker
method: put
path: /worker/{workerName}
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/server.updateRequest'
description: Update request payload for the worker.
/worker/{workerName}/start:
post:
description: Start a specific worker in the worker manager.
tags:
- Workers
summary: Start a worker
operationId: start_worker
parameters:
- description: Name of the worker to start.
name: workerName
in: path
required: true
schema:
type: string
responses:
'200':
description: Worker started successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'404':
description: Worker not found.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: start-worker
method: post
path: /worker/{workerName}/start
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/server.startRequest'
description: Start request payload for the worker.
required: true
/worker/{workerName}/stop:
post:
description: Stop a running worker in the worker manager.
tags:
- Workers
summary: Stop a worker
operationId: stop_worker
parameters:
- description: Name of the worker to stop.
name: workerName
in: path
required: true
schema:
type: string
responses:
'200':
description: Worker stopped successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'404':
description: Worker not found.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
'503':
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/rpc.GenericResponse'
__originalOperationId: stop-worker
method: post
path: /worker/{workerName}/stop
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/server.stopRequest'
description: Stop request payload for the worker.
required: true
components:
schemas:
server.startRequest:
type: object
properties:
forceReload:
type: boolean
default: false
server.updateRequest:
type: object
properties:
activities:
type: array
items:
type: string
forceStop:
type: boolean
default: false
startWorker:
type: boolean
default: false
stopWorkerIfRunning:
type: boolean
default: false
server.WorkerSimplified:
type: object
properties:
activeError:
type: string
activities:
type: array
items:
$ref: '#/components/schemas/server.ActivitySimplified'
adminStatus:
type: string
createdAt:
description: models.WFBase
type: string
infraJobId:
type: string
name:
type: string
status:
type: string
updatedAt:
type: string
server.ActivitySimplified:
type: object
properties:
adapterId:
type: string
numOfActivities:
type: integer
rpc.GenericResponse:
type: object
properties:
errorCode:
$ref: '#/components/schemas/github-hyc_scm_engit_cisco_com_CWM_cwm-x24_services_worker-manager-service-dynamic_rpc.ErrorCode'
message:
description: Message, returned if ErrorCode not OK
type: string
models.Activity:
type: object
properties:
adapterId:
type: string
description:
type: string
id:
type: string
inputSchema:
type: array
items:
type: integer
name:
type: string
outputSchema:
type: array
items:
type: integer
packageName:
type: string
rpc.InitResponse:
type: object
properties:
status:
description: status of the worker
type: string
workerUUID:
description: UUID assigned to worker
type: string
server.stopRequest:
type: object
properties:
forceStop:
type: boolean
default: false
models.WorkerStatus:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
x-enum-comments:
Deleting: 'todo: support'
Stopping: 'todo: support'
x-enum-varnames:
- Unknown
- Initialized
- Running
- Stopped
- Deleted
- Failed
- Initializing
- Stopping
- Deleting
github-hyc_scm_engit_cisco_com_CWM_cwm-x24_services_worker-manager-service-dynamic_rpc.ErrorCode:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
x-enum-varnames:
- ErrorCode_OK
- ErrorCode_UNKNOWN
- ErrorCode_INVALID_ARGUMENTS
- ErrorCode_NOT_FOUND
- ErrorCode_ALREADY_EXISTS
- ErrorCode_PERMISSION_DENIED
- ErrorCode_UNAUTHENTICATED
- ErrorCode_FAILED
- ErrorCode_ALREADY_RUNNING
- ErrorCode_ALREADY_STOPPED
- ErrorCode_TIMED_OUT
description: Error Code.
server.InRequest:
type: object
properties:
activities:
type: array
items:
type: string
force:
type: boolean
default: false
startWorker:
type: boolean
default: false
workerName:
type: string
workerProfile:
type: string
default: default
models.Worker:
type: object
properties:
activeError:
type: string
activities:
type: array
items:
$ref: '#/components/schemas/models.Activity'
adminStatus:
$ref: '#/components/schemas/models.WorkerStatus'
createdAt:
type: string
cwmVersion:
type: string
infraJobId:
type: string
isJobChecked:
type: boolean
name:
type: string
status:
$ref: '#/components/schemas/models.WorkerStatus'
updatedAt:
type: string
workerProfile:
type: string
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
description: 'JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"'
x-evidence:
- type: reference
url: https://developer.cisco.com/docs/crosswork/workflow-manager/
- type: fragment-index
url: https://pubhub.devnetcloud.com/media/crosswork-workflow-manager-api-document/docs/262737b2-b3c2-32cd-b07b-fdbdcd23918f/apis/
count: 90