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

The cwztpdevice API from Cisco Crosswork — 8 operation(s) for cwztpdevice.

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

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

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

11 operations 8 paths 18 schemas 1 DELETE1 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 1 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

cwztpdevice 11
DELETE
/v1/devices
Delete the bulk of devices from ZTP. Pass UUID of each device, to identify which devices to delete. Devices with valid UUIDs will be deleted Response message will give information about devices which…
DeleteDevice body → 200
POST
/v1/devices
PostDevices API Add the bulk of Ztp devices. Either all Ztp devices would be added or none. Request Body: ZtpDeviceList - Mandatory: Valid "Host Name"/"Serial Number"/"Credential Profile", to add a d…
SetDevices body → 200
PUT
/v1/devices
Update the device, if the device status is in unprovisioned status. Request Body: ZtpDevice - Mandatory: Valid "Host Name"/"Serial Number"/"uuid", to update device Response Body: ZtpDeviceResponse DE…
UpdateDevice body → 200
PATCH
/v1/devices
Update the device ,if the device status is in inprogress/provisioned/provisioningError/onboardingError status. Request Body: ZtpDevice - Mandatory: Valid "Serial Number"/"uuid", to update device stat…
UpdateDeviceStatus body → 200
POST
/v1/devices/csvtemplate
get the device headers with sample data in csv Request Body: ZtpDevice.Pass empty device like "{}" Response Body: ZtpDeviceResponse
ZtpsampleService body → 200
POST
/v1/devices/export
ztp devices Export API.Export List of ztp devices in csv form. Request Body: ZtpDeviceExportReq.pass list of deviceids to export specific devices,pass empty device list to export all devices. Respons…
ExportDevice body → 200
POST
/v1/devices/import
Import csv to add devices in bulk. Request Body: ZtpImport contains encode base64 content of csv. Response Body: ZtpDeviceResponse DEPRECATED Attribute : providerDeviceKey
ImportDevices body → 200
POST
/v1/devices/policies/query
Get DevicePolices API Retrieves a list of policies that apply on ztp devices. Request Body: ZtpDevicePolicyRequest.Pass empty device like "{}" Response Body: ZtpDevicePolicyResponse
GetDevicesPolicies body → 200
POST
/v1/devices/query
GetDevices API Retrieves a list of devices. This api returns complete data for each device.filters can be applied to retrieve specific sets of devices by specifying one or more fields to match. User…
GetDevices body → 200
POST
/v1/onboarding
Onboarding API For onboarding of individual Device from ZTP to DLM on ztp process provisioned Request Body: ZtpDevice - Mandatory: Valid "Serial Number"/"uuid"/"Host Name", to onboard ztp device to D…
OnboardDevice body → 200
POST
/v1/query/count
Get the total number of devices, profiles and devices with respective status. Pass an empty device like \"{}\". Request Body: ZtpDevice. Response Body: ZtpCountResponse.
GetZtpCount body → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are cwztpsvcZtpDevice_2 (29 properties), cwztpsvcZtpDevice (23 properties), cwztpsvcZtpFilterData (7 properties), cwztpsvcSecureZtpInfo (7 properties). Each schema is shown below with its type and property counts.

cwztpsvcZtpDeviceRequest
object
5 properties
cwztpsvcZtpImport
object
2 properties
cwztpsvcZtpDevice
object
23 properties
cwztpsvcSecureZtpInfo
object
7 properties
cwztpsvcZtpDevicePolicyRequest
object
5 properties
cwztpsvcProviderInfo_2
object
2 properties
cwztpsvcZtpDeviceResponse
object
4 properties
cwztpsvcZtpDeviceList
object
1 property
cwztpsvcZtpDevicePolicy
object
4 properties
cwztpsvcZtpDevicePolicyResponse
object
3 properties
cwztpsvcConnectivityDetail
object
4 properties
cwztpsvcZtpDevice_2
object
29 properties
cwztpsvcZtpDeviceExportReq
object
1 property
cwztpsvcZtpCountResponse
object
6 properties
cwztpsvcZtpInetAddr
object
4 properties
cwztpsvcConnectivityDetail_2
object
4 properties
cwztpsvcZtpFilterData
object
7 properties
cwztpsvcProviderInfo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-crosswork-cwztpdevice-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 Cwztpdevice 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.