API Changelog
The following sections describe API changes in each release of Nexus Dashboard Orchestrator.
Release 4.0.2 (2022-08-23)
For additional information about the release, see the Release Notes.
What's New
GET /mso/api/v1/status/schema/{schemaId}/template/{templateName}
status of execution for a template in a schema
GET /mso/api/v1/version
List all version
POST /mso/api/v1/version
set the current running version
GET /mso/api/v1/schemas/{schemaId}/version
Get Updated Version
GET /mso/api/v1/tenants/schemas
Get Schemas for all Tenants
GET /mso/api/v1/tenants
Get All Tenants
POST /mso/api/v1/tenants
Create Tenants
GET /mso/api/v1/schemas/allowed-tenants
Get All Tenants
GET /mso/api/v1/schemas/tenants
Get All Associated Tenants
GET /mso/api/v1/schemas/{schemaId}/tenants
Get Associated Tenants Per Schema
GET /mso/api/v1/tenants/{tenantId}
Get Tenant
PUT /mso/api/v1/tenants/{tenantId}
Update Tenant
DELETE /mso/api/v1/tenants/{tenantId}
Delete Tenant
PATCH /mso/api/v1/tenants/{tenantId}
updateTenant
GET /mso/api/v1/templates/{templateId}/versions/status
Get Template Status
GET /mso/api/v1/templates/{templateId}/versions/{versionNum}
Get Template Version
PUT /mso/api/v1/templates/{templateId}/versions/{versionNum}/updateStatus
Update Template Status
PUT /mso/api/v1/templates/{templateId}/versions/{versionNum}/tag
Update Template Tag
DELETE /mso/api/v1/templates/{templateId}/versions
Delete All Template Versions
GET /mso/api/v1/templates/summaries
Get Tenant/Fabric Resource/Fabric Policy Templates Summary
GET /mso/api/v1/templates/{templateId}/versions/list
Get Template Versions History
POST /mso/api/v1/templates
Create Tenant/Fabric Resource/Fabric Policy Template
GET /mso/api/v1/templates/{templateId}
Get Tenant/Fabric Resource/Fabric Policy Template
PUT /mso/api/v1/templates/{templateId}
Update Tenant/Fabric Resource/Fabric Policy Template
DELETE /mso/api/v1/templates/{templateId}
Delete Tenant/Fabric Resource/Fabric Policy Template
GET /mso/api/v1/tenants/{tenantId}/templates
Get Templates per Tenant
GET /mso/api/v1/templates/{templateId}/clone
Clone a Template
GET /mso/api/v1/tenants/allowed-sites
Get Allowed Sites
GET /mso/api/v1/schemas/allowed-sites
Get Allowed Sites
GET /mso/api/v1/templates/templatesOnSite
Get Templates Per Site
GET /mso/api/v1/templates/templatesOnSite/{siteId}
Get Templates By Site
GET /mso/api/v1/schemas/{schemaId}/status
Get Site Status
GET /mso/api/v1/schemas/{schemaId}/sites
Get Associated Sites Per Schema
GET /mso/api/v1/schemas/sites
Get All Associated Sites
GET /mso/api/v1/schemas
Get all Schemas
POST /mso/api/v1/schemas
Create Schema
GET /mso/api/v1/schemas/templates-on-site/{siteId}
Get All Templates On Site
POST /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}/templates/{templateName}/schema/{schemaId}
Import given list of policies into schema
GET /mso/api/v1/schemas/{schemaId}
Get Schema
PUT /mso/api/v1/schemas/{schemaId}
Update Schema
DELETE /mso/api/v1/schemas/{schemaId}
Delete Schema
PATCH /mso/api/v1/schemas/{schemaId}
Patch Schema
GET /mso/api/v1/schemas/list-identity
List Identity
GET /mso/api/v1/schemas/{schemaId}/relations/
Get Relations
GET /mso/api/v1/schemas/search-policies
Get Policy Names
GET /mso/api/v1/schemas/search-policies-all-tenants
Get Policy Names For All Tenants
GET /mso/api/v1/templates/{templateId}/policyStates
Get Policy States
GET /mso/api/v1/templates/{templateId}/policyDelta
Get Policy Delta
POST /mso/api/v1/migrate/schema/{schemaId}/template/{templateName}
Migrate Objects from a Source Template to a Destination Template
GET /mso/api/v1/schemas/is-site-in-use/{siteId}
Is Site In Use
GET /mso/api/v1/newimport/sites/{siteId}/schemas/{schemaId}/templates/{templateName}
Get policies of a schema template from site
GET /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}/templates/{templateName}
Get policies of template in tenant on Apic
GET /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}
Get policy names of tenant
GET /mso/api/v1/schemas/{schemaId}/deploymentSummary
Get Deployment Summary
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/l3-outs
ListL3Outs based on Site Id and Tenant Name
GET /mso/api/v1/sites/{id}/aci/tenants
List Tenants based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/{type}/regions/{regionName}/zones
List Cloud Region Zones
GET /mso/api/v1/sites/{id}/aci/security-domains
List Security Domains based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes/routerid
List RouterIds
GET /mso/api/v1/sites/{id}/aci/infra/regionConfig
List Region Config pulled from Infra Tenant
GET /mso/api/v1/sites/{id}/aci/cloud/{type}/regions/{name}/zones
List Cloud Region Zones
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/redirect-policies
List Redirect Policies based on Site Id, Tenant names
GET /mso/api/v1/aci/sites/{id}/pods
List Fabric Pods based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes
List Nodes based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/listener-certificates
List Listener Certificates of a Tenant of a Schema
GET /mso/api/v1/sites/{id}/aci/domains/{domName}/enhancedLagPolicies
List Enhanced Lag policies based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes/interfaces
List Node Interfaces based on Site Id
GET /mso/api/v1/sites/{id}/aci/domains
List Domains based on Site Id and Domain type
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/devices
List Devices based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/devices/{deviceName}/interfaces
List Devices Interfaces based on Site Id, Tenant name and Device name
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/devices
List Cloud Devices based on Site Id
GET /mso/api/v1/sites/{id}/aci/cloud-accounts
List Cloud Accounts based on Site Id [Only for cloud Sites
GET /mso/api/v1/sites/{id}/aci/cloud/{type}/regions/zones
List All zones in a Cloud Region
GET /mso/api/v2/sites/
All Site Info
GET /mso/api/v2/sites/{id}
Site Info
PUT /mso/api/v2/sites/anycastteppool
Anycast TepPool update
POST /mso/api/v2/sites/manage
Manage Sites
DELETE /mso/api/v2/sites/manage/{id}
Unmanage sites
GET /mso/api/v1/sites
Get list of all the Sites
GET /mso/api/v1/sites/allowed-labels
Get list of all the allowed Labels
GET /mso/api/v1/sites/audit-records
Get all Audit Records
GET /mso/api/v1/sites/audit-records/users
Get all Audit Users
GET /mso/api/v1/sites/srEnabledSites
Get all SR-enabled Sites
GET /mso/api/v1/sites/srL3outLabels/{Id}
Get all SrL3OutLabels
GET /mso/api/v1/sites/sync-version
Update all Sites APIC-Version
GET /mso/api/v1/sites/{id}
Get details of a Site
PUT /mso/api/v1/sites/{id}/apic-version
Update Apic Version
GET /mso/api/v1/sites/{id}/audit-records
Get all Audit Records by Site
GET /mso/api/v1/sites/{id}/audit-records/users
Get all Audit Users by Site
GET /mso/api/v1/sites/{id}/inuse
Get if a Site is in use
GET /mso/api/v1/sites/{id}/labels
Get labels based on Site Id
GET /mso/api/v2/sites/tunnelmgmt/report
Get tunnel management subnet usage report
GET /mso/api/v2/sites/fabric-connectivity
FabricConnectivity get all API
PUT /mso/api/v2/sites/fabric-connectivity
FabricConnectivity update API
GET /mso/api/v2/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
PUT /mso/api/v2/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /mso/api/v2/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v2/sites/{id}/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v1/sites/fabric-connectivity
FabricConnectivity get all API
PUT /mso/api/v1/sites/fabric-connectivity
FabricConnectivity update API
GET /mso/api/v1/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v1/sites/fabric-connectivity/audit-records
Audit Records
GET /mso/api/v1/sites/fabric-connectivity/audit-records/users
Audit Users
GET /mso/api/v1/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
GET /mso/api/v1/sites/{id}/fabric-connectivity/apic-version
Apic Version
GET /mso/api/v1/sites/{id}/fabric-connectivity/mpod-info
Mpod get API
PUT /mso/api/v1/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /mso/api/v1/ep/cloud-tunnel/debug/forcedClear
All configuration will be recreated and pushed to all registered cAPIC sites
GET /mso/api/v1/ep/cloud-tunnel/debug/report
Report information for every registered cAPIC site.
GET /mso/api/v1/ep/cloud-tunnel/debug/resync
Allows to push again all configuration to all registered cAPIC sites.
GET /mso/api/v1/ep/cloud-tunnel/debug/sites/tunnels
Get all site-to-site tunnels created by the cloud sync tool
GET /mso/api/v1/ep/cloud-tunnel/debug/sites/{id}
Get site information
GET /mso/api/v1/ep/cloud-tunnel/debug/subnet
Get subnets provided for all registered cAPIC sites. At this time there are 254 subnets per site.
GET /mso/api/v1/ep/cloud-tunnel/debug/subnet/interface
Get all interfaces provided fro all registered cAPIC sites.
GET /mso/api/v1/ep/cloud-tunnel/debug/tunnels
Get all tunnels between interfaces between cAPIC sites
GET /mso/api/v1/ep/cloud-tunnel/report
Get all site information.
GET /mso/api/v1/ep/cloud-tunnel/sites
Get list of all the EP tunnel sites
GET /mso/api/v1/ep/cloud-tunnel/version
Get the cloud sync tool internal version.
GET /mso/api/v1/ep/site/{id}/endpoint
Get details of all endpoints discovered on a site
GET /mso/api/v1/ep/tunnel/sites
Get list of all the EP tunnel sites
GET /mso/api/v1/ep/tunnel/{id}
Get details of a EP tunnel site
GET /mso/api/v2/sites/{id}/dcnm/nodes/interfaces
List Node Interfaces based on Site Id
GET /mso/api/v2/sites/{id}/dcnm/faults
List of faults based on Site Id
GET /mso/api/v2/sites/{id}/dcnm/nodes
List Nodes based on Site Id
GET /mso/api/v1/siteupgrade/health/readiness
get Site-Upgrade service readiness status
GET /mso/api/v1/siteupgrade/health/liveness
get Site-Upgrade service liveness status
GET /mso/api/v1/siteupgrade/notifications/sites/{site}
get unprocessed site notification for one site
PUT /mso/api/v1/siteupgrade/notifications/sites/{site}
notify site-upgrade service regarding changes made to site information
GET /mso/api/v1/siteupgrade/notifications/sites
get unprocessed site notifications for all sites
GET /mso/api/v1/siteupgrade/associated/sites/{site}
Get site association with site-upgrade policies
GET /mso/api/v1/siteupgrade/synchronize
Get all instances of SyncTrigger
POST /mso/api/v1/siteupgrade/synchronize
Create or update an instance SyncTrigger for user triggered sync
GET /mso/api/v1/siteupgrade/synchronize/{trigger}
Get an instance of SyncTrigger
GET /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Get an instance of NodeUpgradePolicy
PUT /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Create or update an instance of NodeUpgradePolicy
DELETE /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Delete an instance of NodeUpgradePolicy
GET /mso/api/v1/siteupgrade/nodes/policies
Get all NodeUpgradePolicy instances
POST /mso/api/v1/siteupgrade/nodes/policies
Create a new NodeUpgradePolicy
GET /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Get an instance of CtrlrUpgradePolicy
PUT /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Create or update an instance of CtrlrUpgradePolicy
DELETE /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Delete an instance of CtrlrUpgradePolicy
GET /mso/api/v1/siteupgrade/ctrlr/policies
Get all CtrlrUpgradePolicy instances
POST /mso/api/v1/siteupgrade/ctrlr/policies
Create a new CtrlrUpgradePolicy
GET /mso/api/v1/siteupgrade/inventory/hardware/summary/sites
Get an instance of ViewNodeSummariesTopLevel
GET /mso/api/v1/siteupgrade/inventory/hardware/summary/sites/{site}
Get an instance of ViewNodeSummariesTopLevel per site
GET /mso/api/v1/siteupgrade/inventory/hardware/sites/{site}/switches
Get an instance of ViewSiteListSwitches
GET /mso/api/v1/siteupgrade/inventory/hardware/sites/{site}/controllers
Get an instance of ViewSiteListControllers
GET /mso/api/v1/siteupgrade/inventory/firmware/sites/{site}
Get instances of ViewFirmwareFirmware from one site
GET /mso/api/v1/siteupgrade/inventory/firmware/sites
List all ViewFirmwareFirmware
POST /mso/api/v1/siteupgrade/inventory/firmware/sites/common
Get common ViewFirmwareFirmwareAttributes accross sites
GET /mso/api/v1/siteupgrade/inventory/downloadsdashboard/images/{image}
Get instances of ViewFirmwareDownloadDashboard for one image
GET /mso/api/v1/siteupgrade/inventory/downloadsdashboard/images
Get instances of ViewFirmwareDownloadDashboard for all images
GET /mso/api/v1/siteupgrade/inventory/downloads/images/{image}
Get instances of ViewFirmwareDownload for one image from all sites
GET /mso/api/v1/siteupgrade/inventory/downloads/sites/{site}
Get instances of ViewFirmwareDownload for one site
GET /mso/api/v1/siteupgrade/inventory/downloads/sites
List all ViewFirmwareDownload
GET /mso/api/v1/siteupgrade/inventory/firmwareosource/sites/{site}
Get instances of ViewFirmwareOSource for one site
GET /mso/api/v1/siteupgrade/inventory/firmwareosource/sites
List all ViewFirmwareOSource
GET /mso/api/v1/siteupgrade/imagedownloads/{image}
Get an instance of ImageDownloadPolicy
PUT /mso/api/v1/siteupgrade/imagedownloads/{image}
Create or update an ImageDownloadPolicy
DELETE /mso/api/v1/siteupgrade/imagedownloads/{image}
Delete an instance of ImageDownloadPolicy
GET /mso/api/v1/siteupgrade/imagedownloads
List all ImageDownloadPolicy
POST /mso/api/v1/siteupgrade/imagedownloads
Create a new ImageDownloadPolicy
GET /mso/api/v1/deployments/templates/{templateId}/preview
Get template deploy preview of all sites
GET /mso/api/v1/deployments/templates/{templateId}/view
Get template deploy view all sites
GET /mso/api/v1/deploy/preview/schema/{schemaId}/template/{templateName}
Get template deploy preview of all sites
GET /mso/api/v1/deploy/view/schema/{schemaId}/template/{templateName}
Get template deploy view all sites
GET /mso/api/v1/deploy/status/schema/{schemaId}/template/{templateName}
Get template deploy status from all sites
GET /mso/api/v1/deployments/templates/{templateId}/status
Get template deploy status from all sites
GET /mso/api/v1/deployments
Get list of all template deployment tasks
POST /mso/api/v1/deployments
Create a new task to manage the deployment of a template
GET /mso/api/v1/deployments/{deployId}
Get status of single template deployment task
DELETE /mso/api/v1/deployments/{deployId}
Delete a queued template deployment operation
GET /mso/api/v1/audit-records
Get filtered AuditRecords
POST /mso/api/v1/audit-records
Insert audit record(s)
GET /mso/api/v1/audit-records/users
Get users that produced audit records associated with specified key and/or AuditRecordType
GET /mso/api/v1/audit-records/download
Download audit records in Json or CSV
GET /mso/api/v1/audit-records/count
Get total number of AuditRecords
GET /mso/api/v1/audit-records/{id}
Get an AuditRecord by id
GET /mso/api/v1/audit-records/schema/{id}/summary
Get schema summary by schema id
GET /mso/api/v1/cloudsec/sites/{siteId}/operstate
Get cloudsec operational state
GET /mso/api/v1/health/schemas/{schemaId}/health
Sync schema health
GET /mso/api/v1/health/schemas/{schemaId}/faults
Sync schema faults
GET /mso/api/v1/health/tenants/{tenantId}/health
Sync tenant health
GET /mso/api/v1/health/schemas/syncAll
Sync all schemas health
DELETE /mso/api/v1/health/schemas/{schemaId}
Delete schema health & faults
What's Deleted
GET /api/v1/status/schema/{schemaId}/template/{templateName}
status of execution for a template in a schema
GET /api/v1/version
List all version
POST /api/v1/version
set the current running version
GET /api/v1/schemas/search-policies
Search schema policy names.
GET /api/v1/schemas/search-policies-all-tenants
Get names of policies in all tenants
GET /api/v1/schemas/heatmap-search-policies/{query}
Search for heatmap policy names
GET /api/v1/schemas/allowed-tenants
Get allowed tenants
GET /api/v1/schemas/list-identity
Get all schemas (with pruned information)
GET /api/v1/schemas/{id}/tenants
Get associated Tenants with Schema
GET /api/v1/schemas/tenants
Get all associated tenants
GET /api/v1/schemas/audit-records
Get audit records related to schemas
GET /api/v1/schemas/audit-records/users
Get users that made actions related to schemas
GET /api/v1/schemas/{id}/audit-records
Get audit records related to a specific schema
GET /api/v1/schemas/{id}/audit-records/users
Get audit users that made actions related to a specific schema
GET /api/v1/schemas/service-graphs
Get service graphs
GET /api/v1/schemas/service-node-types
List the service node types
POST /api/v1/schemas/service-node-types
Insert service node type
DELETE /api/v1/schemas/service-node-types/{id}
Delete service node type
GET /api/v1/schemas/syncExtSubnets
Sync the external subnets
GET /api/v1/schemas
Get list of schemas (with all information)
POST /api/v1/schemas
Create new schema
GET /api/v1/schemas/{id}
Get details of schema by id
PUT /api/v1/schemas/{id}
Update schema with id
DELETE /api/v1/schemas/{id}
Delete schema
PATCH /api/v1/schemas/{id}
Patch schema
GET /api/v1/schemas/{id}/version
Get update version (number of times schema updated) of schema by schema id
PUT /api/v1/schemas/static-path/{id}
Patch schema
GET /api/v1/schemas/{id}/validate
check if schema is valid
GET /api/v1/schemas/{id}/health
Get policy health faults with schema id
GET /api/v1/schemas/{id}/faults
Get site policy faults with schema id
GET /api/v1/schemas/{id}/health-faults
Get site health faults with schema id
GET /api/v1/schemas/{id}/status
Get site status with schema id
GET /api/v1/schemas/{id}/relations
Get relationships between schema policies in schema
GET /api/v1/schemas/{id}/associations
Get associations of policies in schema
GET /api/v1/schemas/{id}/references
Get policy references in schema
GET /api/v1/schemas/{id}/policy-states
Get policy states in schema
GET /api/v1/schemas/{id}/policy-delta
Get policy object delta
POST /api/v1/schemas/{id}/template-delta/{templateName}
Get deltas for all policies in a template
POST /api/v1/schemas/{id}/templates/{templateName}/verify
Verify schema
GET /api/v1/schemas/{id}/warn
Get schema warnings
GET /api/v1/schemas/{siteId}/srL3out/{srL3outName}
Get all the schemas that are associated to the srL3out
GET /api/v1/schemas/site/{siteId}/externalVRF
Get if site is in use a schema
GET /api/v1/schemas/is-site-in-use/{siteId}
Get external VRF's (ie transport VRF's) in a schema
GET /api/v1/schemas/is-external-vrf-in-use/{vrfName}
Get all templates on site
GET /api/v1/schemas/{id}/templates/{templateName}/hostedVrfs
Get external Vrf is in use in site service
GET /api/v1/schemas/{id}/templates/{templateName}/subnetsForRouteLeak/{vrfName}
Get hosted vrfs in a template under schema
GET /api/v1/schemas/site/{siteId}/subnetGroupsforRegion
Get hosted vrf subnets for route leak
GET /api/v1/schemas/templates-on-site/{siteId}
Get subnetGroups for region
GET /api/v1/schemas/{schemaId}/deploymentSummary
Get summary of deployments of templates
GET /api/v1/schemas/site/{siteId}/subnetsWithPrivateLinkLabel
Get all CIDR subnets with private link labels
GET /api/v1/schemas/{id}/templates/{templateName}/site/{siteId}/vrfsWithCtxProfiles
Get all VRFs with context profile
GET /api/v1/schemas/{id}/templates/{templateName}/site/{siteId}/vrf/{vrfName}/cloudCtxProfile
Get all the cloud content profiles
GET /api/v1/schemas/tenant/{tenantId}/site/{siteId}/epgsWithPrivateLinkLabel
Get all the EPGs with private link labels
GET /api/v1/schemas/{id}/templates/{templateName}/vrfs/{vrfName}
Get VRF
GET /api/v1/schemas/{id}/templates/{templateName}/bds/{bdName}
Get BD
GET /api/v1/schemas/{id}/templates/{templateName}/anps/{anpName}/epgs/{epgName}
Get all EPGs
GET /api/v1/schemas/{id}/templates/{templateName}/externalEpgs/{externalEpgName}
Get all external EPG
GET /api/v1/schemas/policy/usage/{policyName}/{tenantId}
Get usage of all DHCP policies
GET /api/v1/schemas/policy/details/{policyName}/{tenantId}
Get BDs with specific DHCP policy
GET /api/v1/tenants/allowed-users
Get users that are allowed to interact with templates
GET /api/v1/tenants/allowed-users/domains
Get user domains that allowed to interact with templates
GET /api/v1/tenants/schemas
Get schemas on tenants
GET /api/v1/tenants
Get all tenants
POST /api/v1/tenants
Insert new tenant
GET /api/v1/tenants/{tenantName}/site/{siteId}
Get cloud account from cAPIC for a tenant
GET /api/v1/tenants/site/{siteId}/gatewayRouter
Get all gateway routers on site
GET /api/v1/tenants/master-org-account-sites
Get names of all AWS cAPICs with master cloud account
GET /api/v1/tenants/audit-records
Get audit records related to tenants
GET /api/v1/tenants/audit-records/users
Get users that made actions related to tenants
GET /api/v1/tenants/{id}/audit-records
Get audit records related to a specific tenant
GET /api/v1/tenants/{id}/audit-records/users
Get audit users that made actions related to a specific tenant
GET /api/v1/tenants/{id}
Get details of tenant
PUT /api/v1/tenants/{id}
Update tenant
DELETE /api/v1/tenants/{id}
Delete tenant
PATCH /api/v1/tenants/{id}
Patch tenant
GET /api/v1/tenants/{id}/schemas
Get schemas on a tenant
GET /api/v1/tenants/{id}/infra
Get infra details from tenant
PUT /api/v1/tenants/{id}/infra
Update infra details from tenant id
GET /api/v1/tenants/{id}/config-faults
Get configuration faults of a tenant
GET /api/v1/tenants/is-site-in-use/{siteId}
Is site in use by some tenant
GET /api/v1/import/sites/{siteId}/tenants/{tenantId}/templates/{templateName}
Import template. New import api docs can be found via MSO homepage or https://
/mso/docs/schema-service
POST /api/v1/migrate/schema/{schemaId}/template/{templateName}
Migrate template objects
GET /api/v1/schemas/deployed-template/{schemaId}/template/{templateName}/site/{siteId}
Get DeployedTemplate for specified schema, template and site
GET /api/v2/schemas/{id}/policy-delta
Get policy object delta
GET /api/v1/schemas/{schemaId}/template/{templateName}
Get Template References (list of all templates being refernced in current template)
POST /api/v1/schemas/{schemaId}/template/{templateName}/restoreTemplateVersion
Restore Template Version
GET /api/v1/versions/list/schemas/{schemaId}/template/{templateName}
Get Template History (list of all template versions of this template)
GET /api/v1/versions/status/schemas/{schemaId}/template/{templateName}
Get latest Template version status
GET /api/v1/versions/{versionId}
Get Template version by Id
GET /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}
Get Template version by number
PUT /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}/updateStatus
Update Template version change status
PUT /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}/tag
Tag Template version
DELETE /api/v1/versions/schemas/{schemaId}/template/{templateName}
Bulk Delete template versions
GET /api/v1/sites/{id}/aci/tenants/{name}/l3-outs
ListL3Outs based on Site Id and Tenant Name
GET /api/v1/sites/{id}/aci/tenants
List Tenants based on Site Id
GET /api/v1/sites/{id}/aci/security-domains
List Security Domains based on Site Id
GET /api/v1/aci/sites/{id}/nodes/routerid
List RouterIds
GET /api/v1/sites/{id}/aci/infra/regionConfig
List Region Config pulled from Infra Tenant
GET /api/v1/sites/{id}/aci/cloud/{type}/regions/{name}/zones
List Cloud Region Zones
GET /api/v1/sites/{id}/aci/tenants/{name}/redirect-policies
List Redirect Policies based on Site Id, Tenant names
GET /api/v1/aci/sites/{id}/pods
List Fabric Pods based on Site Id
GET /api/v1/aci/sites/{id}/nodes
List Nodes based on Site Id
GET /api/v1/sites/{id}/aci/tenants/{name}/cloud/listener-certificates
List Listener Certificates of a Tenant of a Schema
GET /api/v1/sites/{id}/aci/domains/{domName}/enhancedLagPolicies
List Enhanced Lag policies based on Site Id
GET /api/v1/aci/sites/{id}/nodes/interfaces
List Node Interfaces based on Site Id
GET /api/v1/sites/{id}/aci/domains
List Domains based on Site Id and Domain type
GET /api/v1/sites/{id}/aci/tenants/{name}/devices
List Devices based on Site Id
GET /api/v1/sites/{id}/aci/tenants/{name}/devices/{deviceName}/interfaces
List Devices Interfaces based on Site Id, Tenant name and Device name
GET /api/v1/sites/{id}/aci/tenants/{name}/cloud/devices
List Cloud Devices based on Site Id
GET /api/v1/sites/{id}/aci/cloud-accounts
List Cloud Accounts based on Site Id [Only for cloud Sites
GET /api/v1/sites/{id}/aci/cloud/{type}/regions/zones
List All zones in a Cloud Region
GET /api/v2/sites/
All Site Info
GET /api/v2/sites/{id}
Site Info
PUT /api/v2/sites/anycastteppool
Anycast TepPool update
POST /api/v2/sites/manage
Manage Sites
DELETE /api/v2/sites/manage/{id}
Unmanage sites
GET /api/v1/sites
Get list of all the Sites
GET /api/v1/sites/allowed-labels
Get list of all the allowed Labels
GET /api/v1/sites/audit-records
Get all Audit Records
GET /api/v1/sites/audit-records/users
Get all Audit Users
GET /api/v1/sites/srEnabledSites
Get all SR-enabled Sites
GET /api/v1/sites/srL3outLabels/{Id}
Get all SrL3OutLabels
GET /api/v1/sites/sync-version
Update all Sites APIC-Version
GET /api/v1/sites/{id}
Get details of a Site
PUT /api/v1/sites/{id}/apic-version
Update Apic Version
GET /api/v1/sites/{id}/audit-records
Get all Audit Records by Site
GET /api/v1/sites/{id}/audit-records/users
Get all Audit Users by Site
GET /api/v1/sites/{id}/inuse
Get if a Site is in use
GET /api/v1/sites/{id}/labels
Get labels based on Site Id
GET /api/v2/sites/tunnelmgmt/report
Get tunnel management subnet usage report
GET /api/v2/sites/fabric-connectivity
FabricConnectivity get all API
PUT /api/v2/sites/fabric-connectivity
FabricConnectivity update API
GET /api/v2/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
PUT /api/v2/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /api/v2/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v2/sites/{id}/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v1/sites/fabric-connectivity
FabricConnectivity get all API
PUT /api/v1/sites/fabric-connectivity
FabricConnectivity update API
GET /api/v1/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v1/sites/fabric-connectivity/audit-records
Audit Records
GET /api/v1/sites/fabric-connectivity/audit-records/users
Audit Users
GET /api/v1/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
GET /api/v1/sites/{id}/fabric-connectivity/apic-version
Apic Version
GET /api/v1/sites/{id}/fabric-connectivity/mpod-info
Mpod get API
PUT /api/v1/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /api/v1/ep/cloud-tunnel/debug/forcedClear
All configuration will be recreated and pushed to all registered cAPIC sites
GET /api/v1/ep/cloud-tunnel/debug/report
Report information for every registered cAPIC site.
GET /api/v1/ep/cloud-tunnel/debug/resync
Allows to push again all configuration to all registered cAPIC sites.
GET /api/v1/ep/cloud-tunnel/debug/sites/tunnels
Get all site-to-site tunnels created by the cloud sync tool
GET /api/v1/ep/cloud-tunnel/debug/sites/{id}
Get site information
GET /api/v1/ep/cloud-tunnel/debug/subnet
Get subnets provided for all registered cAPIC sites. At this time there are 254 subnets per site.
GET /api/v1/ep/cloud-tunnel/debug/subnet/interface
Get all interfaces provided fro all registered cAPIC sites.
GET /api/v1/ep/cloud-tunnel/debug/tunnels
Get all tunnels between interfaces between cAPIC sites
GET /api/v1/ep/cloud-tunnel/report
Get all site information.
GET /api/v1/ep/cloud-tunnel/sites
Get list of all the EP tunnel sites
GET /api/v1/ep/cloud-tunnel/version
Get the cloud sync tool internal version.
GET /api/v1/ep/site/{id}/endpoint
Get details of all endpoints discovered on a site
GET /api/v1/ep/tunnel/sites
Get list of all the EP tunnel sites
GET /api/v1/ep/tunnel/{id}
Get details of a EP tunnel site
GET /api/v2/sites/{id}/dcnm/nodes/interfaces
List Node Interfaces based on Site Id
GET /api/v2/sites/{id}/dcnm/faults
List of faults based on Site Id
GET /api/v2/sites/{id}/dcnm/nodes
List Nodes based on Site Id
GET /api/v1/siteupgrade/health/readiness
get Site-Upgrade service readiness status
GET /api/v1/siteupgrade/health/liveness
get Site-Upgrade service liveness status
GET /api/v1/siteupgrade/notifications/sites/{site}
get unprocessed site notification for one site
PUT /api/v1/siteupgrade/notifications/sites/{site}
notify site-upgrade service regarding changes made to site information
GET /api/v1/siteupgrade/notifications/sites
get unprocessed site notifications for all sites
GET /api/v1/siteupgrade/associated/sites/{site}
Get site association with site-upgrade policies
GET /api/v1/siteupgrade/synchronize
Get all instances of SyncTrigger
POST /api/v1/siteupgrade/synchronize
Create or update an instance SyncTrigger for user triggered sync
GET /api/v1/siteupgrade/synchronize/{trigger}
Get an instance of SyncTrigger
GET /api/v1/siteupgrade/nodes/policies/{policyName}
Get an instance of NodeUpgradePolicy
PUT /api/v1/siteupgrade/nodes/policies/{policyName}
Create or update an instance of NodeUpgradePolicy
DELETE /api/v1/siteupgrade/nodes/policies/{policyName}
Delete an instance of NodeUpgradePolicy
GET /api/v1/siteupgrade/nodes/policies
Get all NodeUpgradePolicy instances
POST /api/v1/siteupgrade/nodes/policies
Create a new NodeUpgradePolicy
GET /api/v1/siteupgrade/ctrlr/policies/{policyName}
Get an instance of CtrlrUpgradePolicy
PUT /api/v1/siteupgrade/ctrlr/policies/{policyName}
Create or update an instance of CtrlrUpgradePolicy
DELETE /api/v1/siteupgrade/ctrlr/policies/{policyName}
Delete an instance of CtrlrUpgradePolicy
GET /api/v1/siteupgrade/ctrlr/policies
Get all CtrlrUpgradePolicy instances
POST /api/v1/siteupgrade/ctrlr/policies
Create a new CtrlrUpgradePolicy
GET /api/v1/siteupgrade/inventory/hardware/summary/sites
Get an instance of ViewNodeSummariesTopLevel
GET /api/v1/siteupgrade/inventory/hardware/summary/sites/{site}
Get an instance of ViewNodeSummariesTopLevel per site
GET /api/v1/siteupgrade/inventory/hardware/sites/{site}/switches
Get an instance of ViewSiteListSwitches
GET /api/v1/siteupgrade/inventory/hardware/sites/{site}/controllers
Get an instance of ViewSiteListControllers
GET /api/v1/siteupgrade/inventory/firmware/sites/{site}
Get instances of ViewFirmwareFirmware from one site
GET /api/v1/siteupgrade/inventory/firmware/sites
List all ViewFirmwareFirmware
POST /api/v1/siteupgrade/inventory/firmware/sites/common
Get common ViewFirmwareFirmwareAttributes accross sites
GET /api/v1/siteupgrade/inventory/downloadsdashboard/images/{image}
Get instances of ViewFirmwareDownloadDashboard for one image
GET /api/v1/siteupgrade/inventory/downloadsdashboard/images
Get instances of ViewFirmwareDownloadDashboard for all images
GET /api/v1/siteupgrade/inventory/downloads/images/{image}
Get instances of ViewFirmwareDownload for one image from all sites
GET /api/v1/siteupgrade/inventory/downloads/sites/{site}
Get instances of ViewFirmwareDownload for one site
GET /api/v1/siteupgrade/inventory/downloads/sites
List all ViewFirmwareDownload
GET /api/v1/siteupgrade/inventory/firmwareosource/sites/{site}
Get instances of ViewFirmwareOSource for one site
GET /api/v1/siteupgrade/inventory/firmwareosource/sites
List all ViewFirmwareOSource
GET /api/v1/siteupgrade/imagedownloads/{image}
Get an instance of ImageDownloadPolicy
PUT /api/v1/siteupgrade/imagedownloads/{image}
Create or update an ImageDownloadPolicy
DELETE /api/v1/siteupgrade/imagedownloads/{image}
Delete an instance of ImageDownloadPolicy
GET /api/v1/siteupgrade/imagedownloads
List all ImageDownloadPolicy
POST /api/v1/siteupgrade/imagedownloads
Create a new ImageDownloadPolicy
GET /api/v1/deploy/preview/schema/{schemaId}/template/{templateName}
Get template deploy preview of all sites
GET /api/v1/deploy/view/schema/{schemaId}/template/{templateName}
Get template deploy view all sites
GET /api/v1/deploy/status/schema/{schemaId}/template/{templateName}
Get template deploy status from all sites
GET /api/v1/task
Get list of all tasks
POST /api/v1/task
Create new task
GET /api/v1/task/{taskId}
Get status of single task
DELETE /api/v1/task/{taskId}
Delete a queued operation
GET /api/v1/audit-records
Get filtered AuditRecords
POST /api/v1/audit-records
Insert audit record(s)
GET /api/v1/audit-records/users
Get users that produced audit records associated with specified key and/or AuditRecordType
GET /api/v1/audit-records/download
Download audit records in Json or CSV
GET /api/v1/audit-records/count
Get total number of AuditRecords
GET /api/v1/audit-records/{id}
Get an AuditRecord by id
GET /api/v1/audit-records/schema/{id}/summary
Get schema summary by schema id
GET /api/v1/cloudsec/sites/{siteId}/operstate
Get cloudsec operational state
GET /api/v1/policies/usage
Get usage of all policies
GET /api/v1/policies/usage/{id}
Get usage of a policy by id of policy
GET /api/v1/policies/references
Get policy associations
GET /api/v1/policies/audit-records
Get audit records related to policies
GET /api/v1/policies/audit-records/users
Get users that made actions related to policies
GET /api/v1/policies/{id}/audit-records
Get audit records related to a specific policy
GET /api/v1/policies/{id}/audit-records/users
Get audit users that made actions related to a specific policy
GET /api/v1/policies
List policies
GET /api/v1/policies/dhcp/relay
Get DHCP relay policies
POST /api/v1/policies/dhcp/relay
Insert DHCP Relay Policy
GET /api/v1/policies/dhcp/option
Get DHCP option policies
POST /api/v1/policies/dhcp/option
Insert DHCP Option Policy
GET /api/v1/policies/dhcp/relay/{id}
Get details of DHCP relay policy by id
PUT /api/v1/policies/dhcp/relay/{id}
Update DHCP Policy by id
DELETE /api/v1/policies/dhcp/relay/{id}
Delete DHCP policy
GET /api/v1/policies/dhcp/option/{id}
Get details of a DHCP option location by id
PUT /api/v1/policies/dhcp/option/{id}
Update DHCP policy
DELETE /api/v1/policies/dhcp/option/{id}
Delete DHCP option policy
GET /api/v1/policies/routemap
Get all routemap policies
POST /api/v1/policies/routemap
Create new routemap policy
GET /api/v1/policies/routemap/{id}
Get details of a routemap policy by id
PUT /api/v1/policies/routemap/{id}
Update routemap policy by id
DELETE /api/v1/policies/routemap/{id}
Delete routemap policy by id
GET /api/v1/policies/qos
Get details of QOS policy
POST /api/v1/policies/qos
Create new QOS policy
GET /api/v1/policies/qos/{id}
Get details of a QOS policy by id
PUT /api/v1/policies/qos/{id}
Update QOS policy by id
DELETE /api/v1/policies/qos/{id}
Delete QOS policy
GET /api/v1/policies/bfd
Get details of a BFD policy by id
POST /api/v1/policies/bfd
Create BFD Policy
GET /api/v1/policies/mcast-routemap
Get all Multicast-Route Map Policies
POST /api/v1/policies/mcast-routemap
Create new Multicast-Route Map Policy
GET /api/v1/policies/mcast-routemap/{id}
Get details of Multicast-Route Map Policy
PUT /api/v1/policies/mcast-routemap/{id}
Update Multicast-Route Map Policy
DELETE /api/v1/policies/mcast-routemap/{id}
Delete Multicast-Route Map Policy
GET /api/v1/policies/dcnm-dhcp
Get details of a DCNM-DHCP policy based on id
POST /api/v1/policies/dcnm-dhcp
Create new DCNM-DHCP policy
GET /api/v1/policies/dcnm-dhcp/{id}
Get DCNM-DHCP policy by id
PUT /api/v1/policies/dcnm-dhcp/{id}
Update DCNM-DHCP policy by id
DELETE /api/v1/policies/dcnm-dhcp/{id}
Delete DCNM-DHCP policy
GET /api/v1/policies/dcnm-dhcp/{name}/tenantId/{tenantId}
Get DCNM-DHCP policy policy by name
GET /api/v1/policies/dcnm-policies
List all DCNM policies
POST /api/v1/policies/dcnm-policies
Create DCNM policy
DELETE /api/v1/policies/dcnm-policies/{id}
Delete DCNM policy
GET /api/v1/policies/dcnm-vrf-policy-names
Get all DCNM VRF Policy Names
GET /api/v1/policies/dcnm-vrf-extn-policy-names
Get all DCNM VRF Extn Policy Names
GET /api/v1/policies/dcnm-network-policy-names
Get all DCNM Network Policy Names
GET /api/v1/policies/dcnm-network-extn-policy-names
Get all DCNM Network Extn Policy Names
GET /api/v1/policies/sla
Get all SLA policies
GET /api/v1/policies/sla/{id}
Get SLA policy
GET /api/v1/policies/dscp-values
Get valid DSCP values
GET /api/v1/policies/dscp-cos
Get all DSCP class-cos translation policies (Global DSCP Policy)
PUT /api/v1/policies/dscp-cos
DSCP class-cos translation policies
GET /api/v1/policies/global-naming
List all Global Naming Policies
POST /api/v1/policies/global-naming
Create global naming policy
GET /api/v1/policies/global-naming/{id}
Get details of a Global Naming Policy by id
PUT /api/v1/policies/global-naming/{id}
Update Global Naming Policy
DELETE /api/v1/policies/global-naming/{id}
Delete Global Name Policy
GET /api/v1/policies/nsg-subnetLevel
Get all NSG at Subnet level Policies
POST /api/v1/policies/nsg-subnetLevel
Create NSG at Subnet level Policy
GET /api/v1/policies/nsg-subnetLevel/{id}
Get details of NSG at Subnet level Policy
PUT /api/v1/policies/nsg-subnetLevel/{id}
Update NSG at Subnet level Policy
DELETE /api/v1/policies/nsg-subnetLevel/{id}
Delete NSG at Subnet level Policy
GET /api/v1/health/schemas/{schemaId}/health
Sync schema health
GET /api/v1/health/schemas/{schemaId}/faults
Sync schema faults
GET /api/v1/health/tenants/{tenantId}/health
Sync tenant health
GET /api/v1/health/schemas/syncAll
Sync all schemas health
DELETE /api/v1/health/schemas/{schemaId}
Delete schema health & faults
Release 4.0.1 (2022-08-02)
For additional information about the release, see the Release Notes.
What's New
GET /mso/api/v1/status/schema/{schemaId}/template/{templateName}
status of execution for a template in a schema
GET /mso/api/v1/version
List all version
POST /mso/api/v1/version
set the current running version
GET /mso/api/v1/schemas/{schemaId}/version
Get Updated Version
GET /mso/api/v1/tenants/schemas
Get Schemas for all Tenants
GET /mso/api/v1/tenants
Get All Tenants
POST /mso/api/v1/tenants
Create Tenants
GET /mso/api/v1/schemas/allowed-tenants
Get All Tenants
GET /mso/api/v1/schemas/tenants
Get All Associated Tenants
GET /mso/api/v1/schemas/{schemaId}/tenants
Get Associated Tenants Per Schema
GET /mso/api/v1/tenants/{tenantId}
Get Tenant
PUT /mso/api/v1/tenants/{tenantId}
Update Tenant
DELETE /mso/api/v1/tenants/{tenantId}
Delete Tenant
PATCH /mso/api/v1/tenants/{tenantId}
updateTenant
GET /mso/api/v1/templates/{templateId}/versions/status
Get Template Status
GET /mso/api/v1/templates/{templateId}/versions/{versionNum}
Get Template Version
PUT /mso/api/v1/templates/{templateId}/versions/{versionNum}/updateStatus
Update Template Status
PUT /mso/api/v1/templates/{templateId}/versions/{versionNum}/tag
Update Template Tag
DELETE /mso/api/v1/templates/{templateId}/versions
Delete All Template Versions
GET /mso/api/v1/templates/summaries
Get Tenant/Fabric Resource/Fabric Policy Templates Summary
GET /mso/api/v1/templates/{templateId}/versions/list
Get Template Versions History
POST /mso/api/v1/templates
Create Tenant/Fabric Resource/Fabric Policy Template
GET /mso/api/v1/templates/{templateId}
Get Tenant/Fabric Resource/Fabric Policy Template
PUT /mso/api/v1/templates/{templateId}
Update Tenant/Fabric Resource/Fabric Policy Template
DELETE /mso/api/v1/templates/{templateId}
Delete Tenant/Fabric Resource/Fabric Policy Template
GET /mso/api/v1/tenants/{tenantId}/templates
Get Templates per Tenant
GET /mso/api/v1/templates/{templateId}/clone
Clone a Template
GET /mso/api/v1/tenants/allowed-sites
Get Allowed Sites
GET /mso/api/v1/schemas/allowed-sites
Get Allowed Sites
GET /mso/api/v1/templates/templatesOnSite
Get Templates Per Site
GET /mso/api/v1/templates/templatesOnSite/{siteId}
Get Templates By Site
GET /mso/api/v1/schemas/{schemaId}/status
Get Site Status
GET /mso/api/v1/schemas/{schemaId}/sites
Get Associated Sites Per Schema
GET /mso/api/v1/schemas/sites
Get All Associated Sites
GET /mso/api/v1/schemas
Get all Schemas
POST /mso/api/v1/schemas
Create Schema
GET /mso/api/v1/schemas/templates-on-site/{siteId}
Get All Templates On Site
POST /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}/templates/{templateName}/schema/{schemaId}
Import given list of policies into schema
GET /mso/api/v1/schemas/{schemaId}
Get Schema
PUT /mso/api/v1/schemas/{schemaId}
Update Schema
DELETE /mso/api/v1/schemas/{schemaId}
Delete Schema
PATCH /mso/api/v1/schemas/{schemaId}
Patch Schema
GET /mso/api/v1/schemas/list-identity
List Identity
GET /mso/api/v1/schemas/{schemaId}/relations/
Get Relations
GET /mso/api/v1/schemas/search-policies
Get Policy Names
GET /mso/api/v1/schemas/search-policies-all-tenants
Get Policy Names For All Tenants
GET /mso/api/v1/templates/{templateId}/policyStates
Get Policy States
GET /mso/api/v1/templates/{templateId}/policyDelta
Get Policy Delta
POST /mso/api/v1/migrate/schema/{schemaId}/template/{templateName}
Migrate Objects from a Source Template to a Destination Template
GET /mso/api/v1/schemas/is-site-in-use/{siteId}
Is Site In Use
GET /mso/api/v1/newimport/sites/{siteId}/schemas/{schemaId}/templates/{templateName}
Get policies of a schema template from site
GET /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}/templates/{templateName}
Get policies of template in tenant on Apic
GET /mso/api/v1/newimport/sites/{siteId}/tenants/{tenantId}
Get policy names of tenant
GET /mso/api/v1/schemas/{schemaId}/deploymentSummary
Get Deployment Summary
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/l3-outs
ListL3Outs based on Site Id and Tenant Name
GET /mso/api/v1/sites/{id}/aci/tenants
List Tenants based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/{type}/regions/{regionName}/zones
List Cloud Region Zones
GET /mso/api/v1/sites/{id}/aci/security-domains
List Security Domains based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes/routerid
List RouterIds
GET /mso/api/v1/sites/{id}/aci/infra/regionConfig
List Region Config pulled from Infra Tenant
GET /mso/api/v1/sites/{id}/aci/cloud/{type}/regions/{name}/zones
List Cloud Region Zones
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/redirect-policies
List Redirect Policies based on Site Id, Tenant names
GET /mso/api/v1/aci/sites/{id}/pods
List Fabric Pods based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes
List Nodes based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/listener-certificates
List Listener Certificates of a Tenant of a Schema
GET /mso/api/v1/sites/{id}/aci/domains/{domName}/enhancedLagPolicies
List Enhanced Lag policies based on Site Id
GET /mso/api/v1/aci/sites/{id}/nodes/interfaces
List Node Interfaces based on Site Id
GET /mso/api/v1/sites/{id}/aci/domains
List Domains based on Site Id and Domain type
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/devices
List Devices based on Site Id
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/devices/{deviceName}/interfaces
List Devices Interfaces based on Site Id, Tenant name and Device name
GET /mso/api/v1/sites/{id}/aci/tenants/{name}/cloud/devices
List Cloud Devices based on Site Id
GET /mso/api/v1/sites/{id}/aci/cloud-accounts
List Cloud Accounts based on Site Id [Only for cloud Sites
GET /mso/api/v1/sites/{id}/aci/cloud/{type}/regions/zones
List All zones in a Cloud Region
GET /mso/api/v2/sites/
All Site Info
GET /mso/api/v2/sites/{id}
Site Info
PUT /mso/api/v2/sites/anycastteppool
Anycast TepPool update
POST /mso/api/v2/sites/manage
Manage Sites
DELETE /mso/api/v2/sites/manage/{id}
Unmanage sites
GET /mso/api/v1/sites
Get list of all the Sites
GET /mso/api/v1/sites/allowed-labels
Get list of all the allowed Labels
GET /mso/api/v1/sites/audit-records
Get all Audit Records
GET /mso/api/v1/sites/audit-records/users
Get all Audit Users
GET /mso/api/v1/sites/srEnabledSites
Get all SR-enabled Sites
GET /mso/api/v1/sites/srL3outLabels/{Id}
Get all SrL3OutLabels
GET /mso/api/v1/sites/sync-version
Update all Sites APIC-Version
GET /mso/api/v1/sites/{id}
Get details of a Site
PUT /mso/api/v1/sites/{id}/apic-version
Update Apic Version
GET /mso/api/v1/sites/{id}/audit-records
Get all Audit Records by Site
GET /mso/api/v1/sites/{id}/audit-records/users
Get all Audit Users by Site
GET /mso/api/v1/sites/{id}/inuse
Get if a Site is in use
GET /mso/api/v1/sites/{id}/labels
Get labels based on Site Id
GET /mso/api/v2/sites/tunnelmgmt/report
Get tunnel management subnet usage report
GET /mso/api/v2/sites/fabric-connectivity
FabricConnectivity get all API
PUT /mso/api/v2/sites/fabric-connectivity
FabricConnectivity update API
GET /mso/api/v2/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
PUT /mso/api/v2/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /mso/api/v2/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v2/sites/{id}/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v1/sites/fabric-connectivity
FabricConnectivity get all API
PUT /mso/api/v1/sites/fabric-connectivity
FabricConnectivity update API
GET /mso/api/v1/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /mso/api/v1/sites/fabric-connectivity/audit-records
Audit Records
GET /mso/api/v1/sites/fabric-connectivity/audit-records/users
Audit Users
GET /mso/api/v1/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
GET /mso/api/v1/sites/{id}/fabric-connectivity/apic-version
Apic Version
GET /mso/api/v1/sites/{id}/fabric-connectivity/mpod-info
Mpod get API
PUT /mso/api/v1/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /mso/api/v1/ep/cloud-tunnel/debug/forcedClear
All configuration will be recreated and pushed to all registered cAPIC sites
GET /mso/api/v1/ep/cloud-tunnel/debug/report
Report information for every registered cAPIC site.
GET /mso/api/v1/ep/cloud-tunnel/debug/resync
Allows to push again all configuration to all registered cAPIC sites.
GET /mso/api/v1/ep/cloud-tunnel/debug/sites/tunnels
Get all site-to-site tunnels created by the cloud sync tool
GET /mso/api/v1/ep/cloud-tunnel/debug/sites/{id}
Get site information
GET /mso/api/v1/ep/cloud-tunnel/debug/subnet
Get subnets provided for all registered cAPIC sites. At this time there are 254 subnets per site.
GET /mso/api/v1/ep/cloud-tunnel/debug/subnet/interface
Get all interfaces provided fro all registered cAPIC sites.
GET /mso/api/v1/ep/cloud-tunnel/debug/tunnels
Get all tunnels between interfaces between cAPIC sites
GET /mso/api/v1/ep/cloud-tunnel/report
Get all site information.
GET /mso/api/v1/ep/cloud-tunnel/sites
Get list of all the EP tunnel sites
GET /mso/api/v1/ep/cloud-tunnel/version
Get the cloud sync tool internal version.
GET /mso/api/v1/ep/site/{id}/endpoint
Get details of all endpoints discovered on a site
GET /mso/api/v1/ep/tunnel/sites
Get list of all the EP tunnel sites
GET /mso/api/v1/ep/tunnel/{id}
Get details of a EP tunnel site
GET /mso/api/v2/sites/{id}/dcnm/nodes/interfaces
List Node Interfaces based on Site Id
GET /mso/api/v2/sites/{id}/dcnm/faults
List of faults based on Site Id
GET /mso/api/v2/sites/{id}/dcnm/nodes
List Nodes based on Site Id
GET /mso/api/v1/siteupgrade/health/readiness
get Site-Upgrade service readiness status
GET /mso/api/v1/siteupgrade/health/liveness
get Site-Upgrade service liveness status
GET /mso/api/v1/siteupgrade/notifications/sites/{site}
get unprocessed site notification for one site
PUT /mso/api/v1/siteupgrade/notifications/sites/{site}
notify site-upgrade service regarding changes made to site information
GET /mso/api/v1/siteupgrade/notifications/sites
get unprocessed site notifications for all sites
GET /mso/api/v1/siteupgrade/associated/sites/{site}
Get site association with site-upgrade policies
GET /mso/api/v1/siteupgrade/synchronize
Get all instances of SyncTrigger
POST /mso/api/v1/siteupgrade/synchronize
Create or update an instance SyncTrigger for user triggered sync
GET /mso/api/v1/siteupgrade/synchronize/{trigger}
Get an instance of SyncTrigger
GET /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Get an instance of NodeUpgradePolicy
PUT /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Create or update an instance of NodeUpgradePolicy
DELETE /mso/api/v1/siteupgrade/nodes/policies/{policyName}
Delete an instance of NodeUpgradePolicy
GET /mso/api/v1/siteupgrade/nodes/policies
Get all NodeUpgradePolicy instances
POST /mso/api/v1/siteupgrade/nodes/policies
Create a new NodeUpgradePolicy
GET /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Get an instance of CtrlrUpgradePolicy
PUT /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Create or update an instance of CtrlrUpgradePolicy
DELETE /mso/api/v1/siteupgrade/ctrlr/policies/{policyName}
Delete an instance of CtrlrUpgradePolicy
GET /mso/api/v1/siteupgrade/ctrlr/policies
Get all CtrlrUpgradePolicy instances
POST /mso/api/v1/siteupgrade/ctrlr/policies
Create a new CtrlrUpgradePolicy
GET /mso/api/v1/siteupgrade/inventory/hardware/summary/sites
Get an instance of ViewNodeSummariesTopLevel
GET /mso/api/v1/siteupgrade/inventory/hardware/summary/sites/{site}
Get an instance of ViewNodeSummariesTopLevel per site
GET /mso/api/v1/siteupgrade/inventory/hardware/sites/{site}/switches
Get an instance of ViewSiteListSwitches
GET /mso/api/v1/siteupgrade/inventory/hardware/sites/{site}/controllers
Get an instance of ViewSiteListControllers
GET /mso/api/v1/siteupgrade/inventory/firmware/sites/{site}
Get instances of ViewFirmwareFirmware from one site
GET /mso/api/v1/siteupgrade/inventory/firmware/sites
List all ViewFirmwareFirmware
POST /mso/api/v1/siteupgrade/inventory/firmware/sites/common
Get common ViewFirmwareFirmwareAttributes accross sites
GET /mso/api/v1/siteupgrade/inventory/downloadsdashboard/images/{image}
Get instances of ViewFirmwareDownloadDashboard for one image
GET /mso/api/v1/siteupgrade/inventory/downloadsdashboard/images
Get instances of ViewFirmwareDownloadDashboard for all images
GET /mso/api/v1/siteupgrade/inventory/downloads/images/{image}
Get instances of ViewFirmwareDownload for one image from all sites
GET /mso/api/v1/siteupgrade/inventory/downloads/sites/{site}
Get instances of ViewFirmwareDownload for one site
GET /mso/api/v1/siteupgrade/inventory/downloads/sites
List all ViewFirmwareDownload
GET /mso/api/v1/siteupgrade/inventory/firmwareosource/sites/{site}
Get instances of ViewFirmwareOSource for one site
GET /mso/api/v1/siteupgrade/inventory/firmwareosource/sites
List all ViewFirmwareOSource
GET /mso/api/v1/siteupgrade/imagedownloads/{image}
Get an instance of ImageDownloadPolicy
PUT /mso/api/v1/siteupgrade/imagedownloads/{image}
Create or update an ImageDownloadPolicy
DELETE /mso/api/v1/siteupgrade/imagedownloads/{image}
Delete an instance of ImageDownloadPolicy
GET /mso/api/v1/siteupgrade/imagedownloads
List all ImageDownloadPolicy
POST /mso/api/v1/siteupgrade/imagedownloads
Create a new ImageDownloadPolicy
GET /mso/api/v1/deployments/templates/{templateId}/preview
Get template deploy preview of all sites
GET /mso/api/v1/deployments/templates/{templateId}/view
Get template deploy view all sites
GET /mso/api/v1/deploy/preview/schema/{schemaId}/template/{templateName}
Get template deploy preview of all sites
GET /mso/api/v1/deploy/view/schema/{schemaId}/template/{templateName}
Get template deploy view all sites
GET /mso/api/v1/deploy/status/schema/{schemaId}/template/{templateName}
Get template deploy status from all sites
GET /mso/api/v1/deployments/templates/{templateId}/status
Get template deploy status from all sites
GET /mso/api/v1/deployments
Get list of all template deployment tasks
POST /mso/api/v1/deployments
Create a new task to manage the deployment of a template
GET /mso/api/v1/deployments/{deployId}
Get status of single template deployment task
DELETE /mso/api/v1/deployments/{deployId}
Delete a queued template deployment operation
GET /mso/api/v1/audit-records
Get filtered AuditRecords
POST /mso/api/v1/audit-records
Insert audit record(s)
GET /mso/api/v1/audit-records/users
Get users that produced audit records associated with specified key and/or AuditRecordType
GET /mso/api/v1/audit-records/download
Download audit records in Json or CSV
GET /mso/api/v1/audit-records/count
Get total number of AuditRecords
GET /mso/api/v1/audit-records/{id}
Get an AuditRecord by id
GET /mso/api/v1/audit-records/schema/{id}/summary
Get schema summary by schema id
GET /mso/api/v1/cloudsec/sites/{siteId}/operstate
Get cloudsec operational state
GET /mso/api/v1/health/schemas/{schemaId}/health
Sync schema health
GET /mso/api/v1/health/schemas/{schemaId}/faults
Sync schema faults
GET /mso/api/v1/health/tenants/{tenantId}/health
Sync tenant health
GET /mso/api/v1/health/schemas/syncAll
Sync all schemas health
DELETE /mso/api/v1/health/schemas/{schemaId}
Delete schema health & faults
What's Deleted
GET /api/v1/status/schema/{schemaId}/template/{templateName}
status of execution for a template in a schema
GET /api/v1/version
List all version
POST /api/v1/version
set the current running version
GET /api/v1/schemas/search-policies
Search schema policy names.
GET /api/v1/schemas/search-policies-all-tenants
Get names of policies in all tenants
GET /api/v1/schemas/heatmap-search-policies/{query}
Search for heatmap policy names
GET /api/v1/schemas/allowed-tenants
Get allowed tenants
GET /api/v1/schemas/list-identity
Get all schemas (with pruned information)
GET /api/v1/schemas/{id}/tenants
Get associated Tenants with Schema
GET /api/v1/schemas/tenants
Get all associated tenants
GET /api/v1/schemas/audit-records
Get audit records related to schemas
GET /api/v1/schemas/audit-records/users
Get users that made actions related to schemas
GET /api/v1/schemas/{id}/audit-records
Get audit records related to a specific schema
GET /api/v1/schemas/{id}/audit-records/users
Get audit users that made actions related to a specific schema
GET /api/v1/schemas/service-graphs
Get service graphs
GET /api/v1/schemas/service-node-types
List the service node types
POST /api/v1/schemas/service-node-types
Insert service node type
DELETE /api/v1/schemas/service-node-types/{id}
Delete service node type
GET /api/v1/schemas/syncExtSubnets
Sync the external subnets
GET /api/v1/schemas
Get list of schemas (with all information)
POST /api/v1/schemas
Create new schema
GET /api/v1/schemas/{id}
Get details of schema by id
PUT /api/v1/schemas/{id}
Update schema with id
DELETE /api/v1/schemas/{id}
Delete schema
PATCH /api/v1/schemas/{id}
Patch schema
GET /api/v1/schemas/{id}/version
Get update version (number of times schema updated) of schema by schema id
PUT /api/v1/schemas/static-path/{id}
Patch schema
GET /api/v1/schemas/{id}/validate
check if schema is valid
GET /api/v1/schemas/{id}/health
Get policy health faults with schema id
GET /api/v1/schemas/{id}/faults
Get site policy faults with schema id
GET /api/v1/schemas/{id}/health-faults
Get site health faults with schema id
GET /api/v1/schemas/{id}/status
Get site status with schema id
GET /api/v1/schemas/{id}/relations
Get relationships between schema policies in schema
GET /api/v1/schemas/{id}/associations
Get associations of policies in schema
GET /api/v1/schemas/{id}/references
Get policy references in schema
GET /api/v1/schemas/{id}/policy-states
Get policy states in schema
GET /api/v1/schemas/{id}/policy-delta
Get policy object delta
POST /api/v1/schemas/{id}/template-delta/{templateName}
Get deltas for all policies in a template
POST /api/v1/schemas/{id}/templates/{templateName}/verify
Verify schema
GET /api/v1/schemas/{id}/warn
Get schema warnings
GET /api/v1/schemas/{siteId}/srL3out/{srL3outName}
Get all the schemas that are associated to the srL3out
GET /api/v1/schemas/site/{siteId}/externalVRF
Get if site is in use a schema
GET /api/v1/schemas/is-site-in-use/{siteId}
Get external VRF's (ie transport VRF's) in a schema
GET /api/v1/schemas/is-external-vrf-in-use/{vrfName}
Get all templates on site
GET /api/v1/schemas/{id}/templates/{templateName}/hostedVrfs
Get external Vrf is in use in site service
GET /api/v1/schemas/{id}/templates/{templateName}/subnetsForRouteLeak/{vrfName}
Get hosted vrfs in a template under schema
GET /api/v1/schemas/site/{siteId}/subnetGroupsforRegion
Get hosted vrf subnets for route leak
GET /api/v1/schemas/templates-on-site/{siteId}
Get subnetGroups for region
GET /api/v1/schemas/{schemaId}/deploymentSummary
Get summary of deployments of templates
GET /api/v1/schemas/site/{siteId}/subnetsWithPrivateLinkLabel
Get all CIDR subnets with private link labels
GET /api/v1/schemas/{id}/templates/{templateName}/site/{siteId}/vrfsWithCtxProfiles
Get all VRFs with context profile
GET /api/v1/schemas/{id}/templates/{templateName}/site/{siteId}/vrf/{vrfName}/cloudCtxProfile
Get all the cloud content profiles
GET /api/v1/schemas/tenant/{tenantId}/site/{siteId}/epgsWithPrivateLinkLabel
Get all the EPGs with private link labels
GET /api/v1/schemas/{id}/templates/{templateName}/vrfs/{vrfName}
Get VRF
GET /api/v1/schemas/{id}/templates/{templateName}/bds/{bdName}
Get BD
GET /api/v1/schemas/{id}/templates/{templateName}/anps/{anpName}/epgs/{epgName}
Get all EPGs
GET /api/v1/schemas/{id}/templates/{templateName}/externalEpgs/{externalEpgName}
Get all external EPG
GET /api/v1/schemas/policy/usage/{policyName}/{tenantId}
Get usage of all DHCP policies
GET /api/v1/schemas/policy/details/{policyName}/{tenantId}
Get BDs with specific DHCP policy
GET /api/v1/tenants/allowed-users
Get users that are allowed to interact with templates
GET /api/v1/tenants/allowed-users/domains
Get user domains that allowed to interact with templates
GET /api/v1/tenants/schemas
Get schemas on tenants
GET /api/v1/tenants
Get all tenants
POST /api/v1/tenants
Insert new tenant
GET /api/v1/tenants/{tenantName}/site/{siteId}
Get cloud account from cAPIC for a tenant
GET /api/v1/tenants/site/{siteId}/gatewayRouter
Get all gateway routers on site
GET /api/v1/tenants/master-org-account-sites
Get names of all AWS cAPICs with master cloud account
GET /api/v1/tenants/audit-records
Get audit records related to tenants
GET /api/v1/tenants/audit-records/users
Get users that made actions related to tenants
GET /api/v1/tenants/{id}/audit-records
Get audit records related to a specific tenant
GET /api/v1/tenants/{id}/audit-records/users
Get audit users that made actions related to a specific tenant
GET /api/v1/tenants/{id}
Get details of tenant
PUT /api/v1/tenants/{id}
Update tenant
DELETE /api/v1/tenants/{id}
Delete tenant
PATCH /api/v1/tenants/{id}
Patch tenant
GET /api/v1/tenants/{id}/schemas
Get schemas on a tenant
GET /api/v1/tenants/{id}/infra
Get infra details from tenant
PUT /api/v1/tenants/{id}/infra
Update infra details from tenant id
GET /api/v1/tenants/{id}/config-faults
Get configuration faults of a tenant
GET /api/v1/tenants/is-site-in-use/{siteId}
Is site in use by some tenant
GET /api/v1/import/sites/{siteId}/tenants/{tenantId}/templates/{templateName}
Import template. New import api docs can be found via MSO homepage or https://
/mso/docs/schema-service
POST /api/v1/migrate/schema/{schemaId}/template/{templateName}
Migrate template objects
GET /api/v1/schemas/deployed-template/{schemaId}/template/{templateName}/site/{siteId}
Get DeployedTemplate for specified schema, template and site
GET /api/v2/schemas/{id}/policy-delta
Get policy object delta
GET /api/v1/schemas/{schemaId}/template/{templateName}
Get Template References (list of all templates being refernced in current template)
POST /api/v1/schemas/{schemaId}/template/{templateName}/restoreTemplateVersion
Restore Template Version
GET /api/v1/versions/list/schemas/{schemaId}/template/{templateName}
Get Template History (list of all template versions of this template)
GET /api/v1/versions/status/schemas/{schemaId}/template/{templateName}
Get latest Template version status
GET /api/v1/versions/{versionId}
Get Template version by Id
GET /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}
Get Template version by number
PUT /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}/updateStatus
Update Template version change status
PUT /api/v1/versions/{versionNum}/schemas/{schemaId}/template/{templateName}/tag
Tag Template version
DELETE /api/v1/versions/schemas/{schemaId}/template/{templateName}
Bulk Delete template versions
GET /api/v1/sites/{id}/aci/tenants/{name}/l3-outs
ListL3Outs based on Site Id and Tenant Name
GET /api/v1/sites/{id}/aci/tenants
List Tenants based on Site Id
GET /api/v1/sites/{id}/aci/security-domains
List Security Domains based on Site Id
GET /api/v1/aci/sites/{id}/nodes/routerid
List RouterIds
GET /api/v1/sites/{id}/aci/infra/regionConfig
List Region Config pulled from Infra Tenant
GET /api/v1/sites/{id}/aci/cloud/{type}/regions/{name}/zones
List Cloud Region Zones
GET /api/v1/sites/{id}/aci/tenants/{name}/redirect-policies
List Redirect Policies based on Site Id, Tenant names
GET /api/v1/aci/sites/{id}/pods
List Fabric Pods based on Site Id
GET /api/v1/aci/sites/{id}/nodes
List Nodes based on Site Id
GET /api/v1/sites/{id}/aci/tenants/{name}/cloud/listener-certificates
List Listener Certificates of a Tenant of a Schema
GET /api/v1/sites/{id}/aci/domains/{domName}/enhancedLagPolicies
List Enhanced Lag policies based on Site Id
GET /api/v1/aci/sites/{id}/nodes/interfaces
List Node Interfaces based on Site Id
GET /api/v1/sites/{id}/aci/domains
List Domains based on Site Id and Domain type
GET /api/v1/sites/{id}/aci/tenants/{name}/devices
List Devices based on Site Id
GET /api/v1/sites/{id}/aci/tenants/{name}/devices/{deviceName}/interfaces
List Devices Interfaces based on Site Id, Tenant name and Device name
GET /api/v1/sites/{id}/aci/tenants/{name}/cloud/devices
List Cloud Devices based on Site Id
GET /api/v1/sites/{id}/aci/cloud-accounts
List Cloud Accounts based on Site Id [Only for cloud Sites
GET /api/v1/sites/{id}/aci/cloud/{type}/regions/zones
List All zones in a Cloud Region
GET /api/v2/sites/
All Site Info
GET /api/v2/sites/{id}
Site Info
PUT /api/v2/sites/anycastteppool
Anycast TepPool update
POST /api/v2/sites/manage
Manage Sites
DELETE /api/v2/sites/manage/{id}
Unmanage sites
GET /api/v1/sites
Get list of all the Sites
GET /api/v1/sites/allowed-labels
Get list of all the allowed Labels
GET /api/v1/sites/audit-records
Get all Audit Records
GET /api/v1/sites/audit-records/users
Get all Audit Users
GET /api/v1/sites/srEnabledSites
Get all SR-enabled Sites
GET /api/v1/sites/srL3outLabels/{Id}
Get all SrL3OutLabels
GET /api/v1/sites/sync-version
Update all Sites APIC-Version
GET /api/v1/sites/{id}
Get details of a Site
PUT /api/v1/sites/{id}/apic-version
Update Apic Version
GET /api/v1/sites/{id}/audit-records
Get all Audit Records by Site
GET /api/v1/sites/{id}/audit-records/users
Get all Audit Users by Site
GET /api/v1/sites/{id}/inuse
Get if a Site is in use
GET /api/v1/sites/{id}/labels
Get labels based on Site Id
GET /api/v2/sites/tunnelmgmt/report
Get tunnel management subnet usage report
GET /api/v2/sites/fabric-connectivity
FabricConnectivity get all API
PUT /api/v2/sites/fabric-connectivity
FabricConnectivity update API
GET /api/v2/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
PUT /api/v2/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /api/v2/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v2/sites/{id}/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v1/sites/fabric-connectivity
FabricConnectivity get all API
PUT /api/v1/sites/fabric-connectivity
FabricConnectivity update API
GET /api/v1/sites/fabric-connectivity-status
Fabric-connectivity-status API
GET /api/v1/sites/fabric-connectivity/audit-records
Audit Records
GET /api/v1/sites/fabric-connectivity/audit-records/users
Audit Users
GET /api/v1/sites/{id}/fabric-connectivity
FabricConnectivity single site get API
GET /api/v1/sites/{id}/fabric-connectivity/apic-version
Apic Version
GET /api/v1/sites/{id}/fabric-connectivity/mpod-info
Mpod get API
PUT /api/v1/sites/{id}/fabric-connectivity/refresh
FabricConnectivity site refresh API
GET /api/v1/ep/cloud-tunnel/debug/forcedClear
All configuration will be recreated and pushed to all registered cAPIC sites
GET /api/v1/ep/cloud-tunnel/debug/report
Report information for every registered cAPIC site.
GET /api/v1/ep/cloud-tunnel/debug/resync
Allows to push again all configuration to all registered cAPIC sites.
GET /api/v1/ep/cloud-tunnel/debug/sites/tunnels
Get all site-to-site tunnels created by the cloud sync tool
GET /api/v1/ep/cloud-tunnel/debug/sites/{id}
Get site information
GET /api/v1/ep/cloud-tunnel/debug/subnet
Get subnets provided for all registered cAPIC sites. At this time there are 254 subnets per site.
GET /api/v1/ep/cloud-tunnel/debug/subnet/interface
Get all interfaces provided fro all registered cAPIC sites.
GET /api/v1/ep/cloud-tunnel/debug/tunnels
Get all tunnels between interfaces between cAPIC sites
GET /api/v1/ep/cloud-tunnel/report
Get all site information.
GET /api/v1/ep/cloud-tunnel/sites
Get list of all the EP tunnel sites
GET /api/v1/ep/cloud-tunnel/version
Get the cloud sync tool internal version.
GET /api/v1/ep/site/{id}/endpoint
Get details of all endpoints discovered on a site
GET /api/v1/ep/tunnel/sites
Get list of all the EP tunnel sites
GET /api/v1/ep/tunnel/{id}
Get details of a EP tunnel site
GET /api/v2/sites/{id}/dcnm/nodes/interfaces
List Node Interfaces based on Site Id
GET /api/v2/sites/{id}/dcnm/faults
List of faults based on Site Id
GET /api/v2/sites/{id}/dcnm/nodes
List Nodes based on Site Id
GET /api/v1/siteupgrade/health/readiness
get Site-Upgrade service readiness status
GET /api/v1/siteupgrade/health/liveness
get Site-Upgrade service liveness status
GET /api/v1/siteupgrade/notifications/sites/{site}
get unprocessed site notification for one site
PUT /api/v1/siteupgrade/notifications/sites/{site}
notify site-upgrade service regarding changes made to site information
GET /api/v1/siteupgrade/notifications/sites
get unprocessed site notifications for all sites
GET /api/v1/siteupgrade/associated/sites/{site}
Get site association with site-upgrade policies
GET /api/v1/siteupgrade/synchronize
Get all instances of SyncTrigger
POST /api/v1/siteupgrade/synchronize
Create or update an instance SyncTrigger for user triggered sync
GET /api/v1/siteupgrade/synchronize/{trigger}
Get an instance of SyncTrigger
GET /api/v1/siteupgrade/nodes/policies/{policyName}
Get an instance of NodeUpgradePolicy
PUT /api/v1/siteupgrade/nodes/policies/{policyName}
Create or update an instance of NodeUpgradePolicy
DELETE /api/v1/siteupgrade/nodes/policies/{policyName}
Delete an instance of NodeUpgradePolicy
GET /api/v1/siteupgrade/nodes/policies
Get all NodeUpgradePolicy instances
POST /api/v1/siteupgrade/nodes/policies
Create a new NodeUpgradePolicy
GET /api/v1/siteupgrade/ctrlr/policies/{policyName}
Get an instance of CtrlrUpgradePolicy
PUT /api/v1/siteupgrade/ctrlr/policies/{policyName}
Create or update an instance of CtrlrUpgradePolicy
DELETE /api/v1/siteupgrade/ctrlr/policies/{policyName}
Delete an instance of CtrlrUpgradePolicy
GET /api/v1/siteupgrade/ctrlr/policies
Get all CtrlrUpgradePolicy instances
POST /api/v1/siteupgrade/ctrlr/policies
Create a new CtrlrUpgradePolicy
GET /api/v1/siteupgrade/inventory/hardware/summary/sites
Get an instance of ViewNodeSummariesTopLevel
GET /api/v1/siteupgrade/inventory/hardware/summary/sites/{site}
Get an instance of ViewNodeSummariesTopLevel per site
GET /api/v1/siteupgrade/inventory/hardware/sites/{site}/switches
Get an instance of ViewSiteListSwitches
GET /api/v1/siteupgrade/inventory/hardware/sites/{site}/controllers
Get an instance of ViewSiteListControllers
GET /api/v1/siteupgrade/inventory/firmware/sites/{site}
Get instances of ViewFirmwareFirmware from one site
GET /api/v1/siteupgrade/inventory/firmware/sites
List all ViewFirmwareFirmware
POST /api/v1/siteupgrade/inventory/firmware/sites/common
Get common ViewFirmwareFirmwareAttributes accross sites
GET /api/v1/siteupgrade/inventory/downloadsdashboard/images/{image}
Get instances of ViewFirmwareDownloadDashboard for one image
GET /api/v1/siteupgrade/inventory/downloadsdashboard/images
Get instances of ViewFirmwareDownloadDashboard for all images
GET /api/v1/siteupgrade/inventory/downloads/images/{image}
Get instances of ViewFirmwareDownload for one image from all sites
GET /api/v1/siteupgrade/inventory/downloads/sites/{site}
Get instances of ViewFirmwareDownload for one site
GET /api/v1/siteupgrade/inventory/downloads/sites
List all ViewFirmwareDownload
GET /api/v1/siteupgrade/inventory/firmwareosource/sites/{site}
Get instances of ViewFirmwareOSource for one site
GET /api/v1/siteupgrade/inventory/firmwareosource/sites
List all ViewFirmwareOSource
GET /api/v1/siteupgrade/imagedownloads/{image}
Get an instance of ImageDownloadPolicy
PUT /api/v1/siteupgrade/imagedownloads/{image}
Create or update an ImageDownloadPolicy
DELETE /api/v1/siteupgrade/imagedownloads/{image}
Delete an instance of ImageDownloadPolicy
GET /api/v1/siteupgrade/imagedownloads
List all ImageDownloadPolicy
POST /api/v1/siteupgrade/imagedownloads
Create a new ImageDownloadPolicy
GET /api/v1/deploy/preview/schema/{schemaId}/template/{templateName}
Get template deploy preview of all sites
GET /api/v1/deploy/view/schema/{schemaId}/template/{templateName}
Get template deploy view all sites
GET /api/v1/deploy/status/schema/{schemaId}/template/{templateName}
Get template deploy status from all sites
GET /api/v1/task
Get list of all tasks
POST /api/v1/task
Create new task
GET /api/v1/task/{taskId}
Get status of single task
DELETE /api/v1/task/{taskId}
Delete a queued operation
GET /api/v1/audit-records
Get filtered AuditRecords
POST /api/v1/audit-records
Insert audit record(s)
GET /api/v1/audit-records/users
Get users that produced audit records associated with specified key and/or AuditRecordType
GET /api/v1/audit-records/download
Download audit records in Json or CSV
GET /api/v1/audit-records/count
Get total number of AuditRecords
GET /api/v1/audit-records/{id}
Get an AuditRecord by id
GET /api/v1/audit-records/schema/{id}/summary
Get schema summary by schema id
GET /api/v1/cloudsec/sites/{siteId}/operstate
Get cloudsec operational state
GET /api/v1/policies/usage
Get usage of all policies
GET /api/v1/policies/usage/{id}
Get usage of a policy by id of policy
GET /api/v1/policies/references
Get policy associations
GET /api/v1/policies/audit-records
Get audit records related to policies
GET /api/v1/policies/audit-records/users
Get users that made actions related to policies
GET /api/v1/policies/{id}/audit-records
Get audit records related to a specific policy
GET /api/v1/policies/{id}/audit-records/users
Get audit users that made actions related to a specific policy
GET /api/v1/policies
List policies
GET /api/v1/policies/dhcp/relay
Get DHCP relay policies
POST /api/v1/policies/dhcp/relay
Insert DHCP Relay Policy
GET /api/v1/policies/dhcp/option
Get DHCP option policies
POST /api/v1/policies/dhcp/option
Insert DHCP Option Policy
GET /api/v1/policies/dhcp/relay/{id}
Get details of DHCP relay policy by id
PUT /api/v1/policies/dhcp/relay/{id}
Update DHCP Policy by id
DELETE /api/v1/policies/dhcp/relay/{id}
Delete DHCP policy
GET /api/v1/policies/dhcp/option/{id}
Get details of a DHCP option location by id
PUT /api/v1/policies/dhcp/option/{id}
Update DHCP policy
DELETE /api/v1/policies/dhcp/option/{id}
Delete DHCP option policy
GET /api/v1/policies/routemap
Get all routemap policies
POST /api/v1/policies/routemap
Create new routemap policy
GET /api/v1/policies/routemap/{id}
Get details of a routemap policy by id
PUT /api/v1/policies/routemap/{id}
Update routemap policy by id
DELETE /api/v1/policies/routemap/{id}
Delete routemap policy by id
GET /api/v1/policies/qos
Get details of QOS policy
POST /api/v1/policies/qos
Create new QOS policy
GET /api/v1/policies/qos/{id}
Get details of a QOS policy by id
PUT /api/v1/policies/qos/{id}
Update QOS policy by id
DELETE /api/v1/policies/qos/{id}
Delete QOS policy
GET /api/v1/policies/bfd
Get details of a BFD policy by id
POST /api/v1/policies/bfd
Create BFD Policy
GET /api/v1/policies/mcast-routemap
Get all Multicast-Route Map Policies
POST /api/v1/policies/mcast-routemap
Create new Multicast-Route Map Policy
GET /api/v1/policies/mcast-routemap/{id}
Get details of Multicast-Route Map Policy
PUT /api/v1/policies/mcast-routemap/{id}
Update Multicast-Route Map Policy
DELETE /api/v1/policies/mcast-routemap/{id}
Delete Multicast-Route Map Policy
GET /api/v1/policies/dcnm-dhcp
Get details of a DCNM-DHCP policy based on id
POST /api/v1/policies/dcnm-dhcp
Create new DCNM-DHCP policy
GET /api/v1/policies/dcnm-dhcp/{id}
Get DCNM-DHCP policy by id
PUT /api/v1/policies/dcnm-dhcp/{id}
Update DCNM-DHCP policy by id
DELETE /api/v1/policies/dcnm-dhcp/{id}
Delete DCNM-DHCP policy
GET /api/v1/policies/dcnm-dhcp/{name}/tenantId/{tenantId}
Get DCNM-DHCP policy policy by name
GET /api/v1/policies/dcnm-policies
List all DCNM policies
POST /api/v1/policies/dcnm-policies
Create DCNM policy
DELETE /api/v1/policies/dcnm-policies/{id}
Delete DCNM policy
GET /api/v1/policies/dcnm-vrf-policy-names
Get all DCNM VRF Policy Names
GET /api/v1/policies/dcnm-vrf-extn-policy-names
Get all DCNM VRF Extn Policy Names
GET /api/v1/policies/dcnm-network-policy-names
Get all DCNM Network Policy Names
GET /api/v1/policies/dcnm-network-extn-policy-names
Get all DCNM Network Extn Policy Names
GET /api/v1/policies/sla
Get all SLA policies
GET /api/v1/policies/sla/{id}
Get SLA policy
GET /api/v1/policies/dscp-values
Get valid DSCP values
GET /api/v1/policies/dscp-cos
Get all DSCP class-cos translation policies (Global DSCP Policy)
PUT /api/v1/policies/dscp-cos
DSCP class-cos translation policies
GET /api/v1/policies/global-naming
List all Global Naming Policies
POST /api/v1/policies/global-naming
Create global naming policy
GET /api/v1/policies/global-naming/{id}
Get details of a Global Naming Policy by id
PUT /api/v1/policies/global-naming/{id}
Update Global Naming Policy
DELETE /api/v1/policies/global-naming/{id}
Delete Global Name Policy
GET /api/v1/policies/nsg-subnetLevel
Get all NSG at Subnet level Policies
POST /api/v1/policies/nsg-subnetLevel
Create NSG at Subnet level Policy
GET /api/v1/policies/nsg-subnetLevel/{id}
Get details of NSG at Subnet level Policy
PUT /api/v1/policies/nsg-subnetLevel/{id}
Update NSG at Subnet level Policy
DELETE /api/v1/policies/nsg-subnetLevel/{id}
Delete NSG at Subnet level Policy
GET /api/v1/health/schemas/{schemaId}/health
Sync schema health
GET /api/v1/health/schemas/{schemaId}/faults
Sync schema faults
GET /api/v1/health/tenants/{tenantId}/health
Sync tenant health
GET /api/v1/health/schemas/syncAll
Sync all schemas health
DELETE /api/v1/health/schemas/{schemaId}
Delete schema health & faults