FAQ

What is the OpenAPI Specification?

The Intersight API complies with the OpenAPI Specification, which defines a standard, programming language-agnostic interface description for REST APIs. The Intersight OpenAPI specification allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic.

The Intersight OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which is represented either in JSON or YAML format. The Intersight OpenAPI document is downloadable from https://intersight.com/apidocs/introduction/overview/.

How is the Intersight API Versioned?

The OpenAPI specification standard is versioned using Semantic Versioning 2.0.0 (semver). Intersight currently supports the OpenAPI specification version 2.0. The Intersight OpenAPI document is also versioned and is updated whenever new APIs are deployed.

Where Can I Learn More About the OpenAPI Specification?

The OpenAPI specification and associated documentation are available at https://github.com/OAI/OpenAPI-Specification.

What is the Licensing Model of the OpenAPI Specification?

The OpenAPI is distributed under the Apache 2.0 license.

What are the Bbenefits of the OpenAPI Specification?

The OpenAPI standard provides the following benefits over custom, proprietary APIs:

  • Users already familiar with the OpenAPI specification can apply the same OpenAPI concepts, tools and libraries to the Intersight Web service.
  • Leverage ecosystem of open-source and commercial tools and libraries, including editors, user interfaces and SDK generators.
  • The OpenAPI specification is language-agnostic and provides client generators for dozens of programming languages.
  • The OpenAPI initiative is supported by a growing number of companies working together to standardize RESTful Web services and provide uniform tooling.
  • Because the Intersight API is defined using the OpenAPI specification, SDKs can be generated for many of the languages supported by the OpenAPI code generator. The full list of currently supported languages is available at https://github.com/swagger-api/swagger-codegen

What Network Connectivity is Required to Access the Intersight API?

API clients need to connect to the following region specific URLs:

  • US region: intersight.com or us-east-1.intersight.com
  • EU region: eu-central-1.intersight.com

Intersight API clients can be deployed anywhere, as long as they have network connectivity to the Intersight service and can establish outbound HTTPs connections to the regional endpoints over TCP port 443. The Intersight API clients are not required to have network connectivity to the systems managed by Intersight. However, in some use cases such as bulk claiming devices, API clients may need connectivity to the region specific Intersight URLs and managed systems.

What SDKs are Available for the Intersight API?

Intersight provides a downloadable Software Development Kit (SDK) for the Python programming language. Instructions to download SDKs are available at https://intersight.com/apidocs/introduction/overview/. Other popular programming language SDKs will be available for download.

What are the System Requirements for the Intersight Python SDK?

Refer to the Python SDK documentation for system requirements. The Python SDK has been tested with Python 2.7 and Python 3.5+ on Linux, OS X and Windows 10.