How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Crosswork Jobs API

The jobs API from Cisco Crosswork — 7 operation(s) for jobs.

Cisco Crosswork Jobs API is one of 99 APIs that Cisco Crosswork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 7 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 2.1.0.

Requests are made against a single base URL, /crosswork/cwm/v2.

8 operations 7 paths 53 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.1.0
Base URL
https://{crosswork-host}:{port}/crosswork/inventory/
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Cisco Crosswork Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

jobs 8
GET
/job
List jobs.
list_jobs 3 params → 200400404
POST
/job
Execute a job.
execute_job body → 200400500
GET
/job/count
Get total job count.
job_count 1 param → 200400404
GET
/job/tags
List job tags.
list_job_tags → 200400
GET
/job/{jobId}/runs/{runId}
Describe a job run.
describe_job 2 params → 200400404
POST
/job/{jobId}/runs/{runId}/cancel
Cancel a job run.
cancel_job 2 params → 200400404
GET
/job/{jobId}/runs/{runId}/events
Get job execution history.
get_job_history 4 params → 200400404
POST
/job/{jobId}/runs/{runId}/terminate
Terminate a job run.
terminate_job 3 params → 200400404

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are workflow.PendingActivityInfo (24 properties), workflow.WorkflowExecutionInfo (24 properties), workflow.PendingNexusOperationInfo (15 properties), workflow.CallbackInfo (9 properties). Each schema is shown below with its type and property counts.

common.SearchAttributes
object
1 property
workflow.RequestIdInfo
object
3 properties
common.RetryPolicy
object
5 properties
common.WorkflowExecution
object
Contains information about the root workflow execution. The root workflow execution is defined as follows: 1. A workflow without parent workflow is its own roo…
2 properties
common.Payload
object
Alternative way to supply message and stacktrace and possibly other attributes, used for encryption of errors originating in user code which might contain sens…
2 properties
common.Payloads
object
1 property
workflow.DeploymentVersionTransition
object
When present, indicates the workflow is transitioning to a different deployment version (which may belong to the same deployment name or another). Can indicate…
2 properties
common.ActivityType
object
1 property
failure.Failure
object
The last attempt's failure, if any.
6 properties
workflow.NexusOperationCancellationInfo
object
7 properties
go_temporal_io_api_enums_v1.CallbackState
integer
common.Link
object
1 property
workflow.DeploymentTransition
object
When present, indicates the workflow is transitioning to a different deployment. Can indicate one of the following transitions: unversioned - versioned, versio…
1 property
go_temporal_io_api_deployment_v1.WorkerDeploymentVersion
object
The Worker Deployment Version that completed the last workflow task of this workflow execution. An absent value means no workflow task is completed, or the wor…
2 properties
workflow.WorkflowExecutionConfig
object
5 properties
enums.PendingActivityState
integer
workflowservice.ListWorkflowExecutionsResponse
object
2 properties
workflow.PendingNexusOperationInfo
object
15 properties
workflow.WorkflowExecutionExtendedInfo
object
7 properties
enums.EventType
integer
The event type of the history event generated by the request.
enums.PendingWorkflowTaskState
integer
enums.PendingNexusOperationState
integer
workflow.PendingChildExecutionInfo
object
5 properties
workflow.CallbackInfo
object
9 properties
enums.WorkflowExecutionStatus
integer
workflowservice.DescribeWorkflowExecutionResponse
object
8 properties
activity.ActivityOptions
object
Current activity options. May be different from the one used to start the activity.
6 properties
workflow.PendingActivityInfo
object
24 properties
taskqueue.TaskQueue
object
3 properties
enums.NexusOperationCancellationState
integer
common.Memo
object
1 property
workflow.VersioningOverride
object
Present if user has set an execution-specific versioning override. This override takes precedence over SDK-sent behavior (and version when override is PINNED).…
4 properties
history.HistoryEvent
object
9 properties
durationpb.Duration
object
Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put…
2 properties
common.Priority
object
Priority metadata
3 properties
common.Callback
object
Information on how this callback should be invoked (e.g. its URL and type).
2 properties
workflow.CallbackInfo_Trigger
object
Trigger for this callback.
1 property
server.TriggerData
object
5 properties
workflow.WorkflowExecutionInfo
object
24 properties
workflow.ResetPointInfo
object
7 properties
workflow.ResetPoints
object
1 property
workflow.PendingWorkflowTaskInfo
object
5 properties
enums.VersioningBehavior
integer
Versioning behavior determines how the server should treat this execution when workers are upgraded. When present it means this workflow execution is versioned…
deployment.Deployment
object
The worker deployment that completed the last workflow task of this workflow execution. Must be present if behavior is set. Absent value means no workflow task…
2 properties
enums.TaskQueueKind
integer
Default: TASKQUEUEKINDNORMAL.
common.WorkflowType
object
1 property
common.WorkerVersionStamp
object
If set, the most recent worker version stamp that appeared in a workflow task completion Deprecated. This field should be cleaned up when versioning-2 API is r…
2 properties
sdk.UserMetadata
object
Metadata on the event. This is often carried over from commands and client calls. Most events won't have this information, and how this information is used is…
2 properties
workflow.PendingActivityInfo_PauseInfo
object
2 properties
timestamppb.Timestamp
object
originalscheduledtime is the scheduled time of the first workflow task during workflow task heartbeat. Heartbeat workflow task is done by RespondWorkflowTaskCo…
2 properties
gin.H
object
enums.ParentClosePolicy
integer
Default: PARENTCLOSEPOLICYTERMINATE.
workflow.WorkflowExecutionVersioningInfo
object
Absent value means the workflow execution is not versioned. When present, the execution might be versioned or unversioned, depending on versioninginfo.behavior…
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-jobs-api-openapi.yml Raw ↑

Other APIs Cisco Crosswork publishes across the network.

Cisco Crosswork Add Credentials API
Cisco Crosswork Add Data Gateway Enrollments API
Cisco Crosswork Add Destinations API
Cisco Crosswork Add Nodes/Devices API
Cisco Crosswork Add Policies API
Cisco Crosswork Add Providers API
Cisco Crosswork Add Tags API
Cisco Crosswork Add via CSV file API
Cisco Crosswork Alarms API
Cisco Crosswork Alert API API
Cisco Crosswork API Controller API
Cisco Crosswork Authconfig API
Where this information came from

This is an independent, third-party profile of Cisco Crosswork Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.