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 Troubleshooting API API

Collect Logs, metrics and other details for the Tech-support to debug the Crosswork issues

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

This API exposes 5 operations across 5 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

5 operations 5 paths 16 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{crosswork-host}:{port}/crosswork/platform
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 5

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

Troubleshooting API 5

Collect Logs, metrics and other details for the Tech-support to debug the Crosswork issues

POST
/v1/collect-publish/show
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
/v1/collect-publish/start
Send the Collected Op data for troubleshooting to remote location by specifying the ID of collect job
PublishCollectJobData body → 200
POST
/v1/collect/show
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
/v1/collect/start
Initiate collection of data for troubleshooting Crosswork Platform applications. Collection jobs can be scoped to a specific app or type.
RequestCollectJobs body → 200
POST
/v1/platform/logging
Set the message logging level for a Crosswork platform service. Use “Id” arg to pass the servicename, and “Loglevel” to pass the new level (“Info”, “Debug”, "Disable”)
ChangeLogLevel body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CollectPubResultpublishJob (9 properties), CollectOpResultcollectJob (7 properties), robotctl_apiSSH_Config (5 properties), robotctl_apiOpResult (4 properties). Each schema is shown below with its type and property counts.

robotctl_apiCollectType
string
robotctl_apiLogLevels
string
robotctl_apiCollectOpResult
object
3 properties
robotctl_apiSSH_Config
object
5 properties
robotctl_apiCollectPubResult
object
3 properties
robotctl_apiPublishType
string
robotctl_apijobStatus
string
robotctl_apiOpResult
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:…
4 properties
robotctl_apiLogLevelReq
object
2 properties
robotctl_apiCollectInfoReq
object
3 properties
robotctl_apiCollectPubPostReq
object
3 properties
robotctl_apiCollectPubGetReq
object
2 properties
CollectPubResultpublishJob
object
9 properties
CollectOpResultcollectJob
object
7 properties
robotctl_apiResultValue
string
robotctl_apiCollectReq
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-troubleshooting-api-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 Troubleshooting API 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.