Cisco Intersight Os API
The os API from Cisco Intersight — 17 operation(s) for os.
Cisco Intersight Os 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 Os. 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 23 operations across 17 paths, and defines 94 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}.
23 operations
17 paths
94 schemas
1 DELETE14 GET1 PATCH7 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Os 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 23
Across 17 paths, the API surfaces 23 operations — 1 DELETE, 14 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.
os 23
GET
/api/v1/os/BulkInstallInfos
Read a 'os.BulkInstallInfo' resource.
POST
/api/v1/os/BulkInstallInfos
Create a 'os.BulkInstallInfo' resource.
GET
/api/v1/os/BulkInstallInfos/{Moid}
Read a 'os.BulkInstallInfo' resource.
GET
/api/v1/os/Catalogs
Read a 'os.Catalog' resource.
GET
/api/v1/os/Catalogs/{Moid}
Read a 'os.Catalog' resource.
GET
/api/v1/os/ConfigurationFiles
Read a 'os.ConfigurationFile' resource.
POST
/api/v1/os/ConfigurationFiles
Create a 'os.ConfigurationFile' resource.
GET
/api/v1/os/ConfigurationFiles/{Moid}
Read a 'os.ConfigurationFile' resource.
DELETE
/api/v1/os/ConfigurationFiles/{Moid}
Delete a 'os.ConfigurationFile' resource.
POST
/api/v1/os/ConfigurationFiles/{Moid}
Update a 'os.ConfigurationFile' resource.
PATCH
/api/v1/os/ConfigurationFiles/{Moid}
Update a 'os.ConfigurationFile' resource.
GET
/api/v1/os/Distributions
Read a 'os.Distribution' resource.
GET
/api/v1/os/Distributions/{Moid}
Read a 'os.Distribution' resource.
GET
/api/v1/os/Installs
Read a 'os.Install' resource.
POST
/api/v1/os/Installs
Create a 'os.Install' resource.
GET
/api/v1/os/Installs/{Moid}
Read a 'os.Install' resource.
POST
/api/v1/os/OsSupports
Create a 'os.OsSupport' resource.
GET
/api/v1/os/SupportedVersions
Read a 'os.SupportedVersion' resource.
GET
/api/v1/os/SupportedVersions/{Moid}
Read a 'os.SupportedVersion' resource.
POST
/api/v1/os/TemplateFiles
Create a 'os.TemplateFile' resource.
POST
/api/v1/os/ValidInstallTargets
Create a 'os.ValidInstallTarget' resource.
GET
/api/v1/os/ValidRemoteTargets
Read a 'os.ValidRemoteTarget' resource.
GET
/api/v1/os/ValidRemoteTargets/{Moid}
Read a 'os.ValidRemoteTarget' resource.
Schemas 94
The contract defines 94 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.
boot.HddDevice.Relationship
A relationship to the 'boot.HddDevice' resource, or the expanded 'boot.HddDevice' resource, or the 'null' value.
os.OperatingSystemParameters
Installation parameters specific to selected OS.
compute.Physical
Abstract class for all physical servers.
os.ConfigurationFile
ConfigurationFiles are operating system “answer files” used to enable unattended OS installation (for example, kickstart, unattended XML, or cloud-init/seed-st…
firmware.BaseDistributable
An image distributed by Cisco.
os.ConfigurationFile.Response
The response body of a HTTP GET request for the 'os.ConfigurationFile' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
os.Distribution.Relationship
A relationship to the 'os.Distribution' resource, or the expanded 'os.Distribution' resource, or the 'null' value.
os.Catalog
The Catalog object is an integral component of the operating system management framework, specifically designed to handle collections of operating system-relat…
boot.NvmeDevice
The boot.NvmeDevice object represents an NVMe (Non-Volatile Memory Express) drive as a configurable boot option within a server's boot policy. Purpose The Nvme…
boot.DeviceBootSecurity.Relationship
A relationship to the 'boot.DeviceBootSecurity' resource, or the expanded 'boot.DeviceBootSecurity' resource, or the 'null' value.
os.FibreChannelResponse
FibreChannel LUN response for UI.
os.Catalog.Relationship
A relationship to the 'os.Catalog' resource, or the expanded 'os.Catalog' resource, or the 'null' value.
inventory.JobInfo
The runtime information about a job scheduled on a managed device.
firmware.ComponentMeta
Contains the details for each component in the HSU bundle catalog.
os.VirtualDriveResponse
Virtual Drive target entry for the UI.
os.Install.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
compute.Physical.Relationship
A relationship to the 'compute.Physical' resource, or the expanded 'compute.Physical' resource, or the 'null' value.
os.ValidRemoteTarget.Response
The response body of a HTTP GET request for the 'os.ValidRemoteTarget' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
boot.UefiShellDevice.Relationship
A relationship to the 'boot.UefiShellDevice' resource, or the expanded 'boot.UefiShellDevice' resource, or the 'null' value.
compute.Vmedia
The compute.vMedia object represents the virtual media configuration and inventory for a server. It acts as a container for virtual media settings and any curr…
os.BulkInstallInfo.Response
The response body of a HTTP GET request for the 'os.BulkInstallInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
boot.UsbDevice.Relationship
A relationship to the 'boot.UsbDevice' resource, or the expanded 'boot.UsbDevice' resource, or the 'null' value.
os.PlaceHolder
Definition for place holders in templates/post install scripts.
equipment.Fru
The equipment.Fru object represents a Field-Replaceable Unit (FRU). It is a special object used to track the history and state changes of hardware components t…
os.ValidationInformation
Used to show the state of the CSV validaton and its state.
firmware.ServerConfigurationUtilityDistributable
A server configuration utility image distributed by Cisco.
compute.RecoveryKeyDetails
Migration Key Information of the server.
boot.CddDevice.Relationship
A relationship to the 'boot.CddDevice' resource, or the expanded 'boot.CddDevice' resource, or the 'null' value.
firmware.DistributableMeta
Meta information for various firmware images stored in the database. Gives information on the particular category for a product.
boot.CddDevice
The boot.CddDevice object represents a CD/DVD drive as a configurable boot option within a server's boot policy. Purpose The CddDevice object allows for the in…
boot.SanDevice.Relationship
A relationship to the 'boot.SanDevice' resource, or the expanded 'boot.SanDevice' resource, or the 'null' value.
os.IscsiLunResponse
ISCSI LUN response for UI.
os.Answers
This MO captures the values for the most common set of fields in OS specific answer files. The values provided in this MO are used to construct the OS specific…
os.Catalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
boot.VmediaDevice
The boot.VmediaDevice object represents a virtual media device as a configurable boot option within a server's boot policy. Virtual media allows mounting of a…
compute.AlarmSummary
The summary of alarm counts based on alarm serverity.
inventory.DeviceInfo.Relationship
A relationship to the 'inventory.DeviceInfo' resource, or the expanded 'inventory.DeviceInfo' resource, or the 'null' value.
os.RemoteTargetResponse
Remote Install target type for the flat array for Orchestration UI.
os.SupportedVersion
The SupportedVersion object provides information on operating system versions supported by the Server Configuration Utility (SCU). It is essential for UI opera…
boot.UsbDevice
Usb Boot Device configured on the server.
compute.IpAddress
Complex type representing an IP address in UCSM.
inventory.DeviceInfo
Information pertaining to a Registered Device in Intersight which is pertinent to Inventory Microservice.
boot.DeviceBootSecurity
The boot.DeviceBootSecurity object represents the user-configured state of UEFI Secure Boot for a server, as defined in its boot policy. Purpose This object's…
boot.PxeDevice.Relationship
A relationship to the 'boot.PxeDevice' resource, or the expanded 'boot.PxeDevice' resource, or the 'null' value.
os.Catalog.Response
The response body of a HTTP GET request for the 'os.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
equipment.Identity
An abstract object for performing and tracking lifecycle operations (e.g. discovery, recommission, decommission) on rack-mount equipment such as server, chassi…
os.Install.Response
The response body of a HTTP GET request for the 'os.Install' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
firmware.DistributableMeta.Relationship
A relationship to the 'firmware.DistributableMeta' resource, or the expanded 'firmware.DistributableMeta' resource, or the 'null' value.
os.Distribution.Response
The response body of a HTTP GET request for the 'os.Distribution' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
compute.MigrationKeyInfo
Details about the migration key that gets utilized during the server profile migration process.
boot.PxeDevice
The boot.PxeDevice object represents a Preboot Execution Environment (PXE) network interface as a configurable boot option within a server's boot policy. Purpo…
boot.NvmeDevice.Relationship
A relationship to the 'boot.NvmeDevice' resource, or the expanded 'boot.NvmeDevice' resource, or the 'null' value.
boot.IscsiDevice.Relationship
A relationship to the 'boot.IscsiDevice' resource, or the expanded 'boot.IscsiDevice' resource, or the 'null' value.
boot.HddDevice
The boot.HddDevice object represents a local hard disk drive (HDD) or logical volume as a configurable boot option within a server's boot policy. Purpose The H…
os.SupportedVersion.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
boot.SdDevice.Relationship
A relationship to the 'boot.SdDevice' resource, or the expanded 'boot.SdDevice' resource, or the 'null' value.
firmware.ServerConfigurationUtilityDistributable.Relationship
A relationship to the 'firmware.ServerConfigurationUtilityDistributable' resource, or the expanded 'firmware.ServerConfigurationUtilityDistributable' resource,…
os.InstallTarget
Install Target upon which Operating System is installed.
boot.SanDevice
The boot.SanDevice object represents a Storage Area Network (SAN) LUN (Logical Unit Number) as a configurable boot option within a server's boot policy. Purpos…
boot.IscsiDevice
The boot.IscsiDevice object represents an iSCSI LUN (Logical Unit Number) as a configurable boot option within a server's boot policy. It allows a server to bo…
os.OsSupport
The OsSupport object is designed to validate the support status of a specific operating system version within Intersight. It ensures compatibility and readines…
boot.VmediaDevice.Relationship
A relationship to the 'boot.VmediaDevice' resource, or the expanded 'boot.VmediaDevice' resource, or the 'null' value.
os.SupportedVersion.Response
The response body of a HTTP GET request for the 'os.SupportedVersion' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
boot.UefiShellDevice
The boot.UefiShellDevice object represents the UEFI (Unified Extensible Firmware Interface) Shell as a configurable boot option within a server's boot policy.…
os.BaseInstallConfig
BaseInstallConfig models the configuration required to install OS.
os.IpConfiguration
The IP configuration used to configure Static IPv4/IPv6 configurations.
inventory.Base
Base class for all inventory MOs.
os.ConfigurationFile.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
boot.PchStorageDevice.Relationship
A relationship to the 'boot.PchStorageDevice' resource, or the expanded 'boot.PchStorageDevice' resource, or the 'null' value.
boot.PchStorageDevice
The boot.PchStorageDevice object represents a storage device connected to the Platform Controller Hub (PCH) as a configurable boot option within a server's boo…
os.ValidInstallTarget
ValidInstallTargets are on-demand “discovery response” objects used to fetch and return the set of valid local install targets for one or more servers. The res…
compute.Mapping
The compute.Mapping object represents a single virtual media image that has been uploaded or mapped to a server. This provides the inventory details for a spec…
equipment.Base.Relationship
A relationship to the 'equipment.Base' resource, or the expanded 'equipment.Base' resource, or the 'null' value.
compute.Mapping.Relationship
A relationship to the 'compute.Mapping' resource, or the expanded 'compute.Mapping' resource, or the 'null' value.
boot.SdDevice
The boot.SdDevice object represents an SD (Secure Digital) card as a configurable boot option within a server's boot policy. This typically refers to an intern…
os.BulkInstallInfo
The BulkInstallInfo object is a critical element in the automation of operating system installations across multiple servers. It models the content of CSV file…
os.PhysicalDiskResponse
Physical Disk target entry for the UI.
os.ValidRemoteTarget
ValidRemoteTargets provide validated remote boot/install targets for a server based on its server profile, focusing on SAN/iSCSI paths. The results enumerate r…
os.ServerConfig
The server level OS install parameter for the uploaded CSV file.
os.ConfigurationFile.Relationship
A relationship to the 'os.ConfigurationFile' resource, or the expanded 'os.ConfigurationFile' resource, or the 'null' value.
equipment.Base
Abstract base class for all equipments which have a vendor /model / serial.
boot.ConfiguredDevice
Abstract class for all configured boot devices.
os.Distribution.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
equipment.PhysicalIdentity
An Abstract Identity object that uniquely represents a server object under a DR.
os.ValidRemoteTarget.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
os.Distribution
The Distribution object encompasses the details of operating system distributions that are validated and supported by Intersight for automated installation. It…
equipment.Fru.Relationship
A relationship to the 'equipment.Fru' resource, or the expanded 'equipment.Fru' resource, or the 'null' value.
os.TemplateFile
The TemplateFile object is a specialized component that encapsulates OS-specific answer files for unattended installations. It supports both static and templat…
os.InstallTargetResponse
Install target generic type for the flat array for Orchestration UI.
os.Install
The Install object is the execution point for initiating operating system installations on target servers. It models the necessary configuration and relationsh…
os.BulkInstallInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
equipment.PhysicalIdentity.Relationship
A relationship to the 'equipment.PhysicalIdentity' resource, or the expanded 'equipment.PhysicalIdentity' resource, or the 'null' value.
compute.Vmedia.Relationship
A relationship to the 'compute.Vmedia' resource, or the expanded 'compute.Vmedia' resource, or the 'null' value.
os.GlobalConfig
The Global configuration parameter for the uploaded CSV file for OS Install.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cisco Intersight 12
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
#Os
Where this information came from
This is an independent, third-party profile of Cisco Intersight Os 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.