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 Get Credentials API

The Get Credentials API from Cisco Crosswork — 1 operation(s) for get credentials.

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

This API exposes 1 operation across 1 path, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

1 operations 1 paths 41 schemas 1 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/inventory/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Cisco Crosswork Get Credentials 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 1

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

Get Credentials 1
POST
/v1/credentials/query
Retrieves credentials. Filter structure (RobotNodeData) would be supplied as a field in the structure RobotNodeGetReq, which is used to call this function.
body → 200404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are robotapiRobotNodeData (23 properties), robotapiRobotProviderData (12 properties), robotapiRobotNodeProductInfo (11 properties), robotapiRobotNodeGeoData (9 properties). Each schema is shown below with its type and property counts.

robotapiRobotNodeTag
object
Device Tag Object
5 properties
robotapiRobotSnmpV2
object
SNMPv2 credential information
2 properties
robotapiRobotTransport
object
7 properties
robotapiRobotRoutinginfo
object
7 properties
robotapiRobotNodeGeoData
object
9 properties
robotapiRobotFilterData
object
Request body with filter options
6 properties
robotapiSupportedModels
object
2 properties
robotapiRobotInetAddr
object
Inet Address
3 properties
robotapiRobotNodeAdminState
string
Configured state for a Device. This is set during onboarding and can be updated as needed.
robotapiRobotEntityLockState
string
A device can be locked, by an app, to prevent other apps from using it. Various possible Lock states .
robotapiRobotNodeCustomProvider
object
Node to Provider mapping data.
3 properties
robotapiRobotUserPass
object
5 properties
robotapiTelemetryTransportType
string
robotapiRobotUserPassType
string
Connectivity types for robot micro-services
robotapiRobotSnmpV3AuthType
string
robotapiRobotNodeGetReq
object
Node Data request
5 properties
robotapiRobotSnmpV3
object
SNMPv3 Credential information
6 properties
robotapiRobotNodeOperationalState
string
Derived state for a Device. Cannot be set by user
robotapiRobotNodeCapability
string
Capabilities supported by Device
robotapiState
string
robotapiRobotSnmpV3SecurityLevel
string
robotapiRobotProviderFamily
string
Provider Family types
robotapiRobotProviderData
object
12 properties
robotapiRobotNodeStateElement
string
robotapiRobotSnmpV3PrivType
string
robotapiRobotNodeType
string
- NODETYPEUNKNOWN: Not known - NODETYPEROUTER: Layer 3 router - NODETYPESWITCH: Layer 2 ethernet switch - NODETYPEROADM: Layer 1 optical add/drop device - NODE…
robotapiRobotGeoCoordinates
object
Node Geographical location data
3 properties
robotapiRobotNodeProductInfo
object
11 properties
robotapiRobotEntityConnectivityState
string
Derived reachability state for a device. Cannot be set by user
robotapiRobotReachCheck
string
Flag to turn on or turn opff Reachability Check
robotapiRobotProviderDeviceKey
string
Key types used for generating UUID for Provider
robotapiRobotUserPassEnable
string
- ROBOTUSERPASSENENABLE: enables second level authentication in devices where is feature is available. For e.g. Cisco IOS XE devices. When this option is selec…
robotapiRobotInetAddressFamily
string
Inet Address Family
robotapiTelemetryDeviceEncoding
string
robotapiCurrentState
object
5 properties
robotapiRobotNodeLockStatus
object
5 properties
robotapiRobotNodeData
object
23 properties
robotapiRobotNodeCredGetResp
object
Get Credentials Response Body
2 properties
robotapiRobotTransportType
string
Transport types for robot micro-services
robotapiRobotNodeCredentials
object
Node credentials data
4 properties
robotapiRobotProviderType
string
Provider types

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-get-credentials-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 Get Credentials 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.