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 Kvm API

The kvm API from Cisco Intersight — 10 operation(s) for kvm.

Cisco Intersight Kvm 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 KVM. 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 22 operations across 10 paths, and defines 63 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}.

22 operations 10 paths 63 schemas 2 DELETE10 GET3 PATCH7 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 Kvm 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 22

Across 10 paths, the API surfaces 22 operations — 2 DELETE, 10 GET, 3 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

kvm 22
GET
/api/v1/kvm/Policies
Read a 'kvm.Policy' resource.
GetKvmPolicyList 11 params → 200400401403404default
POST
/api/v1/kvm/Policies
Create a 'kvm.Policy' resource.
CreateKvmPolicy 2 params body → 200400401403404default
GET
/api/v1/kvm/Policies/{Moid}
Read a 'kvm.Policy' resource.
GetKvmPolicyByMoid 4 params → 200400401403404default
POST
/api/v1/kvm/Policies/{Moid}
Update a 'kvm.Policy' resource.
UpdateKvmPolicy 2 params body → 200400401403404default
PATCH
/api/v1/kvm/Policies/{Moid}
Update a 'kvm.Policy' resource.
PatchKvmPolicy 2 params body → 200400401403404default
DELETE
/api/v1/kvm/Policies/{Moid}
Delete a 'kvm.Policy' resource.
DeleteKvmPolicy 1 param → 200400401403404default
GET
/api/v1/kvm/PolicyInventories
Read a 'kvm.PolicyInventory' resource.
GetKvmPolicyInventoryList 11 params → 200400401403404default
GET
/api/v1/kvm/PolicyInventories/{Moid}
Read a 'kvm.PolicyInventory' resource.
GetKvmPolicyInventoryByMoid 4 params → 200400401403404default
POST
/api/v1/kvm/Sessions
Create a 'kvm.Session' resource.
CreateKvmSession 2 params body → 200400401403404default
GET
/api/v1/kvm/Sessions
Read a 'kvm.Session' resource.
GetKvmSessionList 11 params → 200400401403404default
GET
/api/v1/kvm/Sessions/{Moid}
Read a 'kvm.Session' resource.
GetKvmSessionByMoid 4 params → 200400401403404default
POST
/api/v1/kvm/Sessions/{Moid}
Update a 'kvm.Session' resource.
UpdateKvmSession 2 params body → 200400401403404default
PATCH
/api/v1/kvm/Sessions/{Moid}
Update a 'kvm.Session' resource.
PatchKvmSession 2 params body → 200400401403404default
POST
/api/v1/kvm/Tunnels
Create a 'kvm.Tunnel' resource.
CreateKvmTunnel 2 params body → 200400401403404default
GET
/api/v1/kvm/Tunnels
Read a 'kvm.Tunnel' resource.
GetKvmTunnelList 11 params → 200400401403404default
GET
/api/v1/kvm/Tunnels/{Moid}
Read a 'kvm.Tunnel' resource.
GetKvmTunnelByMoid 4 params → 200400401403404default
GET
/api/v1/kvm/TunneledKvmPolicies
Read a 'kvm.TunneledKvmPolicy' resource.
GetKvmTunneledKvmPolicyList 11 params → 200400401403404default
POST
/api/v1/kvm/TunneledKvmPolicies
Create a 'kvm.TunneledKvmPolicy' resource.
CreateKvmTunneledKvmPolicy 2 params body → 200400401403404default
GET
/api/v1/kvm/TunneledKvmPolicies/{Moid}
Read a 'kvm.TunneledKvmPolicy' resource.
GetKvmTunneledKvmPolicyByMoid 4 params → 200400401403404default
POST
/api/v1/kvm/TunneledKvmPolicies/{Moid}
Update a 'kvm.TunneledKvmPolicy' resource.
UpdateKvmTunneledKvmPolicy 2 params body → 200400401403404default
PATCH
/api/v1/kvm/TunneledKvmPolicies/{Moid}
Update a 'kvm.TunneledKvmPolicy' resource.
PatchKvmTunneledKvmPolicy 2 params body → 200400401403404default
DELETE
/api/v1/kvm/TunneledKvmPolicies/{Moid}
Delete a 'kvm.TunneledKvmPolicy' resource.
DeleteKvmTunneledKvmPolicy 1 param → 200400401403404default

Schemas 63

The contract defines 63 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.
compute.Physical
Abstract class for all physical servers.
kvm.Session.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
kvm.Session.Response
The response body of a HTTP GET request for the 'kvm.Session' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
kvm.PolicyInventory.Response
The response body of a HTTP GET request for the 'kvm.PolicyInventory' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
inventory.JobInfo
The runtime information about a job scheduled on a managed device.
kvm.Tunnel.Response
The response body of a HTTP GET request for the 'kvm.Tunnel' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
kvm.Session
Virtual KVM Session that provides Single Sign-On access to the vKVM console of the server. The vKVM access can be direct or can be tunneled by specifying the t…
compute.Physical.Relationship
A relationship to the 'compute.Physical' resource, or the expanded 'compute.Physical' resource, or the 'null' value.
kvm.Policy
The Virtual KVM Policy is a reusable policy used to configure the virtual Keyboard, Video, and Mouse (KVM) settings for a server. Purpose The purpose of this p…
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…
boot.UsbDevice.Relationship
A relationship to the 'boot.UsbDevice' resource, or the expanded 'boot.UsbDevice' resource, or the 'null' value.
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…
kvm.TunneledKvmPolicy
The TunneledKvmPolicy object manages policies controlling tunneled vKVM access within the account. This provides configuration options for enabling or disablin…
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.
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.
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…
kvm.Policy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
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.
kvm.Tunnel.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
equipment.Identity
An abstract object for performing and tracking lifecycle operations (e.g. discovery, recommission, decommission) on rack-mount equipment such as server, chassi…
kvm.TunneledKvmPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
kvm.PolicyInventory.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
kvm.PolicyInventory
The Virtual KVM Policy is a reusable policy used to configure the virtual Keyboard, Video, and Mouse (KVM) settings for a server. Purpose The purpose of this p…
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…
boot.SdDevice.Relationship
A relationship to the 'boot.SdDevice' resource, or the expanded 'boot.SdDevice' resource, or the 'null' value.
kvm.Tunnel.Relationship
A relationship to the 'kvm.Tunnel' resource, or the expanded 'kvm.Tunnel' resource, or the 'null' value.
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…
boot.VmediaDevice.Relationship
A relationship to the 'boot.VmediaDevice' resource, or the expanded 'boot.VmediaDevice' resource, or the 'null' value.
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.…
inventory.Base
Base class for all inventory MOs.
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…
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…
kvm.Session.Relationship
A relationship to the 'kvm.Session' resource, or the expanded 'kvm.Session' resource, or the 'null' value.
equipment.Base
Abstract base class for all equipments which have a vendor /model / serial.
kvm.Tunnel
The Tunnel object provides tunneled virtual KVM access for server, enhancing security and flexibility. It supports the creation and management of tunnels for e…
boot.ConfiguredDevice
Abstract class for all configured boot devices.
equipment.PhysicalIdentity
An Abstract Identity object that uniquely represents a server object under a DR.
kvm.TunneledKvmPolicy.Response
The response body of a HTTP GET request for the 'kvm.TunneledKvmPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
equipment.Fru.Relationship
A relationship to the 'equipment.Fru' resource, or the expanded 'equipment.Fru' resource, or the 'null' value.
kvm.Policy.Response
The response body of a HTTP GET request for the 'kvm.Policy' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
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.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intersight-kvm-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 Kvm 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.