Cisco Intersight Workload API
The workload API from Cisco Intersight — 14 operation(s) for workload.
Cisco Intersight Workload 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 Workload. 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 33 operations across 14 paths, and defines 201 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}.
33 operations
14 paths
201 schemas
5 DELETE14 GET5 PATCH9 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Workload 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 33
Across 14 paths, the API surfaces 33 operations — 5 DELETE, 14 GET, 5 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.
workload 33
GET
/api/v1/workload/Blueprints
Read a 'workload.Blueprint' resource.
POST
/api/v1/workload/Blueprints
Create a 'workload.Blueprint' resource.
GET
/api/v1/workload/Blueprints/{Moid}
Read a 'workload.Blueprint' resource.
POST
/api/v1/workload/Blueprints/{Moid}
Update a 'workload.Blueprint' resource.
PATCH
/api/v1/workload/Blueprints/{Moid}
Update a 'workload.Blueprint' resource.
DELETE
/api/v1/workload/Blueprints/{Moid}
Delete a 'workload.Blueprint' resource.
GET
/api/v1/workload/ClearWorkloadTags
Read a 'workload.ClearWorkloadTag' resource.
POST
/api/v1/workload/ClearWorkloadTags
Create a 'workload.ClearWorkloadTag' resource.
GET
/api/v1/workload/ClearWorkloadTags/{Moid}
Read a 'workload.ClearWorkloadTag' resource.
DELETE
/api/v1/workload/ClearWorkloadTags/{Moid}
Delete a 'workload.ClearWorkloadTag' resource.
GET
/api/v1/workload/DeploymentInputs
Read a 'workload.DeploymentInput' resource.
GET
/api/v1/workload/DeploymentInputs/{Moid}
Read a 'workload.DeploymentInput' resource.
GET
/api/v1/workload/WorkloadDefinitions
Read a 'workload.WorkloadDefinition' resource.
POST
/api/v1/workload/WorkloadDefinitions
Create a 'workload.WorkloadDefinition' resource.
GET
/api/v1/workload/WorkloadDefinitions/{Moid}
Read a 'workload.WorkloadDefinition' resource.
POST
/api/v1/workload/WorkloadDefinitions/{Moid}
Update a 'workload.WorkloadDefinition' resource.
PATCH
/api/v1/workload/WorkloadDefinitions/{Moid}
Update a 'workload.WorkloadDefinition' resource.
DELETE
/api/v1/workload/WorkloadDefinitions/{Moid}
Delete a 'workload.WorkloadDefinition' resource.
GET
/api/v1/workload/WorkloadDeployments
Read a 'workload.WorkloadDeployment' resource.
POST
/api/v1/workload/WorkloadDeployments
Create a 'workload.WorkloadDeployment' resource.
GET
/api/v1/workload/WorkloadDeployments/{Moid}
Read a 'workload.WorkloadDeployment' resource.
POST
/api/v1/workload/WorkloadDeployments/{Moid}
Update a 'workload.WorkloadDeployment' resource.
PATCH
/api/v1/workload/WorkloadDeployments/{Moid}
Update a 'workload.WorkloadDeployment' resource.
DELETE
/api/v1/workload/WorkloadDeployments/{Moid}
Delete a 'workload.WorkloadDeployment' resource.
GET
/api/v1/workload/WorkloadInstances
Read a 'workload.WorkloadInstance' resource.
GET
/api/v1/workload/WorkloadInstances/{Moid}
Read a 'workload.WorkloadInstance' resource.
DELETE
/api/v1/workload/WorkloadInstances/{Moid}
Delete a 'workload.WorkloadInstance' resource.
POST
/api/v1/workload/WorkloadInstances/{Moid}
Update a 'workload.WorkloadInstance' resource.
PATCH
/api/v1/workload/WorkloadInstances/{Moid}
Update a 'workload.WorkloadInstance' resource.
GET
/api/v1/workload/WorkloadMetadata
Read a 'workload.WorkloadMetadata' resource.
GET
/api/v1/workload/WorkloadMetadata/{Moid}
Read a 'workload.WorkloadMetadata' resource.
POST
/api/v1/workload/WorkloadMetadata/{Moid}
Update a 'workload.WorkloadMetadata' resource.
PATCH
/api/v1/workload/WorkloadMetadata/{Moid}
Update a 'workload.WorkloadMetadata' resource.
Schemas 201
The contract defines 201 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.
pool.AbstractPool
Pool represents a collection of identifiers that can be allocated to server profiles.
pkix.KeyGenerationSpec
The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.
resourcepool.ResourcePoolParameters
The resource pool can hold different type of resources, each resources can have some specific parameters and functionality, those details are captured as part…
workload.AssignedResource
Resource that has been assigned to a workload instance.
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.
resourcepool.PoolMember.Relationship
A relationship to the 'resourcepool.PoolMember' resource, or the expanded 'resourcepool.PoolMember' resource, or the 'null' value.
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.
workload.WorkloadDefinition
Overview The WorkloadDefinition object represents the blueprint for defining reusable workload configurations that can be deployed across one or more organizat…
iam.SwitchAccountPermission
SwitchScope parameters related to the Account to/from which user switched.
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…
iam.ApiKey.Relationship
A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.
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.
scheduler.BaseScheduleParams
Defines the base class for setting up schedule parameters.
scheduler.AbstractSchedulingParams
Set schedule parameters abstract type.
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.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.
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,…
blueprint.BlueprintDefinitionDependency
Definition to capture a dependency on another blueprint that is referred in this blueprint.
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…
workload.ClearWorkloadTag
Overview The ClearWorkloadTag API helps remove the system-defined workload tag from the specified objects. This API should only be used under the guidance of T…
workload.GeneratedObject
A generated object that is created as part of the workload deployment when creating prerequisite objects for service item deployment. The generated object is c…
mo.VersionContext
VersionContext contains the versioning info for an object.
workload.DeploymentInput.Response
The response body of a HTTP GET request for the 'workload.DeploymentInput' resource. The value may be one of the following types. 1. When 'tag' is specified in…
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.
iam.ClientMeta
Contains meta information of the client. Currently it is used only within OAuth clients.
resourcepool.LeaseParameters
The lease operations has some special operations based on the PoolType and ResourceType. Those special operations are handled based on this parameter.
workload.WorkloadDeployment.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…
resourcepool.LeaseResource
Lease API is for reserve or unreserve the resource from the pool. Those reserved resource details are maintained in LeaseResource.
iam.UserPreference.Relationship
A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.
resource.AbstractResourceQualificationPolicy
The base QualificationPolicy extends from AbstractPolicy; all qualification policies will be derived from this class. For example, ServerPoolQualificationPolic…
workload.WorkloadMetadata
Overview The WorkloadMetadata holds version agnostic information about a workload definition. It serves as a statistical summary and aggregation container for…
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.
workload.BlueprintInputReference
Type to capture the input data for the referred blueprint.
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.
organization.Organization.Relationship
A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.
blueprint.PreGenerateOperation
A set of MO operations to be executed before generating the object. The operations are run prior to object generation and can be used to perform additional cle…
resource.AbstractResourceQualificationPolicy.Relationship
A relationship to the 'resource.AbstractResourceQualificationPolicy' resource, or the expanded 'resource.AbstractResourceQualificationPolicy' resource, or the…
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…
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
workload.WorkloadDeployment
Overview The WorkloadDeployment object represents an active deployment configuration that creates and manages workload instances based on a workload definition…
workload.WorkloadDefinition.Response
The response body of a HTTP GET request for the 'workload.WorkloadDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified…
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…
scheduler.TaskScheduleStatus
The scheduled task details.
workload.DeploymentInput.Relationship
A relationship to the 'workload.DeploymentInput' resource, or the expanded 'workload.DeploymentInput' resource, or the 'null' value.
iam.PrivilegeSet
A collection of privileges.
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.
iam.Permission.Relationship
A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.
workload.Blueprint.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iam.AbstractQualifier.Relationship
A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.
blueprint.ServiceItemDefinition
Definition to capture the service item that is being referred in this blueprint.
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.
workload.StateAggregation
The aggregated state information for a collection of referenced objects, including their overall state and count.
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.
workload.BaseBlueprintReference
Base type to capture all details about the referenced blueprint. This base type will be used to capture referenced blueprint details within Workload and Deploy…
workload.DeploymentBlueprintInputType
Type to capture the input data for the referred blueprint.
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.
mo.DocumentCount
A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.
workload.RolloutStrategy
Defines the strategy for rolling out changes to instances.
iam.LocalUserPassword.Relationship
A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.
resourcepool.Reservation.Relationship
A relationship to the 'resourcepool.Reservation' resource, or the expanded 'resourcepool.Reservation' resource, or the 'null' value.
pool.AbstractLease
Concrete Children of Abstract Lease represent a single ID that is part of an ID universe. Concrete Children of this class will implement ID request action.
policy.AbstractPolicy
A base abstract class for all configuration policies that can be applied to service profiles.
workload.RenameRequest
The request for a rename operation on an object.
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
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…
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…
resourcepool.ResourceEvaluationStatus
The resources are added to the pool based on conditions specified by the qualifiers. If there are any changes in the qualifier conditions or the properties of…
workload.WorkloadDeployment.Response
The response body of a HTTP GET request for the 'workload.WorkloadDeployment' resource. The value may be one of the following types. 1. When 'tag' is specified…
iam.ServiceProvider
ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs. Purpose It provides SP metad…
resourcepool.Pool
Pool represents a collection of resource. The resource can be any MO which has PoolResource meta enabled. The resource in the pool can be reserved or unreserve…
iam.AbstractQualifier
Placeholder for different types of qualifiers.
iam.PermissionToRoles
Complex type representing a permission and its associated roles.
blueprint.GeneratedObjectMetadata
Type to capture the details of the generated objects.
blueprint.BaseGeneratedObjectSourceMetadata
Base type to capture common details of how the source object is provided.
workload.WorkloadDefinition.Relationship
A relationship to the 'workload.WorkloadDefinition' resource, or the expanded 'workload.WorkloadDefinition' resource, or the 'null' value.
iam.SessionLimits
The session related configuration limits.
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.…
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…
scheduler.SchedulePolicy
SchedulePolicies define reusable, policy-based scheduling definitions for running tasks either one-time or on a recurring cadence. They encapsulate one or more…
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…
scheduler.SchedulePolicy.Relationship
A relationship to the 'scheduler.SchedulePolicy' resource, or the expanded 'scheduler.SchedulePolicy' resource, or the 'null' value.
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.
workload.ClearWorkloadTag.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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…
resourcepool.LeaseResource.Relationship
A relationship to the 'resourcepool.LeaseResource' resource, or the expanded 'resourcepool.LeaseResource' resource, or the 'null' value.
organization.Organization
Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using r…
workload.WorkloadInstance.Response
The response body of a HTTP GET request for the 'workload.WorkloadInstance' resource. The value may be one of the following types. 1. When 'tag' is specified i…
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.
resourcepool.QualificationType
The QualificationType denotes the method by which a resource is added to a pool. It serves as an identifier to distinguish between static and dynamic resource…
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,…
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…
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…
scheduler.TaskSchedule.Relationship
A relationship to the 'scheduler.TaskSchedule' resource, or the expanded 'scheduler.TaskSchedule' resource, or the 'null' value.
policy.AbstractProfile
Abstract base type for all profiles.
blueprint.PropertyIteration
The input to control loop iterations when deriving array properties in a generated object.
resourcepool.Lease
Lease API invoked by passing resource pool, lease API will reserve or un-reserve the resource from the pool.
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.
scheduler.AbstractTaskRequest
An abstract task request that can be extended to other types of task requests.
iam.Role.Relationship
A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.
resourcepool.Pool.Relationship
A relationship to the 'resourcepool.Pool' resource, or the expanded 'resourcepool.Pool' 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…
workload.DefinitionMapper
Captures the definition and its version to map values for consumers. For example, a WorkloadDeployment references a WorkloadDefinition, containing both the Wor…
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.
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.
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…
scheduler.BlockDate
It represents a range of calendar dates during which scheduling functionality is restricted. This is commonly used to not disrupt operations or schedule update…
scheduler.RestStimTaskRequest
The parameters for a reststim invoked by the scheduler.
workload.ClearWorkloadTag.Response
The response body of a HTTP GET request for the 'workload.ClearWorkloadTag' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workload.DeploymentInput.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
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.AppRegistration
The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials. Purpose An AppR…
resourcepool.Reservation
The resource reservation object, used to hold reserved resources for a pool. It captures the reservation identity (for example, a serial), allocation type, and…
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.
iam.IpAddress.Relationship
A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.
resourcepool.Universe.Relationship
A relationship to the 'resourcepool.Universe' resource, or the expanded 'resourcepool.Universe' resource, or the 'null' value.
policy.ConfigContext
Configuration related state and results.
pool.Reservation
Reservation object holding reserved identity information.
resourcepool.Lease.Relationship
A relationship to the 'resourcepool.Lease' resource, or the expanded 'resourcepool.Lease' resource, or the 'null' value.
blueprint.InputOperationType
Type to capture the operation details for the input.
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
scheduler.TaskSchedulePolicyExecutionStatus
The scheduled Task execution status per schedule defined in SchedulePolicy.
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.
workload.BlueprintReference
Type to capture all details about the blueprint referenced within this workload.
iam.EndPointPrivilege.Relationship
A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.
workload.WorkloadInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
blueprint.GeneratedObjectOperationTarget
The target of a pre-generation operation performed before an object is generated.
iam.ResourceLimits.Relationship
A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.
resourcepool.Universe
Universe represents a book keeping container to keep track of all Resources for a given Account.
iam.Privilege
Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.
workload.WorkloadMetadata.Relationship
A relationship to the 'workload.WorkloadMetadata' resource, or the expanded 'workload.WorkloadMetadata' resource, or the 'null' value.
workload.WorkloadInstance
Overview The WorkloadInstance object represents a single deployed instance of a workload, created and managed by a workload deployment. It captures the runtime…
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.
workload.DeploymentChangeDetail
Captures details of changes at the workload deployment level.
resource.ResourceQualifier
The resources are matched with multiple qualifiers; ResourceQualifier is the base class for all qualifiers.
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.
workload.ResourceConstraint
The constraints that need to be applied to the resources in order to match this blueprint.
workload.DeploymentInput
Overview The DeploymentInput object captures a versioned snapshot of all input parameters and configuration values for a workload deployment at a specific poin…
mo.BaseMo
object
The base abstract class for all Cisco Intersight managed objects.
15 properties
3 required
workload.WorkloadDeployment.Relationship
A relationship to the 'workload.WorkloadDeployment' resource, or the expanded 'workload.WorkloadDeployment' 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…
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…
scheduler.TaskSchedule
TaskSchedules are the runtime scheduling objects that drive one-time or recurring executions. A TaskSchedule can run directly using explicit schedule parameter…
resource.PerTypeCombinedSelector
Complex type representing an object type to associated filter by combining all selectors.
pool.AbstractPoolMember
A single entity that is part of a pool like a resource in a resource pool or an ID in an identity pool such as IP, MAC, UUID etc.
mo.MoRef
object
A reference to a REST resource, uniquely identified by object type and Moid.
5 properties
3 required
workload.WorkloadMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workload.Blueprint
Overview The Blueprint object defines a reusable, versioned template for deploying infrastructure configurations and services. It encapsulates input schemas, m…
workload.WorkloadDefinition.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…
mo.TagSummary
A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.
blueprint.ResourceConstraints
Type to capture the resource constraints for the blueprints.
resourcepool.PoolMember
PoolMember represents a resources that is part of a pool.
resourcepool.ChildLeaseCondition
Condition to determine the eligibility of the resource for leasing. The condition includes one or more qualifiers that define the resource's qualification for…
iam.EndPointRole.Relationship
A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.
ExcelFile
string
The content is an Excel spreadsheet.
mo.BaseResponse
object
The base response schema.
1 property
1 required
workload.Blueprint.Response
The response body of a HTTP GET request for the 'workload.Blueprint' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
workload.WorkloadMetadata.Response
The response body of a HTTP GET request for the 'workload.WorkloadMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified i…
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
#Workload
Where this information came from
This is an independent, third-party profile of Cisco Intersight Workload 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.