Intersight API Overview

This document presents the fundamentals of the Intersight API. Cisco Intersight provides a cloud-based RESTful API to manage Intersight connected targets across multiple Data Centers. Cisco Intersight infrastructure services include the deployment, monitoring, management, and support for physical and virtual infrastructure. It supports:

  • Cisco Unified Computing System™ (Cisco UCS®)
  • Cisco HyperFlex hyperconverged infrastructure (HCI)
  • Cisco MDS Switch
  • Cisco UCS Director
  • Intersight Cloud Orchestrator
  • Intersight Workload Optimizer
  • VMware vCenter
  • Storage Systems including NetApp Storage, Hitachi Virtual Storage Platform, Pure Storage FlashArray and other third-party Intersight-connected targets.

Intersight API Overview

The Intersight API is a programmatic interface that uses the REST architecture to provide access to the Intersight Management Information Model. API requests may be read-only query with no side-effects or produce modifications of the resources. The response may confirm that some alteration has been made to the resource and it may provide hypertext links to related resources or collections of resources. The Intersight API accepts and returns messages that are encapsulated through JavaScript Object Notation (JSON) documents and uses HTTP over TLS as the transport protocol.

Cisco Intersight provides the benefits of cloud-based management that customers have come to appreciate with Software-as-a-Service (SaaS) products. For example, the Intersight API is automatically updated when new features are deployed to the cloud, providing programmatic access to new IT infrastructure capabilities.

The Intersight API is based on the OpenAPI specification standard (formerly known as the Swagger specification), which defines a programming language-agnostic interface description for describing, producing, consuming, and visualizing RESTful Web services. The OpenAPI specification for Intersight allows both humans and computers to discover and understand the capabilities of the service without requiring access to source code, additional documentation, or inspection of network traffic. The Intersight OpenAPI is described in a JSON or YAML file referred to as the Intersight OpenAPI document, available both with the OpenAPI schema version 2 and 3. The recommendation is to use the OpenAPI document based on schema version 3.

Intersight provides downloadable SDK packages in multiple programming languages.