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 Crosswork Health API API

APIs to get the Health of Crosswork Applications and their dependent services

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

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

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

4 operations 4 paths 11 schemas 4 GET

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 Crosswork Health 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 4

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

Crosswork Health API 4

APIs to get the Health of Crosswork Applications and their dependent services

GET
/v1/apps/health
Get the health summary of applications running on the Crosswork Platform
GetAppsSummary → 200
GET
/v1/apps/{AppName}/health
Get the health summary of an application running on the Crosswork Platform by specifying the application name
GetAppServicesSummary 1 param → 200
GET
/v1/apps/{AppName}/{ServiceName}/health
Get the health summary of a specific service running as part of an application by specifying application name and service name
GetAppServiceDetail 2 params → 200
GET
/v1/platform/health
Get a health summary for all applications running on the Crosswork platform. Returns a list of all running applications, with IDs, status, descriptions, and a count of applications in each state: Run…
GetSystemSummary → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are robotctl_apisrvProcessDetail (9 properties), robotctl_apisrvInfo (7 properties), robotctl_apicountInfo (5 properties), robotctl_apiappInfo (5 properties). Each schema is shown below with its type and property counts.

robotctl_apiappInfo
object
5 properties
robotctl_apicountInfo
object
5 properties
robotctl_apiHealthAppServices
object
3 properties
robotctl_apisrvProcessDetail
object
9 properties
robotctl_apiSupervisordState
string
robotctl_apiHealthSystem
object
3 properties
robotctl_apiHealthApps
object
3 properties
robotctl_apisrvInfo
object
7 properties
robotctl_apiRobotSvcState
string
- Unknown: ROBOTMSVCSTATEUNKNOWN defines unknown state. Only used to app-status. - Down: ROBOTMSVCSTATEDOWN defines when the service/container is non-functiona…
robotctl_apiHealthAppSrvProcesses
object
3 properties
robotctl_apiResultValue
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-crosswork-health-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 Crosswork Health 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.