Cisco Intersight Orchestrator API
Workflow designer, connector pack, converged-infrastructure and Infrastructure-as-a-Service orchestration operations. 183 operations across 98 paths and 5 resource tag(s), from Cisco's own OpenAPI 3.0.2 document.
Cisco Intersight Orchestrator API is one of 11 APIs that Cisco Intersight publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orchestration, Automation, Workflows, connectorpack, and convergedinfra. 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 183 operations across 98 paths, organized into 5 resource areas, and defines 292 schemas. It is described by OpenAPI 3.0.2, at version 1.0.11-20260807064027971.
Requests are made against a single base URL, https://{server}.
183 operations
98 paths
292 schemas
21 DELETE96 GET22 PATCH44 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Orchestrator 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 183
Across 98 paths, the API surfaces 183 operations — 21 DELETE, 96 GET, 22 PATCH, 44 POST. They span 5 resource areas: connectorpack, convergedinfra, iaas, ucsd, workflow. Each is listed below with its method, path, parameters, and response codes.
connectorpack 6
GET
/api/v1/connectorpack/ConnectorPackUpgrades
Read a 'connectorpack.ConnectorPackUpgrade' resource.
POST
/api/v1/connectorpack/ConnectorPackUpgrades
Create a 'connectorpack.ConnectorPackUpgrade' resource.
GET
/api/v1/connectorpack/ConnectorPackUpgrades/{Moid}
Read a 'connectorpack.ConnectorPackUpgrade' resource.
DELETE
/api/v1/connectorpack/ConnectorPackUpgrades/{Moid}
Delete a 'connectorpack.ConnectorPackUpgrade' resource.
GET
/api/v1/connectorpack/UpgradeImpacts
Read a 'connectorpack.UpgradeImpact' resource.
GET
/api/v1/connectorpack/UpgradeImpacts/{Moid}
Read a 'connectorpack.UpgradeImpact' resource.
convergedinfra 14
GET
/api/v1/convergedinfra/AdapterComplianceDetails
Read a 'convergedinfra.AdapterComplianceDetails' resource.
GET
/api/v1/convergedinfra/AdapterComplianceDetails/{Moid}
Read a 'convergedinfra.AdapterComplianceDetails' resource.
GET
/api/v1/convergedinfra/Pods
Read a 'convergedinfra.Pod' resource.
GET
/api/v1/convergedinfra/Pods/{Moid}
Read a 'convergedinfra.Pod' resource.
POST
/api/v1/convergedinfra/Pods/{Moid}
Update a 'convergedinfra.Pod' resource.
PATCH
/api/v1/convergedinfra/Pods/{Moid}
Update a 'convergedinfra.Pod' resource.
GET
/api/v1/convergedinfra/PodComplianceInfos
Read a 'convergedinfra.PodComplianceInfo' resource.
GET
/api/v1/convergedinfra/PodComplianceInfos/{Moid}
Read a 'convergedinfra.PodComplianceInfo' resource.
GET
/api/v1/convergedinfra/ServerComplianceDetails
Read a 'convergedinfra.ServerComplianceDetails' resource.
GET
/api/v1/convergedinfra/ServerComplianceDetails/{Moid}
Read a 'convergedinfra.ServerComplianceDetails' resource.
GET
/api/v1/convergedinfra/StorageComplianceDetails
Read a 'convergedinfra.StorageComplianceDetails' resource.
GET
/api/v1/convergedinfra/StorageComplianceDetails/{Moid}
Read a 'convergedinfra.StorageComplianceDetails' resource.
GET
/api/v1/convergedinfra/SwitchComplianceDetails
Read a 'convergedinfra.SwitchComplianceDetails' resource.
GET
/api/v1/convergedinfra/SwitchComplianceDetails/{Moid}
Read a 'convergedinfra.SwitchComplianceDetails' resource.
iaas 24
GET
/api/v1/iaas/ConnectorPacks
Read a 'iaas.ConnectorPack' resource.
GET
/api/v1/iaas/ConnectorPacks/{Moid}
Read a 'iaas.ConnectorPack' resource.
GET
/api/v1/iaas/CustomTaskInfos
Read a 'iaas.CustomTaskInfo' resource.
GET
/api/v1/iaas/CustomTaskInfos/{Moid}
Read a 'iaas.CustomTaskInfo' resource.
GET
/api/v1/iaas/DeviceStatuses
Read a 'iaas.DeviceStatus' resource.
GET
/api/v1/iaas/DeviceStatuses/{Moid}
Read a 'iaas.DeviceStatus' resource.
GET
/api/v1/iaas/DiagnosticMessages
Read a 'iaas.DiagnosticMessages' resource.
GET
/api/v1/iaas/DiagnosticMessages/{Moid}
Read a 'iaas.DiagnosticMessages' resource.
GET
/api/v1/iaas/LicenseInfos
Read a 'iaas.LicenseInfo' resource.
GET
/api/v1/iaas/LicenseInfos/{Moid}
Read a 'iaas.LicenseInfo' resource.
GET
/api/v1/iaas/MostRunTasks
Read a 'iaas.MostRunTasks' resource.
GET
/api/v1/iaas/MostRunTasks/{Moid}
Read a 'iaas.MostRunTasks' resource.
GET
/api/v1/iaas/ServiceRequests
Read a 'iaas.ServiceRequest' resource.
GET
/api/v1/iaas/ServiceRequests/{Moid}
Read a 'iaas.ServiceRequest' resource.
GET
/api/v1/iaas/SystemTaskInfos
Read a 'iaas.SystemTaskInfo' resource.
GET
/api/v1/iaas/SystemTaskInfos/{Moid}
Read a 'iaas.SystemTaskInfo' resource.
GET
/api/v1/iaas/UcsdInfos
Read a 'iaas.UcsdInfo' resource.
GET
/api/v1/iaas/UcsdInfos/{Moid}
Read a 'iaas.UcsdInfo' resource.
POST
/api/v1/iaas/UcsdInfos/{Moid}
Update a 'iaas.UcsdInfo' resource.
PATCH
/api/v1/iaas/UcsdInfos/{Moid}
Update a 'iaas.UcsdInfo' resource.
GET
/api/v1/iaas/UcsdManagedInfras
Read a 'iaas.UcsdManagedInfra' resource.
GET
/api/v1/iaas/UcsdManagedInfras/{Moid}
Read a 'iaas.UcsdManagedInfra' resource.
GET
/api/v1/iaas/UcsdMessages
Read a 'iaas.UcsdMessages' resource.
GET
/api/v1/iaas/UcsdMessages/{Moid}
Read a 'iaas.UcsdMessages' resource.
ucsd 3
GET
/api/v1/ucsd/BackupInfos
Read a 'ucsd.BackupInfo' resource.
GET
/api/v1/ucsd/BackupInfos/{Moid}
Read a 'ucsd.BackupInfo' resource.
DELETE
/api/v1/ucsd/BackupInfos/{Moid}
Delete a 'ucsd.BackupInfo' resource.
workflow 136
GET
/api/v1/workflow/AnsibleBatchExecutors
Read a 'workflow.AnsibleBatchExecutor' resource.
POST
/api/v1/workflow/AnsibleBatchExecutors
Create a 'workflow.AnsibleBatchExecutor' resource.
GET
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Read a 'workflow.AnsibleBatchExecutor' resource.
POST
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Update a 'workflow.AnsibleBatchExecutor' resource.
PATCH
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Update a 'workflow.AnsibleBatchExecutor' resource.
DELETE
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Delete a 'workflow.AnsibleBatchExecutor' resource.
GET
/api/v1/workflow/BatchApiExecutors
Read a 'workflow.BatchApiExecutor' resource.
POST
/api/v1/workflow/BatchApiExecutors
Create a 'workflow.BatchApiExecutor' resource.
GET
/api/v1/workflow/BatchApiExecutors/{Moid}
Read a 'workflow.BatchApiExecutor' resource.
POST
/api/v1/workflow/BatchApiExecutors/{Moid}
Update a 'workflow.BatchApiExecutor' resource.
PATCH
/api/v1/workflow/BatchApiExecutors/{Moid}
Update a 'workflow.BatchApiExecutor' resource.
DELETE
/api/v1/workflow/BatchApiExecutors/{Moid}
Delete a 'workflow.BatchApiExecutor' resource.
GET
/api/v1/workflow/Catalogs
Read a 'workflow.Catalog' resource.
GET
/api/v1/workflow/Catalogs/{Moid}
Read a 'workflow.Catalog' resource.
GET
/api/v1/workflow/CatalogItemDefinitions
Read a 'workflow.CatalogItemDefinition' resource.
POST
/api/v1/workflow/CatalogItemDefinitions
Create a 'workflow.CatalogItemDefinition' resource.
GET
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Read a 'workflow.CatalogItemDefinition' resource.
POST
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Update a 'workflow.CatalogItemDefinition' resource.
PATCH
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Update a 'workflow.CatalogItemDefinition' resource.
DELETE
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Delete a 'workflow.CatalogItemDefinition' resource.
GET
/api/v1/workflow/CatalogServiceRequests
Read a 'workflow.CatalogServiceRequest' resource.
POST
/api/v1/workflow/CatalogServiceRequests
Create a 'workflow.CatalogServiceRequest' resource.
GET
/api/v1/workflow/CatalogServiceRequests/{Moid}
Read a 'workflow.CatalogServiceRequest' resource.
POST
/api/v1/workflow/CatalogServiceRequests/{Moid}
Update a 'workflow.CatalogServiceRequest' resource.
PATCH
/api/v1/workflow/CatalogServiceRequests/{Moid}
Update a 'workflow.CatalogServiceRequest' resource.
DELETE
/api/v1/workflow/CatalogServiceRequests/{Moid}
Delete a 'workflow.CatalogServiceRequest' resource.
GET
/api/v1/workflow/CustomDataTypeDefinitions
Read a 'workflow.CustomDataTypeDefinition' resource.
POST
/api/v1/workflow/CustomDataTypeDefinitions
Create a 'workflow.CustomDataTypeDefinition' resource.
GET
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Read a 'workflow.CustomDataTypeDefinition' resource.
POST
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Update a 'workflow.CustomDataTypeDefinition' resource.
PATCH
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Update a 'workflow.CustomDataTypeDefinition' resource.
DELETE
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Delete a 'workflow.CustomDataTypeDefinition' resource.
GET
/api/v1/workflow/ErrorResponseHandlers
Read a 'workflow.ErrorResponseHandler' resource.
POST
/api/v1/workflow/ErrorResponseHandlers
Create a 'workflow.ErrorResponseHandler' resource.
GET
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Read a 'workflow.ErrorResponseHandler' resource.
POST
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Update a 'workflow.ErrorResponseHandler' resource.
PATCH
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Update a 'workflow.ErrorResponseHandler' resource.
DELETE
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Delete a 'workflow.ErrorResponseHandler' resource.
GET
/api/v1/workflow/PowerShellBatchApiExecutors
Read a 'workflow.PowerShellBatchApiExecutor' resource.
POST
/api/v1/workflow/PowerShellBatchApiExecutors
Create a 'workflow.PowerShellBatchApiExecutor' resource.
GET
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Read a 'workflow.PowerShellBatchApiExecutor' resource.
POST
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Update a 'workflow.PowerShellBatchApiExecutor' resource.
PATCH
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Update a 'workflow.PowerShellBatchApiExecutor' resource.
DELETE
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Delete a 'workflow.PowerShellBatchApiExecutor' resource.
GET
/api/v1/workflow/RollbackWorkflows
Read a 'workflow.RollbackWorkflow' resource.
POST
/api/v1/workflow/RollbackWorkflows
Create a 'workflow.RollbackWorkflow' resource.
GET
/api/v1/workflow/RollbackWorkflows/{Moid}
Read a 'workflow.RollbackWorkflow' resource.
POST
/api/v1/workflow/RollbackWorkflows/{Moid}
Update a 'workflow.RollbackWorkflow' resource.
PATCH
/api/v1/workflow/RollbackWorkflows/{Moid}
Update a 'workflow.RollbackWorkflow' resource.
DELETE
/api/v1/workflow/RollbackWorkflows/{Moid}
Delete a 'workflow.RollbackWorkflow' resource.
GET
/api/v1/workflow/ServiceItemActionDefinitions
Read a 'workflow.ServiceItemActionDefinition' resource.
POST
/api/v1/workflow/ServiceItemActionDefinitions
Create a 'workflow.ServiceItemActionDefinition' resource.
GET
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Read a 'workflow.ServiceItemActionDefinition' resource.
POST
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Update a 'workflow.ServiceItemActionDefinition' resource.
PATCH
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Update a 'workflow.ServiceItemActionDefinition' resource.
DELETE
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Delete a 'workflow.ServiceItemActionDefinition' resource.
GET
/api/v1/workflow/ServiceItemActionInstances
Read a 'workflow.ServiceItemActionInstance' resource.
POST
/api/v1/workflow/ServiceItemActionInstances
Create a 'workflow.ServiceItemActionInstance' resource.
GET
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Read a 'workflow.ServiceItemActionInstance' resource.
POST
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Update a 'workflow.ServiceItemActionInstance' resource.
PATCH
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Update a 'workflow.ServiceItemActionInstance' resource.
DELETE
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Delete a 'workflow.ServiceItemActionInstance' resource.
GET
/api/v1/workflow/ServiceItemAttributes
Read a 'workflow.ServiceItemAttribute' resource.
GET
/api/v1/workflow/ServiceItemAttributes/{Moid}
Read a 'workflow.ServiceItemAttribute' resource.
GET
/api/v1/workflow/ServiceItemDefinitions
Read a 'workflow.ServiceItemDefinition' resource.
POST
/api/v1/workflow/ServiceItemDefinitions
Create a 'workflow.ServiceItemDefinition' resource.
GET
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Read a 'workflow.ServiceItemDefinition' resource.
POST
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Update a 'workflow.ServiceItemDefinition' resource.
PATCH
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Update a 'workflow.ServiceItemDefinition' resource.
DELETE
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Delete a 'workflow.ServiceItemDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckDefinitions
Read a 'workflow.ServiceItemHealthCheckDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}
Read a 'workflow.ServiceItemHealthCheckDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckExecutions
Read a 'workflow.ServiceItemHealthCheckExecution' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}
Read a 'workflow.ServiceItemHealthCheckExecution' resource.
GET
/api/v1/workflow/ServiceItemInstances
Read a 'workflow.ServiceItemInstance' resource.
POST
/api/v1/workflow/ServiceItemInstances
Create a 'workflow.ServiceItemInstance' resource.
GET
/api/v1/workflow/ServiceItemInstances/{Moid}
Read a 'workflow.ServiceItemInstance' resource.
POST
/api/v1/workflow/ServiceItemInstances/{Moid}
Update a 'workflow.ServiceItemInstance' resource.
PATCH
/api/v1/workflow/ServiceItemInstances/{Moid}
Update a 'workflow.ServiceItemInstance' resource.
DELETE
/api/v1/workflow/ServiceItemInstances/{Moid}
Delete a 'workflow.ServiceItemInstance' resource.
GET
/api/v1/workflow/ServiceItemOutputs
Read a 'workflow.ServiceItemOutput' resource.
POST
/api/v1/workflow/ServiceItemOutputs
Create a 'workflow.ServiceItemOutput' resource.
GET
/api/v1/workflow/ServiceItemOutputs/{Moid}
Read a 'workflow.ServiceItemOutput' resource.
POST
/api/v1/workflow/ServiceItemOutputs/{Moid}
Update a 'workflow.ServiceItemOutput' resource.
PATCH
/api/v1/workflow/ServiceItemOutputs/{Moid}
Update a 'workflow.ServiceItemOutput' resource.
DELETE
/api/v1/workflow/ServiceItemOutputs/{Moid}
Delete a 'workflow.ServiceItemOutput' resource.
GET
/api/v1/workflow/SshBatchExecutors
Read a 'workflow.SshBatchExecutor' resource.
POST
/api/v1/workflow/SshBatchExecutors
Create a 'workflow.SshBatchExecutor' resource.
GET
/api/v1/workflow/SshBatchExecutors/{Moid}
Read a 'workflow.SshBatchExecutor' resource.
POST
/api/v1/workflow/SshBatchExecutors/{Moid}
Update a 'workflow.SshBatchExecutor' resource.
PATCH
/api/v1/workflow/SshBatchExecutors/{Moid}
Update a 'workflow.SshBatchExecutor' resource.
DELETE
/api/v1/workflow/SshBatchExecutors/{Moid}
Delete a 'workflow.SshBatchExecutor' resource.
GET
/api/v1/workflow/TaskDebugLogs
Read a 'workflow.TaskDebugLog' resource.
GET
/api/v1/workflow/TaskDebugLogs/{Moid}
Read a 'workflow.TaskDebugLog' resource.
GET
/api/v1/workflow/TaskDefinitions
Read a 'workflow.TaskDefinition' resource.
POST
/api/v1/workflow/TaskDefinitions
Create a 'workflow.TaskDefinition' resource.
GET
/api/v1/workflow/TaskDefinitions/{Moid}
Read a 'workflow.TaskDefinition' resource.
POST
/api/v1/workflow/TaskDefinitions/{Moid}
Update a 'workflow.TaskDefinition' resource.
PATCH
/api/v1/workflow/TaskDefinitions/{Moid}
Update a 'workflow.TaskDefinition' resource.
DELETE
/api/v1/workflow/TaskDefinitions/{Moid}
Delete a 'workflow.TaskDefinition' resource.
GET
/api/v1/workflow/TaskInfos
Read a 'workflow.TaskInfo' resource.
GET
/api/v1/workflow/TaskInfos/{Moid}
Read a 'workflow.TaskInfo' resource.
POST
/api/v1/workflow/TaskInfos/{Moid}
Update a 'workflow.TaskInfo' resource.
PATCH
/api/v1/workflow/TaskInfos/{Moid}
Update a 'workflow.TaskInfo' resource.
GET
/api/v1/workflow/TaskMetadata
Read a 'workflow.TaskMetadata' resource.
GET
/api/v1/workflow/TaskMetadata/{Moid}
Read a 'workflow.TaskMetadata' resource.
POST
/api/v1/workflow/TemplateEvaluations
Create a 'workflow.TemplateEvaluation' resource.
GET
/api/v1/workflow/TemplateFunctionMeta
Read a 'workflow.TemplateFunctionMeta' resource.
GET
/api/v1/workflow/TemplateFunctionMeta/{Moid}
Read a 'workflow.TemplateFunctionMeta' resource.
POST
/api/v1/workflow/TemplateParsers
Create a 'workflow.TemplateParser' resource.
GET
/api/v1/workflow/UiDisplayMetadata
Read a 'workflow.UiDisplayMetadata' resource.
POST
/api/v1/workflow/UiDisplayMetadata
Create a 'workflow.UiDisplayMetadata' resource.
GET
/api/v1/workflow/UiDisplayMetadata/{Moid}
Read a 'workflow.UiDisplayMetadata' resource.
POST
/api/v1/workflow/UiDisplayMetadata/{Moid}
Update a 'workflow.UiDisplayMetadata' resource.
PATCH
/api/v1/workflow/UiDisplayMetadata/{Moid}
Update a 'workflow.UiDisplayMetadata' resource.
DELETE
/api/v1/workflow/UiDisplayMetadata/{Moid}
Delete a 'workflow.UiDisplayMetadata' resource.
GET
/api/v1/workflow/Variables
Read a 'workflow.Variable' resource.
POST
/api/v1/workflow/Variables
Create a 'workflow.Variable' resource.
GET
/api/v1/workflow/Variables/{Moid}
Read a 'workflow.Variable' resource.
POST
/api/v1/workflow/Variables/{Moid}
Update a 'workflow.Variable' resource.
PATCH
/api/v1/workflow/Variables/{Moid}
Update a 'workflow.Variable' resource.
DELETE
/api/v1/workflow/Variables/{Moid}
Delete a 'workflow.Variable' resource.
GET
/api/v1/workflow/WorkflowDefinitions
Read a 'workflow.WorkflowDefinition' resource.
POST
/api/v1/workflow/WorkflowDefinitions
Create a 'workflow.WorkflowDefinition' resource.
GET
/api/v1/workflow/WorkflowDefinitions/{Moid}
Read a 'workflow.WorkflowDefinition' resource.
POST
/api/v1/workflow/WorkflowDefinitions/{Moid}
Update a 'workflow.WorkflowDefinition' resource.
PATCH
/api/v1/workflow/WorkflowDefinitions/{Moid}
Update a 'workflow.WorkflowDefinition' resource.
DELETE
/api/v1/workflow/WorkflowDefinitions/{Moid}
Delete a 'workflow.WorkflowDefinition' resource.
GET
/api/v1/workflow/WorkflowInfos
Read a 'workflow.WorkflowInfo' resource.
POST
/api/v1/workflow/WorkflowInfos
Create a 'workflow.WorkflowInfo' resource.
GET
/api/v1/workflow/WorkflowInfos/{Moid}
Read a 'workflow.WorkflowInfo' resource.
POST
/api/v1/workflow/WorkflowInfos/{Moid}
Update a 'workflow.WorkflowInfo' resource.
PATCH
/api/v1/workflow/WorkflowInfos/{Moid}
Update a 'workflow.WorkflowInfo' resource.
DELETE
/api/v1/workflow/WorkflowInfos/{Moid}
Delete a 'workflow.WorkflowInfo' resource.
GET
/api/v1/workflow/WorkflowMetadata
Read a 'workflow.WorkflowMetadata' resource.
GET
/api/v1/workflow/WorkflowMetadata/{Moid}
Read a 'workflow.WorkflowMetadata' resource.
Schemas 292
The contract defines 292 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.
connectorpack.ConnectorPackUpdate
Connector Pack updates available on UCS Director.
connectorpack.ConnectorPackUpgrade.Response
The response body of a HTTP GET request for the 'connectorpack.ConnectorPackUpgrade' resource. The value may be one of the following types. 1. When 'tag' is sp…
connectorpack.ConnectorPackUpgrade
Used to download or install connector packs on the target device.
connectorpack.ConnectorPackUpgrade.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
connectorpack.UpgradeImpact.Response
The response body of a HTTP GET request for the 'connectorpack.UpgradeImpact' resource. The value may be one of the following types. 1. When 'tag' is specified…
connectorpack.UpgradeImpact
The UpgradeImpact object is designed to assess and identify the list of connector packs to be installed or upgraded on UCS Director. It identifies the requisit…
connectorpack.UpgradeImpact.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.AdapterComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.AdapterComplianceDetails' resource. The value may be one of the following types. 1. When 'tag'…
convergedinfra.AdapterComplianceDetails.Relationship
A relationship to the 'convergedinfra.AdapterComplianceDetails' resource, or the expanded 'convergedinfra.AdapterComplianceDetails' resource, or the 'null' val…
convergedinfra.AdapterComplianceDetails
The AdapterComplianceDetails object captures compliance details for adapters within servers of a converged infrastructure pod, focusing on hardware compatibili…
convergedinfra.AdapterComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.AlarmSummary
The summary of alarm counts based on alarm serverity.
convergedinfra.BaseComplianceDetails.Relationship
A relationship to the 'convergedinfra.BaseComplianceDetails' resource, or the expanded 'convergedinfra.BaseComplianceDetails' resource, or the 'null' value.
convergedinfra.BaseComplianceDetails
Abstract type for all compliance details that may be part of a converged infrastructure pod.
convergedinfra.BasePod
Abstract base type for all pods.
convergedinfra.BasePodSummary
Summary information for the base pod. This inclues properties like number of nodes, stroage capacity/utilization, aggregated alarms for all the components of t…
convergedinfra.ComplianceSummary
The summary of compliance information based on the compliance analysis (HCL, IMT, etc.) of components.
convergedinfra.Pod.Response
The response body of a HTTP GET request for the 'convergedinfra.Pod' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
convergedinfra.Pod.Relationship
A relationship to the 'convergedinfra.Pod' resource, or the expanded 'convergedinfra.Pod' resource, or the 'null' value.
convergedinfra.Pod
Overview The Pod object represents a unit of deployment within a converged infrastructure. It encompasses inventory details related to health, hardware compati…
convergedinfra.Pod.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.PodComplianceInfo.Response
The response body of a HTTP GET request for the 'convergedinfra.PodComplianceInfo' resource. The value may be one of the following types. 1. When 'tag' is spec…
convergedinfra.PodComplianceInfo.Relationship
A relationship to the 'convergedinfra.PodComplianceInfo' resource, or the expanded 'convergedinfra.PodComplianceInfo' resource, or the 'null' value.
convergedinfra.PodComplianceInfo
The PodComplianceInfo object captures compliance information for a converged infrastructure pod, extending the base compliance details to include specific comp…
convergedinfra.PodComplianceInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.PodSummary
Summary information for the Pod, this is extenstion of properties defined in basePodSummary.
convergedinfra.ServerComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.ServerComplianceDetails' resource. The value may be one of the following types. 1. When 'tag' i…
convergedinfra.ServerComplianceDetails.Relationship
A relationship to the 'convergedinfra.ServerComplianceDetails' resource, or the expanded 'convergedinfra.ServerComplianceDetails' resource, or the 'null' value.
convergedinfra.ServerComplianceDetails
The ServerComplianceDetails object provides compliance information for servers within a converged infrastructure pod, detailing hardware compatibility and oper…
convergedinfra.ServerComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.StorageComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.StorageComplianceDetails' resource. The value may be one of the following types. 1. When 'tag'…
convergedinfra.StorageComplianceDetails.Relationship
A relationship to the 'convergedinfra.StorageComplianceDetails' resource, or the expanded 'convergedinfra.StorageComplianceDetails' resource, or the 'null' val…
convergedinfra.StorageComplianceDetails
The StorageComplianceDetails object provides compliance information for storage arrays within a converged infrastructure pod, assessing their interoperability…
convergedinfra.StorageComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
convergedinfra.SwitchComplianceDetails.Response
The response body of a HTTP GET request for the 'convergedinfra.SwitchComplianceDetails' resource. The value may be one of the following types. 1. When 'tag' i…
convergedinfra.SwitchComplianceDetails.Relationship
A relationship to the 'convergedinfra.SwitchComplianceDetails' resource, or the expanded 'convergedinfra.SwitchComplianceDetails' resource, or the 'null' value.
convergedinfra.SwitchComplianceDetails
The SwitchComplianceDetails object captures compliance information for switches, such as Fabric Interconnects, Nexus, and MDS, within a converged infrastructur…
convergedinfra.SwitchComplianceDetails.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.ConnectorPack.Response
The response body of a HTTP GET request for the 'iaas.ConnectorPack' resource. The value may be one of the following types. 1. When 'tag' is specified in the U…
iaas.ConnectorPack.Relationship
A relationship to the 'iaas.ConnectorPack' resource, or the expanded 'iaas.ConnectorPack' resource, or the 'null' value.
iaas.ConnectorPack
The ConnectorPack object is essential for managing connector pack versions within UCS Director (UCSD), facilitating configuration and dependency management. Pu…
iaas.ConnectorPack.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.CustomTaskInfo.Response
The response body of a HTTP GET request for the 'iaas.CustomTaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iaas.CustomTaskInfo.Relationship
A relationship to the 'iaas.CustomTaskInfo' resource, or the expanded 'iaas.CustomTaskInfo' resource, or the 'null' value.
iaas.CustomTaskInfo
The CustomTaskInfo object offers insights into the execution of custom tasks within UCS Director (UCSD), supporting workflow customization and management. Purp…
iaas.CustomTaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.DeviceStatus.Response
The response body of a HTTP GET request for the 'iaas.DeviceStatus' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iaas.DeviceStatus.Relationship
A relationship to the 'iaas.DeviceStatus' resource, or the expanded 'iaas.DeviceStatus' resource, or the 'null' value.
iaas.DeviceStatus
The DeviceStatus object is pivotal in managing infrastructure accounts within UCS Director (UCSD), offering insights into connection status and device details.…
iaas.DeviceStatus.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.DiagnosticMessages.Response
The response body of a HTTP GET request for the 'iaas.DiagnosticMessages' resource. The value may be one of the following types. 1. When 'tag' is specified in…
iaas.DiagnosticMessages
The DiagnosticMessages object is vital for capturing diagnostic alerts and messages within UCS Director (UCSD), aiding in system health monitoring and issue re…
iaas.DiagnosticMessages.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.LicenseInfo.Response
The response body of a HTTP GET request for the 'iaas.LicenseInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
iaas.LicenseInfo.Relationship
A relationship to the 'iaas.LicenseInfo' resource, or the expanded 'iaas.LicenseInfo' resource, or the 'null' value.
iaas.LicenseInfo
The LicenseInfo object is a fundamental component in managing license details within UCS Director (UCSD), providing a structured overview of license types and…
iaas.LicenseInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.LicenseKeysInfo
Overview The LicenseKeysInfo object serves as an essential element in managing license details within UCS Director. It encapsulates information about unique li…
iaas.LicenseUtilizationInfo
Overview The LicenseUtilizationInfo object is crucial for managing and understanding the utilization of licenses within the UCS Director (UCSD). This provides…
iaas.MostRunTasks.Response
The response body of a HTTP GET request for the 'iaas.MostRunTasks' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iaas.MostRunTasks.Relationship
A relationship to the 'iaas.MostRunTasks' resource, or the expanded 'iaas.MostRunTasks' resource, or the 'null' value.
iaas.MostRunTasks
The MostRunTasks object provides insights into frequently executed workflow tasks within UCS Director (UCSD). Purpose MostRunTasks captures data about task exe…
iaas.MostRunTasks.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.ServiceRequest.Response
The response body of a HTTP GET request for the 'iaas.ServiceRequest' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iaas.ServiceRequest
The ServiceRequest object is integral to managing service requests within UCS Director (UCSD), capturing essential details about service request and statuses r…
iaas.ServiceRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.SystemTaskInfo.Response
The response body of a HTTP GET request for the 'iaas.SystemTaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the…
iaas.SystemTaskInfo.Relationship
A relationship to the 'iaas.SystemTaskInfo' resource, or the expanded 'iaas.SystemTaskInfo' resource, or the 'null' value.
iaas.SystemTaskInfo
The SystemTaskInfo object provides details about library task executions within UCS Director (UCSD), supporting system oversight and process management. Purpos…
iaas.SystemTaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdInfo.Response
The response body of a HTTP GET request for the 'iaas.UcsdInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL qu…
iaas.UcsdInfo.Relationship
A relationship to the 'iaas.UcsdInfo' resource, or the expanded 'iaas.UcsdInfo' resource, or the 'null' value.
iaas.UcsdInfo
The UcsdInfo object is a central component in managing UCS Director accounts, offering insights into system configurations and connection status. It facilitate…
iaas.UcsdInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdManagedInfra.Response
The response body of a HTTP GET request for the 'iaas.UcsdManagedInfra' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
iaas.UcsdManagedInfra.Relationship
A relationship to the 'iaas.UcsdManagedInfra' resource, or the expanded 'iaas.UcsdManagedInfra' resource, or the 'null' value.
iaas.UcsdManagedInfra
The UcsdManagedInfra object is critical for overseeing UCS Director (UCSD) managed infrastructure, providing statistics and insights into managed resources. Pu…
iaas.UcsdManagedInfra.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.UcsdMessages.Response
The response body of a HTTP GET request for the 'iaas.UcsdMessages' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
iaas.UcsdMessages
The UcsdMessages object captures messages from UCS Director (UCSD), supporting system communication and alert management. Purpose UcsdMessages document system…
iaas.UcsdMessages.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
iaas.WorkflowSteps
Overview The WorkflowSteps object is integral to managing workflow operations within UCS Director (UCSD), capturing the step-by-step progression of service req…
ucsd.BackupInfo.Response
The response body of a HTTP GET request for the 'ucsd.BackupInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
ucsd.BackupInfo
The BackupInfo object provides detailed insights into backup images available for restoration on target endpoint (UCS Director) devices. It captures essential…
ucsd.BackupInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
ucsd.ConnectorPack
Connector pack details from the backup file.
ucsd.UcsdRestoreParameters
UCS director restore workflow configuration parameters.
workflow.AbstractLoopTask
An abstract loop task which is used to model different types of loops like serial and parallel.
workflow.AbstractResourceSelector
The abstract selector which can be used to create selection criteria for inputs.
workflow.AbstractWorkerTask
An AbstractWorkerTask is used to model a task that does some end-user work. This can be another task or it can be another workflow.
workflow.AnsibleBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.AnsibleBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.AnsibleBatchExecutor
The AnsibleBatchExecutor object is a core component within Intersight's workflow framework, designed to facilitate the execution of Ansible commands in batch m…
workflow.AnsibleBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.AnsiblePlaySession
This models a single Ansible playbook execution session on the Ansible Control node. While execution of the respective Ansible task, the below provided propert…
workflow.Api
Intersight Orchestrator supports generic API workflow tasks that can execute an API given the request body and response parser specification. API type models a…
workflow.ArrayDataType
This data type represents an array of a given type. It can be an array of primitive data or of custom data.
workflow.ArrayItem
ArrayItem represents an array item within the array.
workflow.AssociatedRoles
AssociatedRoles models the inferred tasks to the required roles mapping cached in the workflow definition.
workflow.BaseDataType
The base data type that is used to derive all the other data types for inputs and outputs.
workflow.BaseOperation
Specify operation type on a service item like deployment or post-deployment to be performed on catalog.
workflow.BaseServiceItemActionProperty
BaseServiceItemActionProperty is the abstract definition to capture the properties in ServiceItemActionProperties.
workflow.BatchApiExecutor.Response
The response body of a HTTP GET request for the 'workflow.BatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.BatchApiExecutor
The BatchApiExecutor object is a key component within the workflow system that facilitates the execution of multiple API requests as part of a single task exec…
workflow.BatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.BatchExecutor
Intersight support for creating generic API tasks using the API request body and a response parser specification in the form of a content.Grammar object. The B…
workflow.CancelableType
Defines the conditions under which a workflow can be canceled.
workflow.Catalog.Response
The response body of a HTTP GET request for the 'workflow.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
workflow.Catalog.Relationship
A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value.
workflow.Catalog
The Catalog object serves as a container for organizing definitions related to orchestration, including both workflow, task definitions and more. Purpose It pr…
workflow.Catalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.CatalogItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.CatalogItemDefinition.Relationship
A relationship to the 'workflow.CatalogItemDefinition' resource, or the expanded 'workflow.CatalogItemDefinition' resource, or the 'null' value.
workflow.CatalogItemDefinition
Catalog Item definition is a collection of Service items which are associated with workflow definition that can be used to deploy and manage service items.
workflow.CatalogItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogServiceRequest.Response
The response body of a HTTP GET request for the 'workflow.CatalogServiceRequest' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.CatalogServiceRequest.Relationship
A relationship to the 'workflow.CatalogServiceRequest' resource, or the expanded 'workflow.CatalogServiceRequest' resource, or the 'null' value.
workflow.CatalogServiceRequest
Catalog Service Request is one instance of a catalog item based on a catalog item definition.
workflow.CatalogServiceRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CliCommand
This models a single CLI command that can be executed on the end point.
workflow.Comments
Contains detailed information about template function.
workflow.Constraints
Captures the constraints for valid parameter values.
workflow.ControlTask
Control tasks run within the workflow engine and are not executed by remote worker microservices. They are used to modify flow of control within a workflow.
workflow.CustomArrayItem
Captures an array of custom datatype items.
workflow.CustomDataProperty
Capture all the properties for Custom data type.
workflow.CustomDataType
This data type represents a custom data object.
workflow.CustomDataTypeDefinition.Response
The response body of a HTTP GET request for the 'workflow.CustomDataTypeDefinition' resource. The value may be one of the following types. 1. When 'tag' is spe…
workflow.CustomDataTypeDefinition.Relationship
A relationship to the 'workflow.CustomDataTypeDefinition' resource, or the expanded 'workflow.CustomDataTypeDefinition' resource, or the 'null' value.
workflow.CustomDataTypeDefinition
The CustomDataTypeDefinition object provides a framework for defining customized data types used within workflows, enhancing flexibility and reusability. Purpo…
workflow.CustomDataTypeDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CustomDataTypeProperties
Properties for a custom data type definition.
workflow.DataSourceSelector
An alternative selector to MoReferenceProperty that serves as a data source for PrimitiveDataTypes. It supports selecting data from workflow execution sources,…
workflow.DecisionCase
A Decision Case is a condition for a Decision Task. It is the equivalent of case statement in the programming language paradigm of switch and case.
workflow.DecisionTask
A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task.
workflow.DefaultValue
Captures default vales for a data type.
workflow.DisplayMeta
Captures the meta data needed for displaying workflow data types in Intersight User Interface.
workflow.DynamicTemplateParserDataType
Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL use…
workflow.EndTask
An EndTask denotes the completion of a workflow.
workflow.EnumEntry
Captures a single enum entry which has a label and value.
workflow.EnvironmentVariableReference
Holds environment variables references.
workflow.ErrorResponseHandler.Response
The response body of a HTTP GET request for the 'workflow.ErrorResponseHandler' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ErrorResponseHandler.Relationship
A relationship to the 'workflow.ErrorResponseHandler' resource, or the expanded 'workflow.ErrorResponseHandler' resource, or the 'null' value.
workflow.ErrorResponseHandler
The ErrorResponseHandler object is designed to manage error responses within the workflow system. This provides a standardized way to define error response spe…
workflow.ErrorResponseHandler.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ExpectPrompt
This models a single expect and answer prompt of the interactive command.
workflow.FailureEndTask
A FailureEndTask denotes the failed completion of a workflow.
workflow.FileDownloadOp
File operation to download a given file from Intersight storage services such as AWS or Minio bucket to a specified path on one or more Intersight connected de…
workflow.FileOperations
This models a single File Operation request within a batch of requests that get executed within a single workflow task.
workflow.FileTemplateOp
Populates data driven template file with input values to generate textual output.
workflow.FileTransfer
Message to transfer a file from Intersight connected device to remote server.
workflow.ForkTask
A ForkTask is a control task that forks tasks for parallel execution in a workflow.
workflow.InitiatorContext
Details about the workflow initiator name, type, initiator object Id if present and the result handler.
workflow.InternalProperties
Internal properties for a task definition which are not editable by the user.
workflow.JoinTask
A JoinTask is a control task that must follow a fork task and specify all the fork tasks that must complete and join before the worfklow can proceed to the tas…
workflow.LoopTask
A Parallel Loop is a control task that runs one task or one sub-workflow multiple times based on a specified count. The count can be a static value that is spe…
workflow.Message
Intermediate Task or Workflow message with severity.
workflow.MigrateServiceItemActionProperty
Definition to capture the properties for migrate action in ServiceItemActionProperties.
workflow.MigrationHistory
Migration history of versions for service item instance.
workflow.MoInventoryDataType
The data type to represent the selected properties of an Intersight managed object. This data type is used only in Service items to define the schema of resour…
workflow.MoInventoryProperty
Captures the properties from the original Intersight resource that need to be reflected in the datatype.
workflow.MoReferenceArrayItem
MoReferenceArrayItem is used to create an array of MoReference datatype.
workflow.MoReferenceAutoArrayItem
MoReferenceAutoArrayItem is used to create an array of MoReferenceAuto datatype.
workflow.MoReferenceAutoDataType
The data type to capture an Intersight managed object reference that is automatically selected by the system based on a given selection criteria.
workflow.MoReferenceAutoProperty
Captures all the display attributes and rules for selecting the resources.
workflow.MoReferenceDataType
Data type to capture an Intersight Managed object reference.
workflow.MoReferenceForCloneDataType
Data type captures a reference to an Intersight Managed Object (MO) that serves as the source for cloning and creating an input object. The fields to be passed…
workflow.MoReferenceProperty
Capture all the properties for an Intersight managed object reference.
workflow.OperationTypeDecommission
Operation details for decommission actions.
workflow.OperationTypeDeployment
Definition to capture the operation details for deployment actions.
workflow.OperationTypePostDeployment
Operation details for post-deployment actions.
workflow.ParameterSet
The parameter set is a rule with a condition to match the controlling parameter against a value and make a set of parameters applicable.
workflow.PowerShellApi
This models a single PowerShell script execution that can be sent to a claimed PowerShell target.
workflow.PowerShellBatchApiExecutor.Response
The response body of a HTTP GET request for the 'workflow.PowerShellBatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is s…
workflow.PowerShellBatchApiExecutor
Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Bat…
workflow.PowerShellBatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.PrimitiveArrayItem
PrimitiveArrayItem is used to create an array of primitive datatype. In order to create an array of strings, integers or float use PrimitiveArrayItem object ty…
workflow.PrimitiveDataProperty
Capture all the properties for primitive data type.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
workflow.Properties
Properties for the task definition like the inputs, outputs, timeout and retry policies. Tasks are the building blocks for workflows.
workflow.ResourceInlineSelector
The resource selection inline conditions can be represented using InlineSelector.
workflow.ResourceSelectorCriteria
The resource selector holds one or more Resource Selection conditions and the runtime parameters.
workflow.ResultHandler
The task result handler service details. It will be executed once the workflow reaches terminal state.
workflow.RollbackTask
Rollback task mapping information.
workflow.RollbackWorkflow.Response
The response body of a HTTP GET request for the 'workflow.RollbackWorkflow' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.RollbackWorkflow
The RollbackWorkflow object addresses the management and execution of rollback operations within the workflow system. This provides a structured approach to re…
workflow.RollbackWorkflow.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.RollbackWorkflowTask
Rollback workflow task information.
workflow.SelectorProperty
Selector properties to define HTTP method and 'body' in case of upsert (short for update or insert) operations. When requested resource (endpoint) does not exi…
workflow.SequenceParams
Parameters to capture information required to sequence the workflows.
workflow.SerialLoopTask
A Serial Loop is a control task that runs one or more worker tasks multiple times based on a specified count or a given condition. Either count or condition mu…
workflow.ServiceItemActionDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionDefinition' resource. The value may be one of the following types. 1. When 'tag' is…
workflow.ServiceItemActionDefinition.Relationship
A relationship to the 'workflow.ServiceItemActionDefinition' resource, or the expanded 'workflow.ServiceItemActionDefinition' resource, or the 'null' value.
workflow.ServiceItemActionDefinition
Definition to capture the details needed to execute an action on the service item.
workflow.ServiceItemActionDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionInstance' resource. The value may be one of the following types. 1. When 'tag' is sp…
workflow.ServiceItemActionInstance.Relationship
A relationship to the 'workflow.ServiceItemActionInstance' resource, or the expanded 'workflow.ServiceItemActionInstance' resource, or the 'null' value.
workflow.ServiceItemActionInstance
Service item action instance which represents one action on a service item instance.
workflow.ServiceItemActionInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionProperties
Definition to capture the action properties which will be used in the action of service item.
workflow.ServiceItemActionWorkflowDefinition
Definition to capture the workflow definition which will be used in the action of a service item definition.
workflow.ServiceItemAttribute.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemAttribute' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ServiceItemAttribute
Service item attribute which represents all the artifacts created or related to this service item instance.
workflow.ServiceItemAttribute.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.ServiceItemDefinition.Relationship
A relationship to the 'workflow.ServiceItemDefinition' resource, or the expanded 'workflow.ServiceItemDefinition' resource, or the 'null' value.
workflow.ServiceItemDefinition
Service Item definition is a collection of actions and associated workflow definition that can be used to deploy a service item.
workflow.ServiceItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemHealthCheckDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckDefinition' resource. The value may be one of the following types. 1. When 'tag…
workflow.ServiceItemHealthCheckDefinition.Relationship
A relationship to the 'workflow.ServiceItemHealthCheckDefinition' resource, or the expanded 'workflow.ServiceItemHealthCheckDefinition' resource, or the 'null'…
workflow.ServiceItemHealthCheckDefinition
Service item health check definition metadata.
workflow.ServiceItemHealthCheckDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemHealthCheckExecution.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckExecution' resource. The value may be one of the following types. 1. When 'tag'…
workflow.ServiceItemHealthCheckExecution
Health check execution result for a health check definition on a service item.
workflow.ServiceItemHealthCheckExecution.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemInputDefinitionType
Definition to capture the inputs for a service items included inside a catalog. It captures the input definition and the associated input parameter mappings fo…
workflow.ServiceItemInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemInstance' resource. The value may be one of the following types. 1. When 'tag' is specifie…
workflow.ServiceItemInstance.Relationship
A relationship to the 'workflow.ServiceItemInstance' resource, or the expanded 'workflow.ServiceItemInstance' resource, or the 'null' value.
workflow.ServiceItemInstance
Service item instance is one instance of a service item based on a service item definition.
workflow.ServiceItemInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemOutput.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemOutput' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.ServiceItemOutput
Service item output which represents all the artifacts created or related to this service item instance.
workflow.ServiceItemOutput.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemType
Definition to capture the service items associated with the catalog.
workflow.SshBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.SshBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.SshBatchExecutor
The SshBatchExecutor object is a core component of Intersight’s workflow system, specialized in handling the batch execution of SSH commands. It is designed to…
workflow.SshBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.SshCmd
SSH command to execute on the remote server.
workflow.SshConfig
Carries the SSH session details for opening a new connection.
workflow.SshSession
This models a single SSH session from Intersight connected endpoint to a remote server. Multiple SSH operations can be run sequentially over a single SSH sessi…
workflow.StartTask
A StartTask is the starting point for a workflow. There can only be one StartTask in a workflow.
workflow.SubWorkflowTask
A SubWorkflowTask is used to include another workflow as a task within this workflow.
workflow.SuccessEndTask
A SuccessEndTask denotes the successful completion of a workflow.
workflow.TargetContext
Target context holds information about the Intersight managed object on which the workflow is executing and hence the entity that is being affected by the work…
workflow.TargetDataType
Data type to capture a target endpoint or device.
workflow.TargetProperty
Capture all the properties for an input target endpoint or device.
workflow.TaskConstraints
Captures the constraints for a task. Currently, it hold only targetDataType constraints such as Vendor, ObjectType that are properties of a target device.
workflow.TaskDebugLog.Response
The response body of a HTTP GET request for the 'workflow.TaskDebugLog' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.TaskDebugLog
The TaskDebugLog object provides detailed debugging information for task execution within workflows. It serves as a critical tool for isolating and resolving t…
workflow.TaskDebugLog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskDefinition.Response
The response body of a HTTP GET request for the 'workflow.TaskDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in…
workflow.TaskDefinition.Relationship
A relationship to the 'workflow.TaskDefinition' resource, or the expanded 'workflow.TaskDefinition' resource, or the 'null' value.
workflow.TaskDefinition
The TaskDefinition object is a foundational element of the workflow system, designed to define individual tasks that can be orchestrated within a workflow. It…
workflow.TaskDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskInfo.Response
The response body of a HTTP GET request for the 'workflow.TaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
workflow.TaskInfo.Relationship
A relationship to the 'workflow.TaskInfo' resource, or the expanded 'workflow.TaskInfo' resource, or the 'null' value.
workflow.TaskInfo
The TaskInfos object represents the runtime instance of a task executing within a workflow. Purpose It tracks the execution lifecycle of a specific task instan…
workflow.TaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskInfoUpdate
TaskInfoUpdate is used to capture the updates that are required for the task instance inside an executing workflow. WaitTask, included inside the workflow, can…
workflow.TaskLoopInfo
Keep track of loop information for every task executed inside the loop.
workflow.TaskMetadata.Response
The response body of a HTTP GET request for the 'workflow.TaskMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.TaskMetadata.Relationship
A relationship to the 'workflow.TaskMetadata' resource, or the expanded 'workflow.TaskMetadata' resource, or the 'null' value.
workflow.TaskMetadata
Task details is a collection of properties that are common across all the versions of a task.
workflow.TaskMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskRetryInfo
Keep track of task retry information using TaskRetryInfo.
workflow.TemplateEvaluation
The TemplateEvaluation object focuses on the execution and evaluation of templates within the workflow system. This provides mechanisms to dynamically generate…
workflow.TemplateFunctionMeta.Response
The response body of a HTTP GET request for the 'workflow.TemplateFunctionMeta' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.TemplateFunctionMeta
The TemplateFunctionMeta object is a key component within the workflow system, designed to encapsulate the metadata and functionality of template functions. Pu…
workflow.TemplateFunctionMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TemplateParser
The TemplateParser object is designed to parse templates and extract placeholders within the workflow system. It plays a crucial role in template management an…
workflow.UiDisplayMetadata.Response
The response body of a HTTP GET request for the 'workflow.UiDisplayMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.UiDisplayMetadata
The UiDisplayMetadata object captures the visual layout metadata for user interfaces in workflow systems. It focuses on defining form and view layouts, contrib…
workflow.UiDisplayMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.UiFormConfig
Contains metadata which specify the UI form layout for data. The type, schema of the data comes from the datatype definition and only the visual form layout is…
workflow.UiInputFilter
A cascade filter enables the definition or extension of an optional filter for Intersight APIs, to narrow down the search results. This can be defined for work…
workflow.UiViewConfig
Contains metadata which specify the UI view config for data. The type, schema of the data comes from the datatype definition and only the visual layout of data…
workflow.ValidationError
Used to show validation errors for the workflow or for the task within the workflow.
workflow.ValidationInformation
Type used to capture all the validation information for the workflow definition.
workflow.Variable.Response
The response body of a HTTP GET request for the 'workflow.Variable' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
workflow.Variable
The Variable object facilitates the management of user-defined entities within workflows, allowing for consistent and reusable data references across different…
workflow.Variable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WaitTask
A WaitTask will remain in progress until marked success or failed by an external trigger. The timeout for wait task is 180 days, so a workflow can wait for tas…
workflow.WaitTaskPrompt
WaitTaskPrompt is used to create a customized prompts for wait control task. Wait task can be used in workflow for variety of reason, the prompts will help wor…
workflow.WebApi
This models a single Web API request within a batch of requests that get executed within a single workflow task.
workflow.WorkerTask
A WorkerTask is a simple task and the smallest granularity of work that can be defined as a task.
workflow.WorkflowCtx
The workflow context contains initiator and target information along with workflow type and action information.
workflow.WorkflowDefinition.Response
The response body of a HTTP GET request for the 'workflow.WorkflowDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.WorkflowDefinition.Relationship
A relationship to the 'workflow.WorkflowDefinition' resource, or the expanded 'workflow.WorkflowDefinition' resource, or the 'null' value.
workflow.WorkflowDefinition
The WorkflowDefinitions object serves as the blueprint for automation, representing a collection of tasks sequenced as a Directed Acyclic Graph (DAG). Purpose…
workflow.WorkflowDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowEngineProperties
Properties for performing workflow action on workflow engine.
workflow.WorkflowInfo.Response
The response body of a HTTP GET request for the 'workflow.WorkflowInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.WorkflowInfo.Relationship
A relationship to the 'workflow.WorkflowInfo' resource, or the expanded 'workflow.WorkflowInfo' resource, or the 'null' value.
workflow.WorkflowInfo
The WorkflowInfo object encapsulates the execution instance of a workflow, providing details about its progress, state, and execution context. It is essential…
workflow.WorkflowInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowInfoAutoRestartProperties
Properties for auto-restarting a failed workflow execution. Workflow will be auto-restarted from the beginning upon failure when the autorestart property is se…
workflow.WorkflowInfoProperties
Properties for a workflowInfo.
workflow.WorkflowMetadata.Response
The response body of a HTTP GET request for the 'workflow.WorkflowMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.WorkflowMetadata.Relationship
A relationship to the 'workflow.WorkflowMetadata' resource, or the expanded 'workflow.WorkflowMetadata' resource, or the 'null' value.
workflow.WorkflowMetadata
Workflow metadata is a collection of properties that are common across all the versions of a workflow.
workflow.WorkflowMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowProperties
Properties for a workflow definition.
workflow.WorkflowTask
Task instance within the workflow to be executed.
workflow.XmlApi
This models a single XML API request that can be sent to any Cisco UCS devices that support Cisco UCS XML API interface.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cisco Intersight 10
Other APIs Cisco Intersight publishes across the network.
Cisco Intersight Fabric API
Cisco Intersight HyperFlex API
Cisco Intersight Kubernetes API
Cisco Intersight Nexus Insight Advisor API
Cisco Intersight Server API
Cisco Intersight Storage API
Cisco Intersight System API
Cisco Intersight Telemetry API
Cisco Intersight Virtualization API
Cisco Intersight Workflows API
#Orchestration#Automation#Workflows#connectorpack#convergedinfra#Infrastructure-as-a-Service#ucsd
Where this information came from
This is an independent, third-party profile of Cisco Intersight Orchestrator 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.