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 Cluster Manager API

The ClusterManager API from Cisco Crosswork — 26 operation(s) for clustermanager.

Cisco Crosswork Cluster Manager 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 ClusterManager. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 26 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against the base URL https://{crosswork-host}:{port}.

26 operations 26 paths 50 schemas 6 GET20 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://{crosswork-host}:{port}
Resource Areas
1

Paths & Operations 26

Across 26 paths, the API surfaces 26 operations — 6 GET, 20 POST. Each is listed below with its method, path, parameters, and response codes.

ClusterManager 26
POST
/v2/cluster/action
Execute an action on an object, this is for now on a micro service
ExecuteAction body → 200
POST
/v2/cluster/app/details/query
Get the Crosswork App Details
GetAppDetails body → 200
GET
/v2/cluster/app/health/list
GetAppHealthSummaryList → 200
POST
/v2/cluster/app/health/query
GetAppHealthSummary body → 200
POST
/v2/cluster/app/resource/query
Get the Crosswork App Resource Health
GetAppResource body → 200
POST
/v2/cluster/collect-publish/show/query
Get the status of all PublishCollectJobs, where Crosswork internal operations data has been collected and is being sent to a remote location, such as Cisco TAC, for troubleshooting purposes.
GetPublishCollectJobs body → 200
POST
/v2/cluster/collect-publish/start/query
Send the Collected Op data for troubleshooting to remote location by specifying the ID of collect job
PublishCollectJobData body → 200
POST
/v2/cluster/collect/configure
Change the Timeout for the Collection Operation of Crosswork Platform
ChangeCollectConfig body → 200
POST
/v2/cluster/collect/show/query
Get the list of all internal Crosswork operations data-collection jobs that have been requested on the platform. The list can be narrowed down by specifying a job "Id", “Type” or “Scope” parameters.
GetCollectJobsInfo body → 200
POST
/v2/cluster/collect/start/query
Showtech Collection APIs ( backward compatibility wrt to req/response) Initiate collection of data for troubleshooting Crosswork Platform applications. Collection jobs can be scoped to a specific app…
RequestCollectJobs body → 200
POST
/v2/cluster/dc/node/actions/query
Get the Crosswork Node Actions
GetNodeActions body → 200
POST
/v2/cluster/dc/node/details/query
Get the Crosswork Cluster Details
GetNodeDetails body → 200
POST
/v2/cluster/dc/node/health/query
GetNodeHealthSummary body → 200
POST
/v2/cluster/dc/node/resource/query
Get the Crosswork Node Resource Health
GetNodeResource body → 200
GET
/v2/cluster/dc/node/summary/list
Get the Crosswork Node List Summary
GetNodeListSummary → 200
POST
/v2/cluster/dc/node/summary/query
Get the Crosswork Node Summary
GetNodeSummary body → 200
GET
/v2/cluster/dc/summary/list
Get the Crosswork Node List Summary
GetDCListSummary → 200
POST
/v2/cluster/dc/summary/query
Get the Crosswork Node Summary
GetDCSummary body → 200
GET
/v2/cluster/infra/summary
Get the Crosswork Infrastructure summary
GetInfraSummary → 200
POST
/v2/cluster/microservice/list/query
GetMicroServiceList body → 200
POST
/v2/cluster/microservice/restart
Restart given microservice (all pods of the microservice will be restarted)
RequestMicroserviceRestart body → 200
POST
/v2/cluster/resource/query
Get the Crosswork Cluster Resource Health
GetClusterResource body → 200
POST
/v2/cluster/signature/verify
Verify the Signature given
VerifySignature body → 200
GET
/v2/cluster/summary/list
Get the Crosswork Cluster List Summary
GetClusterListSummary → 200
POST
/v2/cluster/summary/query
Get the Crosswork Cluster Summary
GetClusterSummary body → 200
GET
/v2/cluster/version/show
Get the Crosswork Platform software version.
GetVersion → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are clusterNodeSummary (10 properties), CollectPubResultpublishJob (9 properties), clusterNodeDetails (9 properties), clusterNodeParameters (8 properties). Each schema is shown below with its type and property counts.

clusterNodeReq
object
1 property
clusterPublishType
string
clusterAppReq
object
1 property
clusterAppDetails
object
5 properties
clusterNodeParameters
object
8 properties
clusterOpResult
object
OpResult is used to indicate whether an operation has been accepted or not. A string or map payload provides the additional response information (for example:…
5 properties
clusterCollectPubGetReq
object
2 properties
clusterMicroServiceList
object
1 property
clusterDCSummary
object
3 properties
clusterInfraSummary
object
3 properties
CollectPubResultpublishJob
object
9 properties
clusterMicroService
object
6 properties
clusterResourceSummary
object
4 properties
clusterDCReq
object
1 property
clusterAction
object
2 properties
CollectOpResultcollectJob
object
7 properties
clusterCollectReq
object
2 properties
clusterAppHealthList
object
1 property
clusterAppHealthSummary
object
3 properties
clusterActionResp
object
2 properties
clusterSizeProfile
object
3 properties
clusterCollectInfoReq
object
3 properties
clusterNodeDetails
object
9 properties
clusterNodeRecommendation
object
1 property
clusterSignature
string
clusterResultValue
string
clusterResource
object
4 properties
clusterSSH_Config
object
5 properties
clusterClusterSummary
object
2 properties
clusterRespValue
string
clusterVerifyReq
object
2 properties
clusterjobStatus
string
clusterCollectType
string
clusterverifyResponse
object
1 property
clusterMicroServiceAction
object
1 property
clusterHealthState
string
clusterDCListSummary
object
1 property
clusterAppParameters
object
4 properties
clusterCollectPubResult
object
3 properties
clusterNodeHealthSummary
object
3 properties
clusterNodeListSummary
object
1 property
clusterCollectConfReq
object
1 property
clusterBasicReq
object
1 property
clusterClusterListSummary
object
1 property
clusterNodeActions
object
1 property
clusterClusterReq
object
1 property
clusterCollectOpResult
object
3 properties
clusterCollectPubPostReq
object
3 properties
clusterNodeSummary
object
10 properties
clusterHealthSummary
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-clustermanager-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 Cluster Manager 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.