How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Intersight Onprem API

The onprem API from Cisco Intersight — 8 operation(s) for onprem.

Cisco Intersight Onprem API is one of 117 APIs that Cisco Intersight publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include On-Prem. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 12 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.11-20260807064027971.

Requests are made against a single base URL, https://{server}.

12 operations 8 paths 29 schemas 8 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.11-20260807064027971
Base URL
https://intersight.com
Authentication
API Key, HTTP Signature, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Cisco Intersight Onprem API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as X-Starship-Token (cookieAuth). It uses HTTP signature authentication (http_signature). It supports OAuth 2.0 (oAuth2) using the authorizationCode and clientCredentials flows, exposing 3315 scopes.

  • cookieAuth — The authentication cookie obtained from a Single-Sign-On SAML assertion.
  • http_signature — The 'HTTP signature' security scheme. Each HTTP request is cryptographically signed as specified in https://datatracker.ietf.org/doc/draft-cavage-http-signatur…
  • oAuth2 — The client uses the OAuth2 security scheme. To use OAuth2, a client application must be registered by creating a iam.AppRegistration resource. The user who cre…

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 8 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

onprem 12
GET
/api/v1/onprem/ApplianceSystemInfos
Read a 'onprem.ApplianceSystemInfo' resource.
GetOnpremApplianceSystemInfoList 11 params → 200400401403404default
GET
/api/v1/onprem/ApplianceSystemInfos/{Moid}
Read a 'onprem.ApplianceSystemInfo' resource.
GetOnpremApplianceSystemInfoByMoid 4 params → 200400401403404default
GET
/api/v1/onprem/AuditRecords
Read a 'onprem.AuditRecord' resource.
GetOnpremAuditRecordList 11 params → 200400401403404default
GET
/api/v1/onprem/AuditRecords/{Moid}
Read a 'onprem.AuditRecord' resource.
GetOnpremAuditRecordByMoid 4 params → 200400401403404default
GET
/api/v1/onprem/Upgrades
Read a 'onprem.Upgrade' resource.
GetOnpremUpgradeList 11 params → 200400401403404default
GET
/api/v1/onprem/Upgrades/{Moid}
Read a 'onprem.Upgrade' resource.
GetOnpremUpgradeByMoid 4 params → 200400401403404default
POST
/api/v1/onprem/Upgrades/{Moid}
Update a 'onprem.Upgrade' resource.
UpdateOnpremUpgrade 2 params body → 200400401403404default
PATCH
/api/v1/onprem/Upgrades/{Moid}
Update a 'onprem.Upgrade' resource.
PatchOnpremUpgrade 2 params body → 200400401403404default
GET
/api/v1/onprem/UserPreferences
Read a 'onprem.UserPreference' resource.
GetOnpremUserPreferenceList 11 params → 200400401403404default
GET
/api/v1/onprem/UserPreferences/{Moid}
Read a 'onprem.UserPreference' resource.
GetOnpremUserPreferenceByMoid 4 params → 200400401403404default
POST
/api/v1/onprem/UserPreferences/{Moid}
Update a 'onprem.UserPreference' resource.
UpdateOnpremUserPreference 2 params body → 200400401403404default
PATCH
/api/v1/onprem/UserPreferences/{Moid}
Update a 'onprem.UserPreference' resource.
PatchOnpremUserPreference 2 params body → 200400401403404default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are mo.BaseMo (15 properties), mo.Tag (7 properties), mo.MoRef (5 properties), PatchDocument (4 properties). Each schema is shown below with its type and property counts.

onprem.AuditRecord.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
onprem.UserPreference
Holder for UI preferences such as theme, columns.
mo.Tag
object
An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by assigning meta-data tags to any object.
7 properties
onprem.ApplianceSystemInfo.Response
The response body of a HTTP GET request for the 'onprem.ApplianceSystemInfo' resource. The value may be one of the following types. 1. When 'tag' is specified…
mo.AggregateTransform
The output of a request that includes the $apply query parameter. The schema of an aggregation query is dynamically determined based on the request query param…
PatchDocument
object
A JSONPatch document as defined by RFC 6902. A JSONPatch document can be used in a request body when the 'Content-Type' HTTP header is set to 'application/json…
4 properties 2 required
mo.BaseMo.Relationship
A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.
mo.BaseComplexType
object
BaseComplexType is a base abstract class for all complex types. All complex types inherit from this base type.
2 properties 3 required
onprem.UserPreference.Response
The response body of a HTTP GET request for the 'onprem.UserPreference' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
CsvFile
string
The content is a comma-separated list of values.
onprem.AuditRecord
AuditRecord presents the configuration changes made by the user per transaction.
onprem.Upgrade.Response
The response body of a HTTP GET request for the 'onprem.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
Error
object
4 properties 2 required
onprem.Upgrade
Upgrade tracks the Intersight Appliance's software upgrades. Intersight Appliance's upgrade service automatically creates an Upgrade managed object when there…
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties 3 required
onprem.UpgradePhase
UpgradePhase represents a phase of the Intersight Appliance software upgrade process. This data structure is shared by both the Intersight upgrade service and…
DisplayNames
objectnull
A set of display names for the MO resource. These names are calculated based on other properties of the MO and potentially properties of Ancestor MOs. Displayn…
mo.TagKeySummary
object
A summary of the Tag usage for an API resource. Tags are Key, Value pairs that can be assigned to API resources.
3 properties
onprem.ApplianceSystemInfo
ApplianceSystemInfo managed object stores the Intersight Appliance System information. It is created during the Intersight Appliance setup. It is updated perio…
mo.VersionContext
VersionContext contains the versioning info for an object.
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties 3 required
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
onprem.ApplianceSystemInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
onprem.UserPreference.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property 1 required
onprem.AuditRecord.Response
The response body of a HTTP GET request for the 'onprem.AuditRecord' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
onprem.Upgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intersight-onprem-api-openapi.yml Raw ↑

Other APIs Cisco Intersight publishes across the network.

Cisco Intersight Aaa API
Cisco Intersight Access API
Cisco Intersight Adapter API
Cisco Intersight Apiproxy API
Cisco Intersight Appliance API
Cisco Intersight Asset API
Cisco Intersight Auditd API
Cisco Intersight Bios API
Cisco Intersight Boot API
Cisco Intersight Bulk API
Cisco Intersight Capability API
Cisco Intersight Catalystsdwan API
Where this information came from

This is an independent, third-party profile of Cisco Intersight Onprem API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.