Cisco Intersight Hci API
The hci API from Cisco Intersight — 46 operation(s) for hci.
Cisco Intersight Hci 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 HCI. 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 56 operations across 46 paths, and defines 270 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}.
56 operations
46 paths
270 schemas
46 GET5 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Hci 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 56
Across 46 paths, the API surfaces 56 operations — 46 GET, 5 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
hci 56
GET
/api/v1/hci/AhvVms
Read a 'hci.AhvVm' resource.
GET
/api/v1/hci/AhvVms/{Moid}
Read a 'hci.AhvVm' resource.
POST
/api/v1/hci/AhvVms/{Moid}
Update a 'hci.AhvVm' resource.
PATCH
/api/v1/hci/AhvVms/{Moid}
Update a 'hci.AhvVm' resource.
GET
/api/v1/hci/AhvVmDisks
Read a 'hci.AhvVmDisk' resource.
GET
/api/v1/hci/AhvVmDisks/{Moid}
Read a 'hci.AhvVmDisk' resource.
GET
/api/v1/hci/AhvVmGpus
Read a 'hci.AhvVmGpu' resource.
GET
/api/v1/hci/AhvVmGpus/{Moid}
Read a 'hci.AhvVmGpu' resource.
GET
/api/v1/hci/AhvVmNics
Read a 'hci.AhvVmNic' resource.
GET
/api/v1/hci/AhvVmNics/{Moid}
Read a 'hci.AhvVmNic' resource.
GET
/api/v1/hci/Alarms
Read a 'hci.Alarm' resource.
GET
/api/v1/hci/Alarms/{Moid}
Read a 'hci.Alarm' resource.
GET
/api/v1/hci/Clusters
Read a 'hci.Cluster' resource.
GET
/api/v1/hci/Clusters/{Moid}
Read a 'hci.Cluster' resource.
POST
/api/v1/hci/Clusters/{Moid}
Update a 'hci.Cluster' resource.
PATCH
/api/v1/hci/Clusters/{Moid}
Update a 'hci.Cluster' resource.
GET
/api/v1/hci/ClusterOperations
Read a 'hci.ClusterOperation' resource.
GET
/api/v1/hci/ClusterOperations/{Moid}
Read a 'hci.ClusterOperation' resource.
POST
/api/v1/hci/ClusterOperations/{Moid}
Update a 'hci.ClusterOperation' resource.
PATCH
/api/v1/hci/ClusterOperations/{Moid}
Update a 'hci.ClusterOperation' resource.
GET
/api/v1/hci/Compliances
Read a 'hci.Compliance' resource.
GET
/api/v1/hci/Compliances/{Moid}
Read a 'hci.Compliance' resource.
GET
/api/v1/hci/Disks
Read a 'hci.Disk' resource.
GET
/api/v1/hci/Disks/{Moid}
Read a 'hci.Disk' resource.
GET
/api/v1/hci/DomainManagers
Read a 'hci.DomainManager' resource.
GET
/api/v1/hci/DomainManagers/{Moid}
Read a 'hci.DomainManager' resource.
GET
/api/v1/hci/Entitlements
Read a 'hci.Entitlement' resource.
GET
/api/v1/hci/Entitlements/{Moid}
Read a 'hci.Entitlement' resource.
GET
/api/v1/hci/EsxiVms
Read a 'hci.EsxiVm' resource.
GET
/api/v1/hci/EsxiVms/{Moid}
Read a 'hci.EsxiVm' resource.
POST
/api/v1/hci/EsxiVms/{Moid}
Update a 'hci.EsxiVm' resource.
PATCH
/api/v1/hci/EsxiVms/{Moid}
Update a 'hci.EsxiVm' resource.
GET
/api/v1/hci/EsxiVmDisks
Read a 'hci.EsxiVmDisk' resource.
GET
/api/v1/hci/EsxiVmDisks/{Moid}
Read a 'hci.EsxiVmDisk' resource.
GET
/api/v1/hci/EsxiVmNics
Read a 'hci.EsxiVmNic' resource.
GET
/api/v1/hci/EsxiVmNics/{Moid}
Read a 'hci.EsxiVmNic' resource.
GET
/api/v1/hci/ExternalStorages
Read a 'hci.ExternalStorage' resource.
GET
/api/v1/hci/ExternalStorages/{Moid}
Read a 'hci.ExternalStorage' resource.
GET
/api/v1/hci/Gpus
Read a 'hci.Gpu' resource.
GET
/api/v1/hci/Gpus/{Moid}
Read a 'hci.Gpu' resource.
GET
/api/v1/hci/Licenses
Read a 'hci.License' resource.
GET
/api/v1/hci/Licenses/{Moid}
Read a 'hci.License' resource.
GET
/api/v1/hci/NccCheckPolicies
Read a 'hci.NccCheckPolicy' resource.
GET
/api/v1/hci/NccCheckPolicies/{Moid}
Read a 'hci.NccCheckPolicy' resource.
GET
/api/v1/hci/Nodes
Read a 'hci.Node' resource.
GET
/api/v1/hci/Nodes/{Moid}
Read a 'hci.Node' resource.
POST
/api/v1/hci/Nodes/{Moid}
Update a 'hci.Node' resource.
PATCH
/api/v1/hci/Nodes/{Moid}
Update a 'hci.Node' resource.
GET
/api/v1/hci/PhysicalGpus
Read a 'hci.PhysicalGpu' resource.
GET
/api/v1/hci/PhysicalGpus/{Moid}
Read a 'hci.PhysicalGpu' resource.
GET
/api/v1/hci/StorageContainers
Read a 'hci.StorageContainer' resource.
GET
/api/v1/hci/StorageContainers/{Moid}
Read a 'hci.StorageContainer' resource.
GET
/api/v1/hci/Violations
Read a 'hci.Violation' resource.
GET
/api/v1/hci/Violations/{Moid}
Read a 'hci.Violation' resource.
GET
/api/v1/hci/VirtualGpus
Read a 'hci.VirtualGpu' resource.
GET
/api/v1/hci/VirtualGpus/{Moid}
Read a 'hci.VirtualGpu' resource.
Schemas 270
The contract defines 270 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.
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
x509.Certificate
The representation of an X.509 certificate.
hci.VirtualGpu
Virtual GPU managed by a cluster and reported by Prism Central.
hci.Entitlement.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.AbstractPolicy.Relationship
A relationship to the 'policy.AbstractPolicy' resource, or the expanded 'policy.AbstractPolicy' resource, or the 'null' value.
iam.System.Relationship
A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.
hci.Violation
The Violation object identifies instances of license violations within Nutanix Prism Central. This provides information for tracking license violation issues.…
mo.BaseMo.Relationship
A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.
iam.ResourceRoles.Relationship
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
hci.AhvVmDisk.Response
The response body of a HTTP GET request for the 'hci.AhvVmDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
hci.AhvVmDisk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.GeoLocation.Relationship
A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.
iam.SwitchAccountPermission
SwitchScope parameters related to the Account to/from which user switched.
hci.StorageContainer.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.ExternalStorage.Response
The response body of a HTTP GET request for the 'hci.ExternalStorage' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hci.PhysicalGpu.Response
The response body of a HTTP GET request for the 'hci.PhysicalGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
hci.DomainManager.Relationship
A relationship to the 'hci.DomainManager' resource, or the expanded 'hci.DomainManager' resource, or the 'null' value.
iam.EndPointPrivilege
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
hci.NccConfigurableParameter
NCC policy parameters that is configurable by a user.
iam.LdapPolicy
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
iam.ApiKey.Relationship
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
hci.ConfigurableParamValue
Value for a configurable parameter.
hci.Alarm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAccessManagement.Relationship
A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.
policy.ReportedPolicyChange
A policy change that has been reported to a profile.
Error
object
4 properties
2 required
iam.DefaultPermissionInfo
Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.
iam.TrustPoint.Relationship
A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.
hci.Node.Response
The response body of a HTTP GET request for the 'hci.Node' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
asset.AlarmSummary
The summary of alarm counts based on alarm serverity.
iam.UserSetting.Relationship
A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.
policy.AbstractConfigProfile.Relationship
A relationship to the 'policy.AbstractConfigProfile' resource, or the expanded 'policy.AbstractConfigProfile' resource, or the 'null' value.
iam.AppCredentials
Contains credentials information for a particular client application.
resource.Selector
Complex type representing the filter condition to extract the resources.
hci.BaseVm
A base VM reported by Prism Central.
hci.AlarmSummary
The summary of alarm counts based on alarm severity.
hci.Compliance.Response
The response body of a HTTP GET request for the 'hci.Compliance' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
policy.ActionParam
An action parameter setting as a key/value pair.
iam.UserPreference
UserPreference captures user interface preferences—such as layout, view state, or theme—persisted per user and identity context. Purpose It enables consistent,…
hci.PhysicalGpu.Relationship
A relationship to the 'hci.PhysicalGpu' resource, or the expanded 'hci.PhysicalGpu' resource, or the 'null' value.
iam.ResourcePermission
ResourcePermission represents the permissions defined on a resource like organization.
iam.LdapMeta
LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration. Purpose It provides system-managed insight in…
hci.BackplaneNetworkParams
The backplane network parameters.
mo.VersionContext
VersionContext contains the versioning info for an object.
hci.Node.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.SessionLimits.Relationship
A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.
hci.NccCheckPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Privilege.Relationship
A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.
iam.ClientMeta
Contains meta information of the client. Currently it is used only within OAuth clients.
asset.ServiceOptions
ServiceOptions captures configuration that is specific to a target type for a specific service.
hci.Cluster.Relationship
A relationship to the 'hci.Cluster' resource, or the expanded 'hci.Cluster' resource, or the 'null' value.
hci.DomainManager.Response
The response body of a HTTP GET request for the 'hci.DomainManager' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
hci.License.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
policy.AbstractProfile.Relationship
A relationship to the 'policy.AbstractProfile' resource, or the expanded 'policy.AbstractProfile' resource, or the 'null' value.
iam.UserGroup
UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion. Purpose UserGroup sim…
asset.Credential
A credential which can be used to authenticate with a managed target.
pkix.DistinguishedName
The identifier for the owner of an X.509 certificate and the authority that issued the certificate.
hci.IpAddressOrFqdn
An IP address that can be either IPv4 or IPv6.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
hci.EsxiVmNic.Relationship
A relationship to the 'hci.EsxiVmNic' resource, or the expanded 'hci.EsxiVmNic' resource, or the 'null' value.
hci.StorageContainer.Relationship
A relationship to the 'hci.StorageContainer' resource, or the expanded 'hci.StorageContainer' resource, or the 'null' value.
iam.Permission
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
resource.Reservation
The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation. Purpose…
iam.TrustPoint
The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication. Purpose A TrustPoint ser…
asset.GeoLocation
The geographic location of a managed target.
iam.Idp.Relationship
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
policy.ConfigChangeDetailType
Defines the details of a configuration change including change type, disruption and description of the change.
iam.Role
A role is a collection of privilege sets that are assigned to a user using a permission object.
asset.SudiInfo
The SUDI is an X.509v3 certificate, which maintains the product identifier and serial number. The identity is implemented at manufacturing and chained to a pub…
asset.DeviceConnection
An abstract class that holds the details of a device connectors connection to Intersight.
hci.AhvVmNic.Relationship
A relationship to the 'hci.AhvVmNic' resource, or the expanded 'hci.AhvVmNic' resource, or the 'null' value.
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
hci.Consumption
A license's consumption detail by a cluster.
iam.IpAddress
IpAddress represents a single allowlisted IP, CIDR block, or range used by IpAccessManagement. Purpose It models an individual entry in the IP access policy to…
hci.DomainManager
The DomainManager object represents the Nutanix Prism Central instance managing multiple clusters. Purpose The DomainManager object reports basic information a…
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
hci.LicensedService
The compliance state of a licensed service.
iam.Account
The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions. Pu…
hci.EsxiVmDisk.Relationship
A relationship to the 'hci.EsxiVmDisk' resource, or the expanded 'hci.EsxiVmDisk' resource, or the 'null' value.
iam.PrivilegeSet
A collection of privileges.
hci.VirtualGpuConfig
The configuration of a virtual GPU.
CsvFile
string
The content is a comma-separated list of values.
resource.Group.Relationship
A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.
session.AbstractSession
A base abstract class for all sessions.
hci.BaseVm.Relationship
A relationship to the 'hci.BaseVm' resource, or the expanded 'hci.BaseVm' resource, or the 'null' value.
iam.Permission.Relationship
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
hci.EsxiVmNic.Response
The response body of a HTTP GET request for the 'hci.EsxiVmNic' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
iam.AbstractQualifier.Relationship
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
iam.SecurityHolder.Relationship
A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.
policy.ActionQualifier
Action qualifiers can be used to control actions that are performed on a profile object. For example - perform a 'Deploy' action only for specific policies.
hci.Violation.Response
The response body of a HTTP GET request for the 'hci.Violation' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
asset.DeviceClaim
DeviceClaim captures the intent to claim a device to an Intersight account. A device can be unclaimed by performing a DELETE on a DeviceClaim instance. When pe…
iam.OAuthToken
The meta data for generating OAuth2 token of a user. It is created when user logged in via OAuth2 using Authorization Code grant and deleted upon logout, expir…
iam.Idp
The SAML identity provider such as Cisco, that has been used to log in to Intersight.
iam.AbstractClientApplication.Relationship
A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.
hci.EsxiVmDisk
A disk associated with an ESXi VM.
resource.Reservation.Relationship
A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.
hci.VirtualGpu.Relationship
A relationship to the 'hci.VirtualGpu' resource, or the expanded 'hci.VirtualGpu' resource, or the 'null' value.
iam.ResourceRoles
ResourceRoles maps roles to a specific resource (e.g., an organization) within a permission, shaping the effective access model. Purpose It provides fine-grain…
iam.DomainGroup.Relationship
A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.
hci.DomainManager.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AhvVm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.Gpu.Response
The response body of a HTTP GET request for the 'hci.Gpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query, t…
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
hci.Violation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
hci.Cluster.Response
The response body of a HTTP GET request for the 'hci.Cluster' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
policy.AbstractPolicy
A base abstract class for all configuration policies that can be applied to service profiles.
hci.Alarm.Response
The response body of a HTTP GET request for the 'hci.Alarm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
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
hci.EntitlementDetail
The detail of a license entitlement detail.
hci.FaultToleranceState
The state of fault tolerance of a cluster.
policy.AbstractConfigurationObject
Abstract base type for all configuration objects. All logical objects like profiles, policies, policy items like vnic, vhba and templates extend from this type…
hci.ClusterOperation.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.AbstractReservation
You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are mainta…
asset.DeviceRegistration
The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the manage…
hci.IpAddress
An IP address that can be either IPv4 or IPv6.
iam.SwitchScopePermissions
SwitchScope parameters related to the Account to which user switched to.
iam.ResourceLimits
ResourceLimits establishes account-level limits and policies for identity-related resources and credentials. Purpose It ensures controlled growth and predictab…
iam.ServiceProvider
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
hci.SoftwareType
The type and version information of a software.
hci.EsxiVm
An ESXi VM reported by Prism Central.
iam.AbstractQualifier
Placeholder for different types of qualifiers.
hci.Violation.Relationship
A relationship to the 'hci.Violation' resource, or the expanded 'hci.Violation' resource, or the 'null' value.
iam.PermissionToRoles
Complex type representing a permission and its associated roles.
iam.SessionLimits
The session related configuration limits.
hci.Gpu.Relationship
A relationship to the 'hci.Gpu' resource, or the expanded 'hci.Gpu' resource, or the 'null' value.
iam.LdapDnsParameters
DNS settings used to access LDAP Providers.
iam.IdpReference
The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.…
hci.EsxiVm.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.LdapGroup
The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint. Purpose The purpose is to grant per…
hci.ExternalStorage.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.License.Relationship
A relationship to the 'hci.License' resource, or the expanded 'hci.License' resource, or the 'null' value.
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…
iam.DomainGroup
Intersight services are mapped to three different categories of services for scaling purpose. Three categories are defined: Partition1/Partition2/Partition3. T…
iam.UserGroup.Relationship
A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.
iam.AppRegistration.Relationship
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.
hci.ExternalStorage.Relationship
A relationship to the 'hci.ExternalStorage' resource, or the expanded 'hci.ExternalStorage' resource, or the 'null' value.
hci.AhvVmNic.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Session.Relationship
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
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
iam.ApiKey
The ApiKey object is a critical component for secure authentication and authorization within the system. It allows clients to make API requests programmaticall…
organization.Organization
Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using r…
asset.DeviceClaim.Relationship
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.
hci.AhvGuestTools
The details of the Nutanix Guest Tools.
iam.SecurityHolder
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
hci.Gpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourcePermission.Relationship
A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.
asset.DeviceConfiguration
The configuration of a device connector. Configuration properties may be changed by a Intersight user or by a device administrator using the connector's API ex…
hci.VirtualGpu.Response
The response body of a HTTP GET request for the 'hci.VirtualGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
policy.PolicyContextHolder
To store the policy details along with the context for which the entry is established.
iam.Session
The web session of a user. After a user logs into Intersight, a session object is created. Session object is deleted upon logout, idle timeout, expiry timeout,…
hci.ExternalStorageArray
Information about a Pure Storage FlashArray that provides external storage to a Nutanix cluster.
iam.EndPointRole
EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges. Purpose It allows administrators to assign endpoin…
iam.AbstractClientApplication
Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to its use case and these requests r…
hci.AhvVmNic
A NIC associated with an AHV VM.
iam.User.Relationship
A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.
iam.UserSetting
UserSetting stores specific UI-related settings that are not part of general preferences, such as session recording opt-in status. Purpose It allows storing di…
hci.ClusterOperation.Relationship
A relationship to the 'hci.ClusterOperation' resource, or the expanded 'hci.ClusterOperation' resource, or the 'null' value.
hci.Disk.Response
The response body of a HTTP GET request for the 'hci.Disk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
policy.AbstractProfile
Abstract base type for all profiles.
asset.DeviceConfiguration.Relationship
A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.
hci.License
The License object captures the details of software licenses acquired by Nutanix Prism Central. This provides a structured representation of licenses for all e…
hci.AhvVmGpu
A GPU associated with an AHV VM.
asset.Connection
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
hci.Entitlement.Relationship
A relationship to the 'hci.Entitlement' resource, or the expanded 'hci.Entitlement' resource, or the 'null' value.
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…
iam.LdapMeta.Relationship
A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.
hci.AhvVm.Relationship
A relationship to the 'hci.AhvVm' resource, or the expanded 'hci.AhvVm' resource, or the 'null' value.
hci.PendingWorkflowTrigger
Tracking entry for an async workflow trigger awaiting callback response.
iam.Role.Relationship
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
hci.AhvVm
An AHV VM reported by Prism Central.
hci.ManagementServer
The management server of a cluster.
iam.User
The User object represents individual users within the system, encompassing their identity, permissions, and roles. Purpose A User is a central entity within t…
hci.AhvVmGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.AccountTags
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.
hci.StorageContainer.Response
The response body of a HTTP GET request for the 'hci.StorageContainer' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
hci.FeatureViolation
The detailed violation of a feature.
hci.PulseStatus
The pulse status of a cluster.
asset.DeviceRegistration.Relationship
A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.
iam.PrivilegeSet.Relationship
A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.
iam.LdapProvider
Overview The LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy. Purpose The…
iam.TestIdpConfiguration
TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test…
iam.ServiceProvider.Relationship
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
hci.ClusterOpInfo
Status tracking information for a specific cluster operation type (e.g., NCC check).
asset.ClusterMember
The ClusterMember object represents a node within a cluster of device connectors. This provides detailed insights into the individual members of a device clust…
hci.EsxiVm.Relationship
A relationship to the 'hci.EsxiVm' resource, or the expanded 'hci.EsxiVm' resource, or the 'null' value.
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
hci.CapacityViolation
The violation of a capacity.
hci.PhysicalGpu
Physical GPU managed by a cluster and reported by Prism Central.
hci.Entitlement
The Entitlement object captures the details of license entitlements associated with clusters. This provides a structured representation of entitlement informat…
iam.AppRegistration
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
iam.LdapProvider.Relationship
A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.
iam.System
The System object is the global root within the platform, serving as a container for objects that are shared across all accounts. It centralizes platform-wide…
iam.LdapPolicy.Relationship
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
hci.Node.Relationship
A relationship to the 'hci.Node' resource, or the expanded 'hci.Node' resource, or the 'null' value.
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
hci.AhvVmNic.Response
The response body of a HTTP GET request for the 'hci.AhvVmNic' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
policy.ConfigContext
Configuration related state and results.
hci.Sbdf
The Segment:Bus:Device.Function (SBDF) hardware address.
hci.NccCheckPolicy.Response
The response body of a HTTP GET request for the 'hci.NccCheckPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
hci.Cluster.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.PhysicalGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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
hci.Alarm
An alert from an HCI cluster reported from the Prism Central serviceability/Alerts API.
hci.Disk.Relationship
A relationship to the 'hci.Disk' resource, or the expanded 'hci.Disk' resource, or the 'null' value.
hci.AhvVmGpu.Response
The response body of a HTTP GET request for the 'hci.AhvVmGpu' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL que…
iam.IdpReference.Relationship
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
hci.EsxiGuestTools
The details of the Nutanix Guest Tools.
iam.Account.Relationship
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
hci.Gpu
A GPU belonging to a node in a Nutanix cluster. Purpose The Gpu object provides a detailed view of GPU configuration for a node in a Nutanix cluster. Key Conce…
hci.AlarmParameter
The key value pair of parameters from the endpoint alarm object to populate the fields in the title and message properties.
iam.EndPointPrivilege.Relationship
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
iam.ResourceLimits.Relationship
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
hci.VirtualGpu.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.SdaPolicyClusterConfig
NCC Policy parameters for specific cluster.
hci.ConfigurableParamValueRange
Valid value range for a configurable parameter.
iam.LocalUserPassword
LocalUserPassword provides the mechanism for a local user to change their own password within the platform appliance context. This model is applicable only to…
iam.TestIdpConfiguration.Relationship
A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.
hci.ApiLimit
The limit info about an Nutanix API. Once the limit is reached, the API will return incomplete results.
hci.ClusterOperation
The ClusterOperation object is an inventory managed object that allows users to trigger and track cluster-level operations such as NCC checks, configuration ch…
asset.ClaimSignature
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
hci.Disk
The physical disk belonging to a node in a Nutanix cluster. Purpose The Disk object provides a detailed view of disk configurations. Key Concepts - Configurati…
hci.EsxiVmNic
A NIC associated with an ESXi VM.
hci.Compliance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.NccCheckPolicy
A Nutanix Cluster Check (NCC) policy configured on the Prism Central.
hci.AhvVmGpu.Relationship
A relationship to the 'hci.AhvVmGpu' resource, or the expanded 'hci.AhvVmGpu' resource, or the 'null' value.
hci.KeyManagementDeviceToCertStatusInfo
The status of the certificate on the key management device.
iam.LdapGroup.Relationship
A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.
iam.LdapBaseProperties
Base settings of LDAP required while configuring LDAP policy.
hci.Cluster
The Cluster object represents a cluster, as reported by Nutanix Prism Central. This provides a structured representation of clusters, including their configura…
hci.ClusterOperation.Response
The response body of a HTTP GET request for the 'hci.ClusterOperation' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
hci.Compliance.Relationship
A relationship to the 'hci.Compliance' resource, or the expanded 'hci.Compliance' resource, or the 'null' value.
policy.ScheduledAction
Scheduled Action enables the queuing of multiple profile actions to be executed sequentially. Each action in the sequence is executed only after the successful…
hci.ExternalStorage
An external storage instance represents storage provided by external vendors such as Pure Storage that is used by Nutanix clusters. Purpose The ExternalStorage…
hci.EsxiVmNic.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.ConfigResultContext
The context for a validation/config result such as the related entity's name, type, MOID etc.
policy.AbstractConfigProfile
AbstractConfigProfile is an abstract base type for all config actions on a profile.
iam.OAuthToken.Relationship
A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.
iam.AccountPermissions
Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight iden…
hci.Node
The Node object encapsulates the details of individual nodes within clusters, as reported by Nutanix Prism Central. This provides a structured representation o…
hci.ExpiredLicense
The details of the expired license.
hci.ServiceViolation
A instance of a service violation.
hci.Entitlement.Response
The response body of a HTTP GET request for the 'hci.Entitlement' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
hci.License.Response
The response body of a HTTP GET request for the 'hci.License' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL quer…
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
hci.NutanixClusterCheck
Configuration for Nutanix Cluster Check (NCC) operation. NCC is a diagnostic tool that validates cluster health.
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
asset.Service
A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.
hci.StorageContainer
Storage containers in Nutanix serve as logical abstraction layers for virtual disk storage which can be backed by HCI (local) storage or external storage provi…
iam.PermissionReference
Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight iden…
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
hci.EsxiVmDisk.Response
The response body of a HTTP GET request for the 'hci.EsxiVmDisk' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL q…
asset.ClusterMember.Relationship
A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.
hci.Compliance
The Compliance object offers a comprehensive view of licensing compliance within clusters, as reported by Nutanix Prism Central. Purpose The Compliance object…
hci.EsxiVmDisk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.AhvVm.Response
The response body of a HTTP GET request for the 'hci.AhvVm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query,…
hci.AhvVmDisk.Relationship
A relationship to the 'hci.AhvVmDisk' resource, or the expanded 'hci.AhvVmDisk' resource, or the 'null' value.
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
asset.ConnectionFlapStatus
Encapsulates key details used to identify devices experiencing connection flapping.
hci.AhvVmDisk
A disk associated with an AHV VM.
hci.Disk.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
hci.EsxiVm.Response
The response body of a HTTP GET request for the 'hci.EsxiVm' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL query…
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property
1 required
asset.Target.Relationship
A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.
asset.Target
The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and se…
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
#HCI
Where this information came from
This is an independent, third-party profile of Cisco Intersight Hci 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.