Cisco rest api documentation. 2(1), all REST API procedures are provided in the various configuration guides, available at the Cisco Application Policy Infrastructure Controller (APIC) documentation page: The Cisco Umbrella data connector provides the capability to ingest Cisco Umbrella events stored in Amazon S3 into Microsoft Sentinel using the Amazon S3 REST API. There are Python bindings for both NX-API REST and NX-API CLI. Intent API (Northbound) The Intent API are Northbound REST API that exposes specific capabilities of the Catalyst Center platform. Use Python SDK, Ansible collections, and Terraform providers for repeatable network management. The Intent API organizes hierarchically into functional 'domains' and 'subdomains' of service. 3. The API accepts and returns HTTP or HTTPS messages that contain JavaScript Object Notation (JSON) or Extensible Markup Language (XML) documents. Learn more. Meraki Dashboard APIs The Meraki Dashboard API (referred to as Meraki API) is a RESTful API interface that allows you to programmatically manage and monitor Meraki networks at scale. cisco. The REST API itself is used not only in NSO but also in other products, and because it is easy to call from Javascript, it is often used in web portals 3 days ago · cisco-ucce CLI Design Spec Overview CLI-only tool for monitoring and troubleshooting Cisco Unified Contact Center Enterprise. Sep 29, 2021 · The documentation set for this product strives to use bias-free language. They also include guidelines for developer experience including lifecycle management, reference documentation, developer resources, and developer support. Postman Postman Aug 26, 2020 · Contributing and building the Cisco developer documentation really helps our community. It is an aggregation of all the Cisco Security Products' API related resources at one place. This is a summary of common REST API design constraints and conventions intended as a guide for developers when introducing new or modifying existing REST API endpoints. 4 days ago · The Duo Admin API provides programmatic access to administrative functionality of Duo Security’s two-factor authentication platform. Read-only operations across 7 APIs spanning the full UCCE solution stack: AW, Finesse, CVP, PG, VVB, and LiveData. The new object properties are: infraClusterPol:shrink false: (default) If the Nov 28, 2025 · Use this procedure to register a switch from the Nodes Pending Registration tab on the Fabric Membership work pane using the REST API. The encryption and keys are managed by Amazon. These categories are: Authentication Domain The Catalyst Center platform REST methods require caller Learn how you can integrate REST APIs with Network Configuration Manager to integrate third-party software with Network Configuration Manager. Cisco Umbrella is cloud-delivered enterprise network security which provides users with a first line of defense against cybersecurity threats. It is derived from the RESTful API Design Guidelines but distilled down to the most essential points such that it can be read in just a few minutes and easily referenced. Sandbox - Cisco DevNet enable software developers and network engineers to build more secure, better-performing software and IT infrastructure with APIs, SDKs, tools, and resources. Sep 20, 2019 · Cisco's Firepower Management Center REST API Quick Start Guide offers an overview of API functionality, endpoints, and usage for managing Firepower devices. 0 (2) and later, along with selected procedures from earlier releases. Figure 3. Apr 4, 2023 · This document describes how to validate and configure REST API calls to vManage through the use of on-board documentation. This information will vary depending on the API you are using, so it is essential to read the documentation carefully. Cisco Open NX-OS exposes three primary APIs: NX-API REST - HTTP-based RESTful API NX-API CLI - RPC-based API NETCONF API Each of these APIs can be used with multiple language bindings. Introduction - CX Cloud API allows Cisco partners and customers to programmatically access and consume Cisco data in a simple, secure, and scalable manner. It was translated by the Cisco Community to share the query and its solution in different languages. Exceptions may be present in the documentation Getting Started - Use Catalyst Center Intent APIs, Integration Flows, Events and Notification Services to enhance the overall network experience by optimizing end-to-end IT processes. 5 (x) The Cisco Cloud Security solution for Microsoft Sentinel enables you to ingest Cisco Secure Access and Cisco Umbrella logs stored in Amazon S3 into Microsoft Sentinel using the Amazon S3 REST API. Some commonly used objects and methods from REST API are covered in this guide. See the Firepower Management Center Configuration Guide for more information. Dec 2, 2019 · You can perform operations on the Cisco Cloud Services Platform (Cisco CSP) objects using the Representational State Transfer (REST) API. This Introduction to the Cisco Intersight REST API with Python Learning Lab will guide you through using REST APIs in Python to query, update and configure Intersight. ise Ansible Modules | Documentation | Repository isegosdk Go SDK | Documentation | Repository ciscoise Terraform Provider | Documentation | Registry | Repository Jan 22, 2017 · The REST API uses the same authentication and permission model as the Firepower Management Center. Cisco BMC REST API Examples Managing Account Service, on page 2 Managing Account Collections, on page 7 Configuring Manager Account, on page 7 Viewing Role Collection, on page 10 Jun 14, 2023 · Interested in learning how to use REST APIs for SD-WAN? Please check out this webinar from Developer Advocate and networking expert Adrian Iliesiu. When you apply the code, the system determines if the node exists and, if not, adds it. The REST API is also used by the GUIs of the Nexus Dashboard and the services running on it. 1 and later, you can enable REST API support on the remote management interface. To disable REST API support, see Disabling REST API Support, on page 11. The Cisco CSP 2100 REST APIs support create, retrieve, update, and delete (CRUD) operations. Contribute to CiscoDevNet/api-design-guide development by creating an account on GitHub. Cisco Intersight offers a REST API that allows for automation of all aspects of Cisco Intersight. This tutorial describes the basics of consuming a REST API - namely the Webex API, as well as how to use Postman to explore a REST API. In this post, I’ll simplify REST APIs for you with easy language, practical examples, and a small working lab in EVE-NG. 5 (x) May 26, 2021 · About the FMC REST API With the release of FMC REST API, you now have light-weight, easy-to-use option for managing FTD and legacy devices through a FMC. Jan 8, 2026 · The ASA REST API gives you programmatic access to managing individual ASAs through a Representational State Transfer (REST) API. 0 (2), two additional properties are added to the API command to allow forcing the decommission operation. Cisco Finesse REST APIs This document is the official reference for the Cisco Finesse Application Programming Interface (API). For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Note Beginning with Cisco APIC Release 6. Postman Postman Mar 24, 2023 · The API documentation should provide you with clear instructions on how to authenticate and use the API properly. Beginning with Cisco APIC, Release 4. REST API response Use Python SDK, Ansible collections, and Terraform providers for repeatable network management. Many API configuration procedures for earlier releases can be found in the configuration guides for those releases. The ACI infrastructure operates as a single system at the fabric level, controlled by the centralized Cisco Application Policy Infrastructure Controller (APIC). The REST APIs provide an alternative method to the Cisco IOS XE CLI to provision selected functions. Introduction to the Monitoring REST API - Enforce compliance, heighten infrastructure security, and streamline user network access operations. Cisco ACI Programmability with Object-Oriented Data Model and REST APIs Cisco has taken a foundational approach to building a programmable network infrastructure with Cisco ACI. Nov 28, 2025 · The cluster drives its actual size to the target size. Feb 14, 2024 · This document describes the steps to configure API access and use it to fetch resources information from the Secure Access. Cisco SD-WAN API Typically, you access the REST API through the vManage web server. 11S, and including IOS XE Denali 16. When invoked, the command triggers a message from the REST API daemon to the REST API Agent to enable and forward debug logs. The Finesse desktop APIs support the Finesse desktop, providing agent desktop functionality, such as call control and state changes. For more information about contracting the cluster size, see Cisco APIC Cluster contractions. REST API Troubleshooting Checklist - Allows to manage the IOT device lifecycle, monitor data, SMS, and voice usage, send messages to a device, and assign rate plans to a device. This chapter will explore the Open NX-OS RESTful APIs in more detail. The RESTful Catalyst Center Intent API uses HTTPS verbs (GET, POST, PUT, and DELETE) with JSON structures to discover and control the network. Configuring the Cisco APIC Using the REST API In an ACI cluster with three (the recommeneded number of controllers) APICs, naming each controller helps you to quickly identify the APIC you are logged in to. Enable configurations that would require issuing many CLI commands by combining configuration actions in relatively few HTTP/HTTPS operations. Mar 7, 2021 · ‎ 03-18-2021 01:43 PM Hi everyone How are alerts defined and how are REST API extensions used? Note: This question is a translation of an original post created in the Spanish community by Fernando Mondragon. You can use any programming language to generate the messages and the JSON that contain the API methods or Managed Object (MO) descriptions. Documentation All NX-OS Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10. I am looking for something like this API Explorer but for Cisco switches: Jan 19, 2024 · Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Postman Postman These recommendations apply to REST, YANG, and gRPC styles of APIs. The API documentation should outline the authentication method used by the API and the steps you need to follow. The documentation set for this product strives to use bias-free language. Meraki APIs provide a range of operations to Add new organizations, administrators, networks, devices, VLANs, and more Configure thousands of networks in minutes On-board and Off-board new employees’ teleworker This is a summary of common REST API design constraints and conventions intended as a guide for developers when introducing new or modifying existing REST API endpoints. This document provides all the information you need to integrate and build NETCONF and REST Device Management applications. Cisco configures all Cisco-managed buckets to use Amazon Server-Side Encryption with S3-Managed Keys (SSE-S3, AES-256). vManage Python SDK There are many great things Feb 20, 2018 · For supported platforms, Cisco IOS XE supports a Representation State Transfer (REST) set of APIs, beginning with Cisco IOS XE 3. . No write operations. Like ACI, it uses an object-oriented eventual consistency model based on promise theory. To enable the REST API, perform the following steps. 1 or higher, and use with a REST client. The NX-API-REST model borrows several concepts from Cisco ACI and makes them available for non-ACI based standalone Nexus fabric environment. Jan 22, 2017 · The REST API uses the same authentication and permission model as the Firepower Management Center. REST API Functions The following table lists all the available REST API functions. Mar 5, 2025 · Internal REST API Endpoints The documentation set for this product strives to use bias-free language. Introducing the Cisco IOS XE REST API 1-1 Introduction 1-1 Feature History and Supported Platforms 1-1 Getting Started 1-3 Important Notes 1-3 Conventions 1-4 Deploying REST API Using cURL: Example 1-7 Cisco Secure Access API Reference overview - Protect your networks, investigate your network elements and traffic, and create rich reports and dashboard integrations. Today, we’re diving into the REST API basics for Cisco devices, a game-changer for anyone looking to modernize their workflow. Sep 11, 2023 · NX-API REST improves the accessibility of the Cisco Nexus configuration by providing HTTP/HTTPS APIs that: Make specific CLIs available outside of the switch. You can efficiently implement operations automation of your IT infrastructure from the data center to the edge. The NETCONF and RESTCONF interfaces are defined by YANG models. Jul 31, 2018 · This page provides an overview for different forms of APIs available in all the Cisco Security Products and pointers to their documentation & examples. Enabling REST API Support Beginning with Cisco IOS XE Release 3. Cisco SD-WAN Python SDK Cisco has provided a full-fledged Python-based SDK for Cisco vManage that has tools, libraries, and documentation to simplify the interactions with the REST API. com/api-guidelines. In this webinar, we will have a look at what REST APIs are and how they can be used to interact programmatically with Cisco SD-WAN. A list of selected methods in REST API is described in “Appendix B—REST API Objects and Methods”. It is intended for engineers interested in automating the administration and operation of the SD-WAN solution using Python without any GUI interaction. Dec 21, 2020 · Obtaining Documentation and Submitting a Service Request Information About the Cisco CSP REST API You can perform operations on the Cisco Cloud Services Platform (Cisco CSP) objects using the Representational State Transfer (REST) API. Meraki APIs provide a range of operations to Add new organizations, administrators, networks, devices, VLANs, and more Configure thousands of networks in minutes On-board and Off-board new employees’ teleworker 4 days ago · The Duo Admin API provides programmatic access to administrative functionality of Duo Security’s two-factor authentication platform. Sep 29, 2021 · The REST API is the interface into the management information tree (MIT) and allows manipulation of the object model state. Postman Postman Postman Postman The API accepts and returns HTTP or HTTPS messages that contain JavaScript Object Notation (JSON) payloads. Cisco Webex for Developers - Develop rich integrations and powerful automation with Webex cloud collaboration platform APIs and SDKs. Cisco Umbrella API, Getting Started - Protect your networks, investigate your network elements and traffic, and create rich reports and dashboard integrations. Feb 20, 2018 · For supported platforms, Cisco IOS XE supports a Representation State Transfer (REST) set of APIs, beginning with Cisco IOS XE 3. These recommendations apply to REST, YANG, and gRPC styles of APIs. Guidelines for designing REST APIs at Cisco. If the target size is higher than the actual size, the cluster size expands. ise Ansible Modules | Documentation | Repository isegosdk Go SDK | Documentation | Repository ciscoise Terraform Provider | Documentation | Registry | Repository Cisco DevNet documentation provides in-depth reference information for Cisco product APIs and tools Jul 10, 2024 · Solved: I am looking for the official Rest API documentation to get the correct syntax to configure devices via PUT command. Nov 28, 2025 · Configuring the Cisco APIC Using the CLI The APIC GUI is a browser-based graphical interface for configuring and monitoring the ACI fabric. Aug 26, 2020 · Contributing and building the Cisco developer documentation really helps our community. Jun 30, 2022 · This appendix provides information about the REpresentational State Transfer (REST) APIs supported in Cisco Prime Access Registrar. Cisco DevNet documentation provides in-depth reference information for Cisco product APIs and tools If you work for Cisco, the latest guidance and recommendations for API programs and API design are accessible with your Cisco login at https://developer. You can consult the REST API documentation for a complete list of the response codes you can expect. Access documentation, OpenAPI specs, sample code, sandboxes, and community support on Cisco DevNet. Cisco APIC System Management Configuration Guide NOTE: This document contains selected API configuration procedures for features added in Cisco APIC Release 6. Mar 1, 2019 · What is the REST API? The REST API (or RESTful API) is one of the Northbound APIs supported by NSO, and the client can operate NSO using HTTP(S). Nov 28, 2025 · Use this procedure to shrink the cluster size by removing controllers. For general information about how to use these APIs, see Getting Started. Nov 28, 2025 · The documentation set for this product strives to use bias-free language. Jun 16, 2015 · About the APIC REST API The APIC REST API is a programmatic interface to the Application Policy Infrastructure Controller (APIC) that uses a Representational State Transfer (REST) architecture. A valid REST API request typically gets a 200 OK response, which indicates that the API received and understood the request. If the node does exist, the system registers it. Dec 3, 2025 · Authentication from a REST API Client Authentication from a REST API Client Cisco recommends that you use different accounts for interfacing with the API and the User Interface. Jul 31, 2014 · For supported platforms, the Cisco IOS XE REST APIs provide an alternative method to the Cisco IOS XE CLI to provision selected functions. If the request wasn't valid, the response might be 404 Not Found. CUIC does not expose a public REST API — skip. Dec 16, 2014 · The "debug rest-api " command enables REST API Agent debug traces on the CLI terminal. 6 days ago · Basic information on the Firewall Threat Defense REST API, which you can use to programmatically interact with a Firewall Threat Defense device that you are managing locally through Firewall Device Manager. Cisco and the Umbrella user account (customer) don't exchange keys, but the data is still encrypted at rest. Cisco DevNet enable software developers and network engineers to build more secure, better-performing software and IT infrastructure with APIs, SDKs, tools, and resources. Credentials cannot be used for both interfaces simultaneously, and will be logged out without warning if used for both. The purpose of this appendix is to provide a developer, system or network administrator, or system integrator with basic guidelines for using the outlined REST APIs within the Prime Access Registrar deployment. Nov 28, 2025 · Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. While working with the Webex REST API is easy, there are a few things we standardize on throughout the API, such as pagination of long result sets or HTTP response codes. Mar 10, 2016 · We have published several ISE REST API packages and resources to help you with your scripting and automation needs with ISE: ciscoisesdk Python Package | Documentation | Repository cisco. The vManage REST API library and documentation are bundled with it and installed on the vManage web application software. 10S. The same REST interface is used by the APIC CLI, GUI, and SDK, so that whenever information is displayed, it is read through the REST API, and when configuration changes are made, they are written through the REST API. The API allows external clients to perform CRUD (Create, Read, Update, Delete) operations on ASA resources; it is based on the HTTPS protocol and REST methodology. The REST API is an application programming interface (API), based on “RESTful” principles, which you can quickly enable on any FMC running version 6. Module Overview - Cisco Intersight simplifies and automates IT operations management to make daily activities easier and more efficient. Learn more about how Cisco is using Inclusive Language. Note This procedure is identical to "Adding a Switch Before Discovery Using the REST API". For REST API resources available without a login, please look at our OpenAPI rulesets encoded in api-insights-openapi-rulesets. We will also briefly The main difference between synchronous and asynchronous APIs is that a synchronous API waits for other aspects of the code to complete prior to moving on and processing additional code. fmvk gymdzr jfssi fnqr srchpg ubfxqain uvvim skrkoj uvbcdp abmoc