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 Catalyst Center Preview Deploy API

APIs to preview, approve, and cancel (discard) ICAP provisioning intents.

Cisco Catalyst Center Preview Deploy API is one of 30 APIs that Cisco Catalyst Center publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include preview-deploy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

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

Requests are made against a single base URL, https://developer.cisco.com.

7 operations 6 paths 19 schemas 1 DELETE2 GET4 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://{catalyst-center-host}/dna/intent/api/v1
Terms of Service
Resource Areas
1

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

preview-deploy 7

APIs to preview, approve, and cancel (discard) ICAP provisioning intents.

POST
/dna/intent/api/v1/icapSettings/configurationModels
Creates an ICAP configuration intent for preview-approve.
postConfigurationModel 1 param body → 202204206400401403404409
POST
/dna/intent/api/v1/icapSettings/configurationModels/{id}/deleteDeploy
Creates a ICAP configuration workflow for ICAP intent to remove the ICAP configuration on the device.
deleteIcapConfigurationModel 1 param → 202204206400401403404409
GET
/dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/networkDeviceStatusDetails
Get ICAP configuration status per network device.
getConfigurationModelNetworkDeviceStatusDetails 1 param → 200204206400401403404409
GET
/dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/networkDevices/{networkDeviceId}/config
Retrieves the device's CLIs of the ICAP intent.
getDeviceConfigurationModelNetworkDeviceConfig 2 params → 200204206400401403404409
POST
/dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/networkDevices/{networkDeviceId}/config
Generates the device's CLIs of the ICAP configuration intent.
postConfigurationModelNetworkDeviceConfig 2 params → 202204206400401403404409
DELETE
/dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}
Discards the ICAP configuration intent by activity ID.
deleteConfigurationModel 1 param → 202204206400401403404409
POST
/dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/deploy
Deploys the ICAP configuration intent by activity ID.
postConfigurationModelDeploy 1 param → 202204206400401403404409

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are PacketCaptureDeployInfoItem (18 properties), PreviewItem (4 properties), Preview (3 properties), ErrorResponse_response (3 properties). Each schema is shown below with its type and property counts.

NetworkDeviceId
string
Id of the device
DeviceStatus
string
Device status: 'NOTSTARTED' - provisioning has not started on this device 'SUCCESS' - provisioning has completed with a success 'FAILED' - provisioning has com…
TaskResponse
object
Contains information about a task to track the status of an asynchronous operation.
2 properties
ErrorResponse_response
object
3 properties
PreviewDeviceStatusDetailsListResponse
object
2 properties
PreviewDeviceStatusDetailsList
array
list of PreviewDeviceStatusDetail objects
PacketCaptureDeployInfoItem
object
A common definition of an ICAP configuration. It depends on the value in type that certain field values in an ICAP configuration could be null (not applicable).
18 properties 2 required
PreviewItem
object
4 properties
PacketCaptureDeployInfoList
array
A list of ICAP configuration intents
ErrorResponse
object
Contains information explaining the error that occured processing this request.
2 properties
TaskResponse_response
object
2 properties
inline_response_202
PreviewGenerationStatus
string
Preview generation status: 'Not Started' - preview generation has not started 'In Progress' - preview generation is in progress 'Success' - preview generation…
EpochMilliseconds
integer
A date and time represented as milliseconds since the Unix epoch.
inline_response_202_1
PreviewItems
array
PreviewDeviceStatusDetail
object
status for device configuration preview
2 properties
Preview
object
3 properties
PreviewListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-catalyst-center-preview-deploy-api-openapi.yml Raw ↑

Other APIs Cisco Catalyst Center publishes across the network.

Cisco Catalyst Center MCP Server
Cisco Catalyst Center AAA Services API
Cisco Catalyst Center Application Health Score Definitions API
Cisco Catalyst Center Assurance Events API
Cisco Catalyst Center Assurance Tasks API
Cisco Catalyst Center Clients API
Cisco Catalyst Center Custom Issue Definitions API
Cisco Catalyst Center DHCP Services API
Cisco Catalyst Center Direct Deploy API
Cisco Catalyst Center DNS Services API
Cisco Catalyst Center Energy API
Cisco Catalyst Center Fabric Site Health Summaries API
Where this information came from

This is an independent, third-party profile of Cisco Catalyst Center Preview Deploy 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.