Cisco Intersight Appliance API
The appliance API from Cisco Intersight — 104 operation(s) for appliance.
Cisco Intersight Appliance 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 Appliance. 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 153 operations across 104 paths, and defines 351 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}.
153 operations
104 paths
351 schemas
5 DELETE102 GET16 PATCH30 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Appliance 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 153
Across 104 paths, the API surfaces 153 operations — 5 DELETE, 102 GET, 16 PATCH, 30 POST. Each is listed below with its method, path, parameters, and response codes.
appliance 153
GET
/api/v1/appliance/AppOpStatuses
Read a 'appliance.AppOpStatus' resource.
GET
/api/v1/appliance/AppOpStatuses/{Moid}
Read a 'appliance.AppOpStatus' resource.
GET
/api/v1/appliance/AppStatuses
Read a 'appliance.AppStatus' resource.
GET
/api/v1/appliance/AppStatuses/{Moid}
Read a 'appliance.AppStatus' resource.
GET
/api/v1/appliance/AutoRmaPolicies
Read a 'appliance.AutoRmaPolicy' resource.
GET
/api/v1/appliance/AutoRmaPolicies/{Moid}
Read a 'appliance.AutoRmaPolicy' resource.
GET
/api/v1/appliance/Backups
Read a 'appliance.Backup' resource.
POST
/api/v1/appliance/Backups
Create a 'appliance.Backup' resource.
GET
/api/v1/appliance/Backups/{Moid}
Read a 'appliance.Backup' resource.
DELETE
/api/v1/appliance/Backups/{Moid}
Delete a 'appliance.Backup' resource.
GET
/api/v1/appliance/BackupDownloads
Read a 'appliance.BackupDownload' resource.
GET
/api/v1/appliance/BackupDownloads/{Moid}
Read a 'appliance.BackupDownload' resource.
GET
/api/v1/appliance/BackupMonitors
Read a 'appliance.BackupMonitor' resource.
GET
/api/v1/appliance/BackupMonitors/{Moid}
Read a 'appliance.BackupMonitor' resource.
GET
/api/v1/appliance/BackupPolicies
Read a 'appliance.BackupPolicy' resource.
POST
/api/v1/appliance/BackupPolicies
Create a 'appliance.BackupPolicy' resource.
GET
/api/v1/appliance/BackupPolicies/{Moid}
Read a 'appliance.BackupPolicy' resource.
POST
/api/v1/appliance/BackupPolicies/{Moid}
Update a 'appliance.BackupPolicy' resource.
PATCH
/api/v1/appliance/BackupPolicies/{Moid}
Update a 'appliance.BackupPolicy' resource.
GET
/api/v1/appliance/BackupRotateData
Read a 'appliance.BackupRotateData' resource.
GET
/api/v1/appliance/BackupRotateData/{Moid}
Read a 'appliance.BackupRotateData' resource.
GET
/api/v1/appliance/CertificateSettings
Read a 'appliance.CertificateSetting' resource.
GET
/api/v1/appliance/CertificateSettings/{Moid}
Read a 'appliance.CertificateSetting' resource.
POST
/api/v1/appliance/CertificateSettings/{Moid}
Update a 'appliance.CertificateSetting' resource.
PATCH
/api/v1/appliance/CertificateSettings/{Moid}
Update a 'appliance.CertificateSetting' resource.
GET
/api/v1/appliance/ClusterInfos
Read a 'appliance.ClusterInfo' resource.
POST
/api/v1/appliance/ClusterInfos
Create a 'appliance.ClusterInfo' resource.
POST
/api/v1/appliance/ClusterInfos/{Moid}
Update a 'appliance.ClusterInfo' resource.
PATCH
/api/v1/appliance/ClusterInfos/{Moid}
Update a 'appliance.ClusterInfo' resource.
DELETE
/api/v1/appliance/ClusterInfos/{Moid}
Delete a 'appliance.ClusterInfo' resource.
GET
/api/v1/appliance/ClusterInfos/{Moid}
Read a 'appliance.ClusterInfo' resource.
GET
/api/v1/appliance/ClusterInstalls
Read a 'appliance.ClusterInstall' resource.
GET
/api/v1/appliance/ClusterInstalls/{Moid}
Read a 'appliance.ClusterInstall' resource.
POST
/api/v1/appliance/ClusterInstalls/{Moid}
Update a 'appliance.ClusterInstall' resource.
PATCH
/api/v1/appliance/ClusterInstalls/{Moid}
Update a 'appliance.ClusterInstall' resource.
POST
/api/v1/appliance/ClusterReplaceNodes
Create a 'appliance.ClusterReplaceNode' resource.
GET
/api/v1/appliance/ClusterReplaceNodes
Read a 'appliance.ClusterReplaceNode' resource.
GET
/api/v1/appliance/ClusterReplaceNodes/{Moid}
Read a 'appliance.ClusterReplaceNode' resource.
POST
/api/v1/appliance/ClusterReplaceNodes/{Moid}
Update a 'appliance.ClusterReplaceNode' resource.
PATCH
/api/v1/appliance/ClusterReplaceNodes/{Moid}
Update a 'appliance.ClusterReplaceNode' resource.
POST
/api/v1/appliance/ClusterWorkerNodes
Create a 'appliance.ClusterWorkerNode' resource.
GET
/api/v1/appliance/ClusterWorkerNodes
Read a 'appliance.ClusterWorkerNode' resource.
GET
/api/v1/appliance/ClusterWorkerNodes/{Moid}
Read a 'appliance.ClusterWorkerNode' resource.
POST
/api/v1/appliance/ClusterWorkerNodes/{Moid}
Update a 'appliance.ClusterWorkerNode' resource.
PATCH
/api/v1/appliance/ClusterWorkerNodes/{Moid}
Update a 'appliance.ClusterWorkerNode' resource.
POST
/api/v1/appliance/ClusterWorkerNodeReplaces
Create a 'appliance.ClusterWorkerNodeReplace' resource.
POST
/api/v1/appliance/ClusterWorkerNodeReuses
Create a 'appliance.ClusterWorkerNodeReuse' resource.
GET
/api/v1/appliance/CpuUtilizations
Read a 'appliance.CpuUtilization' resource.
GET
/api/v1/appliance/CpuUtilizations/{Moid}
Read a 'appliance.CpuUtilization' resource.
GET
/api/v1/appliance/DataExportPolicies
Read a 'appliance.DataExportPolicy' resource.
POST
/api/v1/appliance/DataExportPolicies
Create a 'appliance.DataExportPolicy' resource.
GET
/api/v1/appliance/DataExportPolicies/{Moid}
Read a 'appliance.DataExportPolicy' resource.
POST
/api/v1/appliance/DataExportPolicies/{Moid}
Update a 'appliance.DataExportPolicy' resource.
PATCH
/api/v1/appliance/DataExportPolicies/{Moid}
Update a 'appliance.DataExportPolicy' resource.
GET
/api/v1/appliance/DeviceCertificates
Read a 'appliance.DeviceCertificate' resource.
GET
/api/v1/appliance/DeviceCertificates/{Moid}
Read a 'appliance.DeviceCertificate' resource.
GET
/api/v1/appliance/DeviceClaims
Read a 'appliance.DeviceClaim' resource.
POST
/api/v1/appliance/DeviceClaims
Create a 'appliance.DeviceClaim' resource.
GET
/api/v1/appliance/DeviceClaims/{Moid}
Read a 'appliance.DeviceClaim' resource.
POST
/api/v1/appliance/DeviceClaims/{Moid}
Update a 'appliance.DeviceClaim' resource.
PATCH
/api/v1/appliance/DeviceClaims/{Moid}
Update a 'appliance.DeviceClaim' resource.
GET
/api/v1/appliance/DeviceClusterInstalls
Read a 'appliance.DeviceClusterInstall' resource.
GET
/api/v1/appliance/DeviceClusterInstalls/{Moid}
Read a 'appliance.DeviceClusterInstall' resource.
GET
/api/v1/appliance/DeviceStates
Read a 'appliance.DeviceState' resource.
GET
/api/v1/appliance/DeviceStates/{Moid}
Read a 'appliance.DeviceState' resource.
GET
/api/v1/appliance/DeviceUpgradePolicies
Read a 'appliance.DeviceUpgradePolicy' resource.
GET
/api/v1/appliance/DeviceUpgradePolicies/{Moid}
Read a 'appliance.DeviceUpgradePolicy' resource.
POST
/api/v1/appliance/DeviceUpgradePolicies/{Moid}
Update a 'appliance.DeviceUpgradePolicy' resource.
PATCH
/api/v1/appliance/DeviceUpgradePolicies/{Moid}
Update a 'appliance.DeviceUpgradePolicy' resource.
POST
/api/v1/appliance/DiagSettings
Create a 'appliance.DiagSetting' resource.
GET
/api/v1/appliance/DiagSettings
Read a 'appliance.DiagSetting' resource.
POST
/api/v1/appliance/DiagSettings/{Moid}
Update a 'appliance.DiagSetting' resource.
PATCH
/api/v1/appliance/DiagSettings/{Moid}
Update a 'appliance.DiagSetting' resource.
GET
/api/v1/appliance/DiagSettings/{Moid}
Read a 'appliance.DiagSetting' resource.
GET
/api/v1/appliance/ExternalSyslogSettings
Read a 'appliance.ExternalSyslogSetting' resource.
POST
/api/v1/appliance/ExternalSyslogSettings
Create a 'appliance.ExternalSyslogSetting' resource.
GET
/api/v1/appliance/ExternalSyslogSettings/{Moid}
Read a 'appliance.ExternalSyslogSetting' resource.
POST
/api/v1/appliance/ExternalSyslogSettings/{Moid}
Update a 'appliance.ExternalSyslogSetting' resource.
PATCH
/api/v1/appliance/ExternalSyslogSettings/{Moid}
Update a 'appliance.ExternalSyslogSetting' resource.
DELETE
/api/v1/appliance/ExternalSyslogSettings/{Moid}
Delete a 'appliance.ExternalSyslogSetting' resource.
GET
/api/v1/appliance/FileGateways
Read a 'appliance.FileGateway' resource.
GET
/api/v1/appliance/FileGateways/{Moid}
Read a 'appliance.FileGateway' resource.
GET
/api/v1/appliance/FileSystemOpStatuses
Read a 'appliance.FileSystemOpStatus' resource.
GET
/api/v1/appliance/FileSystemOpStatuses/{Moid}
Read a 'appliance.FileSystemOpStatus' resource.
GET
/api/v1/appliance/FileSystemOpSummaries
Read a 'appliance.FileSystemOpSummary' resource.
GET
/api/v1/appliance/FileSystemOpSummaries/{Moid}
Read a 'appliance.FileSystemOpSummary' resource.
GET
/api/v1/appliance/FileSystemStatuses
Read a 'appliance.FileSystemStatus' resource.
GET
/api/v1/appliance/FileSystemStatuses/{Moid}
Read a 'appliance.FileSystemStatus' resource.
GET
/api/v1/appliance/FileSystemTelemetries
Read a 'appliance.FileSystemTelemetry' resource.
GET
/api/v1/appliance/FileSystemTelemetries/{Moid}
Read a 'appliance.FileSystemTelemetry' resource.
GET
/api/v1/appliance/FqdnUpdates
Read a 'appliance.FqdnUpdate' resource.
POST
/api/v1/appliance/FqdnUpdates
Create a 'appliance.FqdnUpdate' resource.
GET
/api/v1/appliance/FqdnUpdates/{Moid}
Read a 'appliance.FqdnUpdate' resource.
POST
/api/v1/appliance/FqdnUpdates/{Moid}
Update a 'appliance.FqdnUpdate' resource.
PATCH
/api/v1/appliance/FqdnUpdates/{Moid}
Update a 'appliance.FqdnUpdate' resource.
GET
/api/v1/appliance/GroupOpStatuses
Read a 'appliance.GroupOpStatus' resource.
GET
/api/v1/appliance/GroupOpStatuses/{Moid}
Read a 'appliance.GroupOpStatus' resource.
GET
/api/v1/appliance/GroupStatuses
Read a 'appliance.GroupStatus' resource.
GET
/api/v1/appliance/GroupStatuses/{Moid}
Read a 'appliance.GroupStatus' resource.
GET
/api/v1/appliance/ImageBundles
Read a 'appliance.ImageBundle' resource.
GET
/api/v1/appliance/ImageBundles/{Moid}
Read a 'appliance.ImageBundle' resource.
GET
/api/v1/appliance/MemoryUtilizations
Read a 'appliance.MemoryUtilization' resource.
GET
/api/v1/appliance/MemoryUtilizations/{Moid}
Read a 'appliance.MemoryUtilization' resource.
GET
/api/v1/appliance/MetaManifests
Read a 'appliance.MetaManifest' resource.
GET
/api/v1/appliance/MetaManifests/{Moid}
Read a 'appliance.MetaManifest' resource.
GET
/api/v1/appliance/MetricsConfigs
Read a 'appliance.MetricsConfig' resource.
GET
/api/v1/appliance/MetricsConfigs/{Moid}
Read a 'appliance.MetricsConfig' resource.
POST
/api/v1/appliance/MetricsConfigs/{Moid}
Update a 'appliance.MetricsConfig' resource.
PATCH
/api/v1/appliance/MetricsConfigs/{Moid}
Update a 'appliance.MetricsConfig' resource.
GET
/api/v1/appliance/MetricsIngestionUtilizations
Read a 'appliance.MetricsIngestionUtilization' resource.
GET
/api/v1/appliance/MetricsIngestionUtilizations/{Moid}
Read a 'appliance.MetricsIngestionUtilization' resource.
GET
/api/v1/appliance/NetworkLinkStatuses
Read a 'appliance.NetworkLinkStatus' resource.
GET
/api/v1/appliance/NetworkLinkStatuses/{Moid}
Read a 'appliance.NetworkLinkStatus' resource.
GET
/api/v1/appliance/NodeInfos
Read a 'appliance.NodeInfo' resource.
GET
/api/v1/appliance/NodeInfos/{Moid}
Read a 'appliance.NodeInfo' resource.
GET
/api/v1/appliance/NodeIopsMetrics
Read a 'appliance.NodeIopsMetric' resource.
GET
/api/v1/appliance/NodeIopsMetrics/{Moid}
Read a 'appliance.NodeIopsMetric' resource.
GET
/api/v1/appliance/NodeOpStatuses
Read a 'appliance.NodeOpStatus' resource.
GET
/api/v1/appliance/NodeOpStatuses/{Moid}
Read a 'appliance.NodeOpStatus' resource.
GET
/api/v1/appliance/NodeStatuses
Read a 'appliance.NodeStatus' resource.
GET
/api/v1/appliance/NodeStatuses/{Moid}
Read a 'appliance.NodeStatus' resource.
GET
/api/v1/appliance/NodeTelemetries
Read a 'appliance.NodeTelemetry' resource.
GET
/api/v1/appliance/NodeTelemetries/{Moid}
Read a 'appliance.NodeTelemetry' resource.
GET
/api/v1/appliance/ReleaseNotesdeprecated
Read a 'appliance.ReleaseNote' resource.
GET
/api/v1/appliance/ReleaseNotes/{Moid}deprecated
Read a 'appliance.ReleaseNote' resource.
POST
/api/v1/appliance/RemoteFileImports
Create a 'appliance.RemoteFileImport' resource.
GET
/api/v1/appliance/RemoteFileImports
Read a 'appliance.RemoteFileImport' resource.
GET
/api/v1/appliance/RemoteFileImports/{Moid}
Read a 'appliance.RemoteFileImport' resource.
GET
/api/v1/appliance/Restores
Read a 'appliance.Restore' resource.
POST
/api/v1/appliance/Restores
Create a 'appliance.Restore' resource.
GET
/api/v1/appliance/Restores/{Moid}
Read a 'appliance.Restore' resource.
DELETE
/api/v1/appliance/Restores/{Moid}
Delete a 'appliance.Restore' resource.
GET
/api/v1/appliance/SetupInfos
Read a 'appliance.SetupInfo' resource.
GET
/api/v1/appliance/SetupInfos/{Moid}
Read a 'appliance.SetupInfo' resource.
POST
/api/v1/appliance/SetupInfos/{Moid}
Update a 'appliance.SetupInfo' resource.
PATCH
/api/v1/appliance/SetupInfos/{Moid}
Update a 'appliance.SetupInfo' resource.
GET
/api/v1/appliance/SystemInfos
Read a 'appliance.SystemInfo' resource.
GET
/api/v1/appliance/SystemInfos/{Moid}
Read a 'appliance.SystemInfo' resource.
GET
/api/v1/appliance/SystemOpStatuses
Read a 'appliance.SystemOpStatus' resource.
GET
/api/v1/appliance/SystemOpStatuses/{Moid}
Read a 'appliance.SystemOpStatus' resource.
GET
/api/v1/appliance/SystemStatuses
Read a 'appliance.SystemStatus' resource.
GET
/api/v1/appliance/SystemStatuses/{Moid}
Read a 'appliance.SystemStatus' resource.
GET
/api/v1/appliance/Upgrades
Read a 'appliance.Upgrade' resource.
GET
/api/v1/appliance/Upgrades/{Moid}
Read a 'appliance.Upgrade' resource.
POST
/api/v1/appliance/Upgrades/{Moid}
Update a 'appliance.Upgrade' resource.
PATCH
/api/v1/appliance/Upgrades/{Moid}
Update a 'appliance.Upgrade' resource.
DELETE
/api/v1/appliance/Upgrades/{Moid}
Delete a 'appliance.Upgrade' resource.
GET
/api/v1/appliance/UpgradePolicies
Read a 'appliance.UpgradePolicy' resource.
GET
/api/v1/appliance/UpgradePolicies/{Moid}
Read a 'appliance.UpgradePolicy' resource.
POST
/api/v1/appliance/UpgradePolicies/{Moid}
Update a 'appliance.UpgradePolicy' resource.
PATCH
/api/v1/appliance/UpgradePolicies/{Moid}
Update a 'appliance.UpgradePolicy' resource.
GET
/api/v1/appliance/UpgradeTrackers
Read a 'appliance.UpgradeTracker' resource.
GET
/api/v1/appliance/UpgradeTrackers/{Moid}
Read a 'appliance.UpgradeTracker' resource.
Schemas 351
The contract defines 351 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.
iam.PrivateKeySpec.Relationship
A relationship to the 'iam.PrivateKeySpec' resource, or the expanded 'iam.PrivateKeySpec' resource, or the 'null' value.
appliance.Upgrade
The Upgrade object is a crucial component within the Intersight Appliance's software management system, responsible for tracking and managing software upgrades…
appliance.AutoRmaPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ResourceRoles.Relationship
A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.
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.
appliance.DeviceClusterInstall
The DeviceClusterInstall object tracks the installation process of Intersight Cluster Appliances, providing insights into system setup and configuration. Purpo…
appliance.NodeOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.GroupOpStatus
The GroupOpStatus object describes the status of a group of applications within the Intersight Appliance system. It consolidates application-specific status to…
iam.AppCredentials
Contains credentials information for a particular client application.
appliance.ApiStatus
Status of an API. APIs are all get type and from ApiDocs.
appliance.FileSystemOpSummary
The FileSystemOpSummary object aggregates alarm summaries for file systems on an Intersight Appliance node. It serves as an essential tool for maintaining syst…
appliance.RemoteFileImport.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.UpgradePolicy.Response
The response body of a HTTP GET request for the 'appliance.UpgradePolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeOpStatus
The NodeOpStatus object captures the status of individual nodes within the Intersight Appliance. It is essential for understanding node-specific operational me…
appliance.UpgradePolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mo.VersionContext
VersionContext contains the versioning info for an object.
iam.Certificate.Relationship
A relationship to the 'iam.Certificate' resource, or the expanded 'iam.Certificate' resource, or the 'null' value.
appliance.SetupInfo
SetupInfo will have only one managed object. SetupInfo managed object is to keep track of the Intersight Appliance's setup information and guide the UI through…
iam.ClientMeta
Contains meta information of the client. Currently it is used only within OAuth clients.
appliance.ImageBundle.Relationship
A relationship to the 'appliance.ImageBundle' resource, or the expanded 'appliance.ImageBundle' resource, or the 'null' value.
policy.AbstractProfile.Relationship
A relationship to the 'policy.AbstractProfile' resource, or the expanded 'policy.AbstractProfile' resource, or the 'null' value.
appliance.ClusterReplaceNode
ClusterReplaceNode is a singleton that tracks the Intersight Appliance's process for replacing a cluster node.
appliance.FileSystemOpStatus
The FileSystemOpStatus object denotes the operational status of file systems within an Intersight Appliance node. It highlights the capacity and usage metrics…
appliance.FileSystemStatus
Status of a file system on an Intersight Appliance node.
asset.DeviceConnection
An abstract class that holds the details of a device connectors connection to Intersight.
appliance.ClusterInstall.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
session.AbstractSession
A base abstract class for all sessions.
iam.AbstractQualifier.Relationship
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
appliance.ClusterWorkerNodeReuse
The ClusterWorkerNodeReuse object facilitates the reconnection process for worker nodes within the Intersight Appliance cluster. It triggers the appliance's pr…
appliance.SystemInfo.Response
The response body of a HTTP GET request for the 'appliance.SystemInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
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.
iam.DomainGroup.Relationship
A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
policy.AbstractPolicy
A base abstract class for all configuration policies that can be applied to service profiles.
appliance.MetricsConfig.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetadataManifestVersion
BucketVersion is a 3 tuple (bucketName, timestamp of when the metamanifest was touched, checksum). Uniquely identifies a single metadata update to a bucket.
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.AbstractQualifier
Placeholder for different types of qualifiers.
appliance.FileGateway.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.…
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…
appliance.ClusterInfo.Response
The response body of a HTTP GET request for the 'appliance.ClusterInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.ReleaseNote.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.AppRegistration.Relationship
A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' 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.Session.Relationship
A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.
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…
appliance.BackupRotateData.Response
The response body of a HTTP GET request for the 'appliance.BackupRotateData' resource. The value may be one of the following types. 1. When 'tag' is specified…
policy.PolicyContextHolder
To store the policy details along with the context for which the entry is established.
iam.EndPointRole
EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges. Purpose It allows administrators to assign endpoin…
appliance.DeviceClusterInstall.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterInstall
ClusterInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.
iam.Role.Relationship
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
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…
asset.DeviceRegistration.Relationship
A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.
iam.TestIdpConfiguration
TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test…
appliance.MemoryUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AutoRmaPolicy
Auto rma policy to decide whether rma data should be collected.
resource.Group
The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings. Purpose A…
iam.LdapProvider.Relationship
A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.
appliance.ClusterReplaceNode.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeInfo
The NodeInfo object is designed to store the cluster node information of the Intersight Appliance. Created during the appliance's setup, NodeInfo objects are u…
appliance.NetworkLinkStatus
The NetworkLinkStatus object examines the network connection between nodes in an Intersight Appliance cluster. It is vital for ensuring seamless communication…
policy.ConfigContext
Configuration related state and results.
appliance.BackupPolicy
The BackupPolicy object defines the strategic approach to system backups, setting guidelines and parameters for regular data protection operations. Purpose Bac…
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
appliance.ReleaseNote.Response
The response body of a HTTP GET request for the 'appliance.ReleaseNote' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
appliance.FqdnUpdate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
cond.AlarmSummary
The summary of alarm counts based on alarm serverity.
appliance.NetworkStatus
Time to ping a target endpoint.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
appliance.NodeIopsMetric
Input/Output operations per second (IOPS) metrics for Intersight Appliance nodes. Measures the aggregate rate of disk read and write operations, providing insi…
appliance.BackupDownload.Response
The response body of a HTTP GET request for the 'appliance.BackupDownload' resource. The value may be one of the following types. 1. When 'tag' is specified in…
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…
appliance.FileSystemTelemetry.Response
The response body of a HTTP GET request for the 'appliance.FileSystemTelemetry' resource. The value may be one of the following types. 1. When 'tag' is specifi…
appliance.NodeUtilizationMetric
Base class for percentage-based utilization metrics collected from Intersight Appliance nodes.
appliance.DeviceUpgradePolicy
The DeviceUpgradePolicy object defines the upgrade policies of Intersight Appliances, guiding the automated and scheduled distribution of software updates. Pur…
appliance.ExternalSyslogSetting.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.
appliance.AppOpStatus
The AppOpStatus object articulates the operational status of applications running on the Intersight Appliance. It tracks the application's readiness and perfor…
appliance.BackupMonitor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SetupInfo.Response
The response body of a HTTP GET request for the 'appliance.SetupInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property
1 required
appliance.Upgrade.Relationship
A relationship to the 'appliance.Upgrade' resource, or the expanded 'appliance.Upgrade' resource, or the 'null' value.
appliance.DataExportPolicy.Relationship
A relationship to the 'appliance.DataExportPolicy' resource, or the expanded 'appliance.DataExportPolicy' resource, or the 'null' value.
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
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.
appliance.BackupRotateData.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SystemOpStatus
The SystemOpStatus object represents the status of the Intersight Appliance within a system. This provides a comprehensive view of the appliance's operational…
iam.IpAccessManagement.Relationship
A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.
appliance.GroupOpStatus.Response
The response body of a HTTP GET request for the 'appliance.GroupOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeIpInfo
NodeInfo contains the hostname, ip address, and node number for a node.
iam.CertificateRequest
The information required to generate a certificate signing request (CSR), which is a block of encoded text that is given to a Certificate Authority when applyi…
appliance.FqdnUpdate
FqdnUpdate provides configuration parameters for updating Appliance FQDN (fully qualified domain name) on claimed Endpoints. Appliance with new FQDN should be…
appliance.DeviceUpgradePolicy.Response
The response body of a HTTP GET request for the 'appliance.DeviceUpgradePolicy' resource. The value may be one of the following types. 1. When 'tag' is specifi…
iam.ResourcePermission
ResourcePermission represents the permissions defined on a resource like organization.
appliance.ClusterInfo.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.
iam.Privilege.Relationship
A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.
appliance.DeviceClaim.Response
The response body of a HTTP GET request for the 'appliance.DeviceClaim' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
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…
resource.Reservation
The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation. Purpose…
onprem.ResourceInfo
Common data structure used for capturing memory or storage usage information.
appliance.FileSystemOpStatus.Relationship
A relationship to the 'appliance.FileSystemOpStatus' resource, or the expanded 'appliance.FileSystemOpStatus' resource, or the 'null' value.
iam.Role
A role is a collection of privilege sets that are assigned to a user using a permission object.
onprem.Schedule
Schedule is used by Intersight Appliance services to store task scheduling information. For example, appliance backup service uses Schedule to store the backup…
pkix.SubjectAlternateName
The additional hostnames to be protected by a given X.509 certificate.
appliance.NodeTelemetry.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
appliance.NodeStatus
Status of an Intersight Appliance node.
appliance.SystemInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
iam.SecurityHolder.Relationship
A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.
appliance.CpuUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AutoRmaPolicy.Response
The response body of a HTTP GET request for the 'appliance.AutoRmaPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.GroupOpStatus.Relationship
A relationship to the 'appliance.GroupOpStatus' resource, or the expanded 'appliance.GroupOpStatus' resource, or the 'null' value.
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
appliance.MetricsConfig
The MetricsConfig object provides configuration parameters for managing metrics collection on the Intersight Appliance. It supports system and user-defined met…
appliance.MetaManifest
MetaManifest managed object describes the files by downloading from the S3 and without having required user to run the upgrade for the appliance. This MO will…
appliance.FileSystemStatus.Response
The response body of a HTTP GET request for the 'appliance.FileSystemStatus' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.BackupMonitor
The BackupMonitor object plays a pivotal role in overseeing the history and status of backup operations, ensuring ongoing data protection and system reliabilit…
appliance.DeviceClaim
The DeviceClaim object represents a user-initiated claim request for endpoint devices within the Intersight Appliance. It facilitates the multi-step operation…
appliance.DiagSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SystemStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceUpgradePolicy.Relationship
A relationship to the 'appliance.DeviceUpgradePolicy' resource, or the expanded 'appliance.DeviceUpgradePolicy' resource, or the 'null' value.
appliance.BackupPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceUpgradePolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterInstallPhase
A phase in the Intersight Appliance cluster installation life cycle.
appliance.BackupBase
BackupBase is the parent type of Backup, Restore, and BackupPolicy managed objects. BackupBase holds the common information required for copying the file from…
appliance.NodeOpStatus.Response
The response body of a HTTP GET request for the 'appliance.NodeOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.NodeMetricBase
Base class for all metrics collected from Intersight Appliance nodes.
iam.PermissionToRoles
Complex type representing a permission and its associated roles.
appliance.NodeStatus.Relationship
A relationship to the 'appliance.NodeStatus' resource, or the expanded 'appliance.NodeStatus' resource, or the 'null' value.
iam.LdapDnsParameters
DNS settings used to access LDAP Providers.
iam.SecurityHolder
SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource…
iam.ResourcePermission.Relationship
A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.
appliance.Backup.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.DeviceConfiguration.Relationship
A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.
appliance.DeviceCertificate
The DeviceCertificate object stores the CA Certificate used by the Intersight Appliance's device connector. It tracks the renewal process and ensures the certi…
appliance.SystemOpStatus.Response
The response body of a HTTP GET request for the 'appliance.SystemOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.FileSystemTelemetry.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
appliance.MetricsIngestionUtilization.Response
The response body of a HTTP GET request for the 'appliance.MetricsIngestionUtilization' resource. The value may be one of the following types. 1. When 'tag' is…
appliance.BackupDownload.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AppStatus.Response
The response body of a HTTP GET request for the 'appliance.AppStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.SystemStatus
Status of the Intersight Appliance.
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…
appliance.FileSystemOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NetworkLinkStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetricsConfig.Response
The response body of a HTTP GET request for the 'appliance.MetricsConfig' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.BackupDownload
The BackupDownload object represents the download of a backup file, providing a secure and efficient mechanism for retrieving backup artifacts. Purpose The Bac…
appliance.FileGateway.Response
The response body of a HTTP GET request for the 'appliance.FileGateway' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
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…
appliance.StatusCheck
Status check on an Intersight Appliance entity.
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
appliance.GroupStatus
Status of a group of applications.
appliance.ClusterInstall.Response
The response body of a HTTP GET request for the 'appliance.ClusterInstall' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeTelemetry
NodeTelemetry represents the operational status of an Assist node, including CPU, memory, and disk usage metrics collected from Prometheus.
iam.EndPointPrivilege.Relationship
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
appliance.ImageBundle.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.Restore
The Restore object is crucial for handling system restoration requests, enabling recovery operations to maintain system stability and data accuracy. Purpose Th…
iam.ResourceLimits.Relationship
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
appliance.ClusterInstallBase
MultinodeInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.
appliance.MemoryUtilization.Response
The response body of a HTTP GET request for the 'appliance.MemoryUtilization' resource. The value may be one of the following types. 1. When 'tag' is specified…
asset.ClaimSignature
A cryptographic signature that can be used to auto-claim a device connector into a user's account.
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…
appliance.Upgrade.Response
The response body of a HTTP GET request for the 'appliance.Upgrade' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
appliance.BackupRotateData
BackupRotateData tracks the set of current backups being managed under a backup rotation policy. It serves as the system’s record for actively managing backups…
appliance.MetricsIngestionUtilization.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
asset.ClusterMember.Relationship
A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.
appliance.Restore.Response
The response body of a HTTP GET request for the 'appliance.Restore' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iam.PrivateKeySpec
PrivateKeySpec defines parameters for generating a private key that will be used to sign a certificate signing request (CSR). Purpose It standardizes the key g…
appliance.ClusterWorkerNode.Response
The response body of a HTTP GET request for the 'appliance.ClusterWorkerNode' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.DeviceCertificate.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.ApiKey.Relationship
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
appliance.ClusterInfo
ClusterInfo model is used for a peer appliance to create a cluster with an existing, fully configured appliance.
appliance.ClusterWorkerNode
ClusterWorkerNode is an object that tracks the Intersight Appliance's process for adding a worker node.
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.
appliance.FileSystemStatus.Relationship
A relationship to the 'appliance.FileSystemStatus' resource, or the expanded 'appliance.FileSystemStatus' resource, or the 'null' value.
resource.Selector
Complex type representing the filter condition to extract the resources.
policy.ActionParam
An action parameter setting as a key/value pair.
appliance.DiagSetting
The DiagSetting object is used to manage the password of the Intersight Appliance's OS diagnostic user account. It is designed to ensure secure access to the a…
appliance.SystemOpStatus.Relationship
A relationship to the 'appliance.SystemOpStatus' resource, or the expanded 'appliance.SystemOpStatus' resource, or the 'null' value.
appliance.CertificateSetting.Response
The response body of a HTTP GET request for the 'appliance.CertificateSetting' resource. The value may be one of the following types. 1. When 'tag' is specifie…
iam.LdapMeta
LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration. Purpose It provides system-managed insight in…
appliance.ImageBundle.Response
The response body of a HTTP GET request for the 'appliance.ImageBundle' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
asset.Credential
A credential which can be used to authenticate with a managed target.
appliance.FqdnUpdate.Response
The response body of a HTTP GET request for the 'appliance.FqdnUpdate' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.BackupPolicy.Response
The response body of a HTTP GET request for the 'appliance.BackupPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
appliance.GroupStatus.Relationship
A relationship to the 'appliance.GroupStatus' resource, or the expanded 'appliance.GroupStatus' resource, or the 'null' value.
appliance.Restore.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.Permission
Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.
iam.Idp.Relationship
A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.
appliance.GroupOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
policy.ConfigChangeDetailType
Defines the details of a configuration change including change type, disruption and description of the change.
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…
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
appliance.BackupMonitor.Response
The response body of a HTTP GET request for the 'appliance.BackupMonitor' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NodeOpStatus.Relationship
A relationship to the 'appliance.NodeOpStatus' resource, or the expanded 'appliance.NodeOpStatus' resource, or the 'null' value.
appliance.MetricsIngestionUtilization
Measures the utilization of the metrics feature in relation to the available capacity of the system.
appliance.UpgradePolicy
UpgradePolicy stores the Intersight Appliance's software upgrade policy. UpgradePolicy is a sinlgeton managed object. A default upgrade policy is created durin…
appliance.DeviceClusterInstall.Response
The response body of a HTTP GET request for the 'appliance.DeviceClusterInstall' resource. The value may be one of the following types. 1. When 'tag' is specif…
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…
appliance.DeviceState.Response
The response body of a HTTP GET request for the 'appliance.DeviceState' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
iam.PrivilegeSet
A collection of privileges.
appliance.NodeInfo.Response
The response body of a HTTP GET request for the 'appliance.NodeInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
iam.Permission.Relationship
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
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…
appliance.DeviceState
The DeviceState object captures the current operational state of Intersight Appliances, providing critical data for system monitoring and management. Purpose D…
resource.Reservation.Relationship
A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.
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
appliance.AppOpStatus.Response
The response body of a HTTP GET request for the 'appliance.AppOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
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…
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…
appliance.Upgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.AppStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.SystemStatus.Relationship
A relationship to the 'appliance.SystemStatus' resource, or the expanded 'appliance.SystemStatus' resource, or the 'null' value.
iam.Certificate
Certificate holds a user-provided certificate (signed by a CA) associated with a previously generated CSR, including validation status. Purpose It completes th…
appliance.MetaManifest.Response
The response body of a HTTP GET request for the 'appliance.MetaManifest' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
onprem.UpgradeNote
UpgradeNote managed object contains the description of one feature/bug fix.
appliance.CpuUtilization
CPU utilization metrics for Intersight Appliance nodes. Tracks the percentage of CPU capacity being used, helping administrators monitor processor load and ide…
iam.SessionLimits
The session related configuration limits.
appliance.ExternalSyslogSetting
The ExternalSyslogSetting object configures the external Syslog server for the Intersight Appliance. It allows administrators to define how Syslog messages are…
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.
appliance.NodeStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.GroupStatus.Response
The response body of a HTTP GET request for the 'appliance.GroupStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
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…
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,…
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…
policy.AbstractProfile
Abstract base type for all profiles.
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…
asset.Connection
A method for Intersight to connect to a managed target, including network connectivity and authentication details.
onprem.ClusterNode
ClusterNode encapsulates the properties of an Intersight Appliance node (virtual machine). ClusterNode and ClusterInfo data structures are shared between the u…
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.
appliance.DiagSetting.Response
The response body of a HTTP GET request for the 'appliance.DiagSetting' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
iam.PrivilegeSet.Relationship
A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.
iam.ServiceProvider.Relationship
A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.
appliance.SystemInfo.Relationship
A relationship to the 'appliance.SystemInfo' resource, or the expanded 'appliance.SystemInfo' resource, or the 'null' value.
iam.AppRegistration
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
appliance.CertificateSetting.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.Backup.Relationship
A relationship to the 'appliance.Backup' resource, or the expanded 'appliance.Backup' resource, or the 'null' value.
appliance.FileSystemTelemetry
Calculated operational status of a file system on a node.
appliance.AppOpStatus.Relationship
A relationship to the 'appliance.AppOpStatus' resource, or the expanded 'appliance.AppOpStatus' resource, or the 'null' value.
appliance.NodeInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DeviceClaim.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MetricBase
A metric that reports a value or set of values over a measurement period.
appliance.NodeIopsMetric.Response
The response body of a HTTP GET request for the 'appliance.NodeIopsMetric' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NetworkLinkStatus.Response
The response body of a HTTP GET request for the 'appliance.NetworkLinkStatus' resource. The value may be one of the following types. 1. When 'tag' is specified…
iam.LdapBaseProperties
Base settings of LDAP required while configuring LDAP policy.
appliance.DataExportPolicy.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.FileSystemOpSummary.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
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…
appliance.ReleaseNote
ReleaseUpdate managed the object provides the information preview (new features and bug fixes) for one pending upgrade.
iam.OAuthToken.Relationship
A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.
appliance.ClusterWorkerNodeReplace
ClusterWorkerNodeReplace is an object that marks the worker node out of service for replacement.
asset.Service
A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.
appliance.UpgradeTracker.Response
The response body of a HTTP GET request for the 'appliance.UpgradeTracker' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.NetworkLinkStatus.Relationship
A relationship to the 'appliance.NetworkLinkStatus' resource, or the expanded 'appliance.NetworkLinkStatus' resource, or the 'null' value.
asset.ConnectionFlapStatus
Encapsulates key details used to identify devices experiencing connection flapping.
iam.CertificateRequest.Relationship
A relationship to the 'iam.CertificateRequest' resource, or the expanded 'iam.CertificateRequest' resource, or the 'null' value.
asset.Target.Relationship
A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.
onprem.ImagePackage
ImagePackage encapsulates a software image package. ImagePackage can be a docker image, a UI web image, an endpoint (e.g. UCSM) image, a device connector image…
x509.Certificate
The representation of an X.509 certificate.
mo.BaseMo.Relationship
A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.
appliance.AppOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.EndPointPrivilege
EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions. Purpose It exposes endpoint-side…
iam.LdapPolicy
Overview The LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication…
policy.ReportedPolicyChange
A policy change that has been reported to a profile.
Error
object
4 properties
2 required
appliance.ImageBundle
The ImageBundle object plays a pivotal role in managing software bundles within the Intersight Appliance. It keeps track of all installed software bundles, der…
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.
appliance.Backup
The Backup object is essential for managing system backups, ensuring data integrity and continuity through structured backup requests and processes. Purpose Th…
appliance.RemoteFileImport.Response
The response body of a HTTP GET request for the 'appliance.RemoteFileImport' resource. The value may be one of the following types. 1. When 'tag' is specified…
iam.UserPreference
UserPreference captures user interface preferences—such as layout, view state, or theme—persisted per user and identity context. Purpose It enables consistent,…
appliance.ClusterWorkerNode.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
asset.ServiceOptions
ServiceOptions captures configuration that is specific to a target type for a specific service.
iam.IpAccessManagement
IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.…
pkix.DistinguishedName
The identifier for the owner of an X.509 certificate and the authority that issued the certificate.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
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.
onprem.ClusterInfo
ClusterInfo encapsulates properties of an Intersight Appliance. ClusterNode and ClusterInfo data structures are shared between the upgrade services running in…
appliance.UtilizationMetric
A utilization metric represents the percentage utilization of a resource.
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
appliance.AppStatus.Relationship
A relationship to the 'appliance.AppStatus' resource, or the expanded 'appliance.AppStatus' resource, or the 'null' value.
appliance.DeviceState.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.
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…
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…
appliance.SystemInfo
The SystemInfo object represents the Intersight Appliance's system information. It is a singleton managed object that is created during the setup of the Inters…
iam.ServiceProvider
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
appliance.NodeStatus.Response
The response body of a HTTP GET request for the 'appliance.NodeStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
appliance.DataExportPolicy
DataExportPolicies define category-based data collection controls for exporting data from an Intersight Appliance to Intersight. The policy is organized as a h…
appliance.DeviceCertificate.Response
The response body of a HTTP GET request for the 'appliance.DeviceCertificate' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.KeyValuePair
An arbitrary key and value pair that can be used to for having pair of key and values in application such as Appliance Capabilities.
appliance.FileSystemOpSummary.Response
The response body of a HTTP GET request for the 'appliance.FileSystemOpSummary' resource. The value may be one of the following types. 1. When 'tag' is specifi…
appliance.NodeInfo.Relationship
A relationship to the 'appliance.NodeInfo' resource, or the expanded 'appliance.NodeInfo' resource, or the 'null' value.
asset.DeviceClaim.Relationship
A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.
appliance.UpgradeTracker
The UpgradeTracker object is designed to monitor the history of software upgrades within the Intersight Appliance. It acts as a singleton object to facilitate…
appliance.FileGateway
The FileGateway object provides non-persistent access to files from the Intersight, facilitating efficient file retrieval and storage. Purpose FileGateway acts…
appliance.FileSystemStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
appliance.UpgradeTracker.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.CertificateSetting
The CertificateSetting object manages the certificate used by the Intersight Appliance for browser traffic. It ensures secure communication between the applian…
appliance.ExternalSyslogSetting.Response
The response body of a HTTP GET request for the 'appliance.ExternalSyslogSetting' resource. The value may be one of the following types. 1. When 'tag' is speci…
appliance.CertRenewalPhase
CertRenewalPhase represents a phase of the Intersight Appliance certificate renewal process.
appliance.CpuUtilization.Response
The response body of a HTTP GET request for the 'appliance.CpuUtilization' resource. The value may be one of the following types. 1. When 'tag' is specified in…
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…
appliance.Backup.Response
The response body of a HTTP GET request for the 'appliance.Backup' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
iam.LdapPolicy.Relationship
A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.
appliance.SetupInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.NodeIopsMetric.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.ClusterReplaceNode.Response
The response body of a HTTP GET request for the 'appliance.ClusterReplaceNode' resource. The value may be one of the following types. 1. When 'tag' is specifie…
appliance.FileSystemOpStatus.Response
The response body of a HTTP GET request for the 'appliance.FileSystemOpStatus' resource. The value may be one of the following types. 1. When 'tag' is specifie…
iam.IdpReference.Relationship
A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.
iam.Account.Relationship
A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.
appliance.RemoteFileImport
The RemoteFileImport object supports the import of firmware images to the Intersight Appliance. It facilitates remote requests via SCP or SFTP to download file…
appliance.SystemOpStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.MemoryUtilization
Memory utilization metrics for Intersight Appliance nodes. Measures the percentage of physical RAM being consumed, enabling monitoring of memory pressure and c…
iam.TestIdpConfiguration.Relationship
A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.
appliance.MetaManifest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
appliance.DataExportPolicy.Response
The response body of a HTTP GET request for the 'appliance.DataExportPolicy' resource. The value may be one of the following types. 1. When 'tag' is specified…
appliance.SystemStatus.Response
The response body of a HTTP GET request for the 'appliance.SystemStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in t…
iam.LdapGroup.Relationship
A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.
appliance.GroupStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
appliance.AppStatus
Status of an application.
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
appliance.NodeTelemetry.Response
The response body of a HTTP GET request for the 'appliance.NodeTelemetry' resource. The value may be one of the following types. 1. When 'tag' is specified in…
appliance.FileSystemOpSummary.Relationship
A relationship to the 'appliance.FileSystemOpSummary' resource, or the expanded 'appliance.FileSystemOpSummary' 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 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
Cisco Intersight Certificatemanagement API
#Appliance
Where this information came from
This is an independent, third-party profile of Cisco Intersight Appliance 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.