Cloudera AI API
Provision and manage Cloudera AI (formerly Machine Learning) workspaces on an environment. 59 operations. Note that everything INSIDE a workspace — projects, jobs, models, experiments — is served by the workbench’s own API v2 and is not described here.
Cloudera AI API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Machine Learning, Cloudera AI, and Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 59 operations across 59 paths, and defines 162 schemas. It is described by OpenAPI 2.0, at version 0.9.163.
Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.
59 operations
59 paths
162 schemas
59 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 59
Across 59 paths, the API surfaces 59 operations — 59 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 59
POST
/api/v1/ml/addInstanceGroups
Add new Cloudera AI workbench cluster instance groups.
POST
/api/v1/ml/addInstanceGroupsMlServingApp
Add instance group to an existing Cloudera AI Inference Service instance.
POST
/api/v1/ml/backupWorkspace
Backup a Cloudera AI workbench.
POST
/api/v1/ml/createFileReplica
Create file system replica.
POST
/api/v1/ml/createMlServingApp
Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
POST
/api/v1/ml/createModelRegistry
Creates a new model registry.
POST
/api/v1/ml/createWorkspace
Create a Cloudera AI workbench.
POST
/api/v1/ml/deleteBackup
Deletes a backup snapshot.
POST
/api/v1/ml/deleteFileReplica
Delete existing replication for project files.
POST
/api/v1/ml/deleteInstanceGroup
Deletes an instance group from the cluster.
POST
/api/v1/ml/deleteInstanceGroupMlServingApp
Deletes an instance group from a Cloudera AI Inference Service instance.
POST
/api/v1/ml/deleteMlServingApp
Deletes Cloudera AI Inference Service instance.
POST
/api/v1/ml/deleteModelRegistry
Deletes a model registry.
POST
/api/v1/ml/deleteWorkspace
Delete Cloudera AI workbench.
POST
/api/v1/ml/describeMlServingApp
Describe Cloudera AI Inference Service instance.
POST
/api/v1/ml/describeModelRegistry
Deprecated: Cloudera AI Model Registry is now deprecated.
POST
/api/v1/ml/describeWorkspace
Describe Cloudera AI workbench.
POST
/api/v1/ml/describeWorkspaceBackup
Describe backup snaphot of a workbench.
POST
/api/v1/ml/failOverFileSystem
Failover to replica file system
POST
/api/v1/ml/fetchAiRegistriesStorageConfig
Fetch AI Registry storage configuration for a Cloudera AI Inference Service.
POST
/api/v1/ml/getAuditEvents
Gets all the events belong to a workbench crn.
POST
/api/v1/ml/getKubeconfig
ListWorkspaceAccess Cloudera AI workbench.
POST
/api/v1/ml/getLatestModelRegistryVersion
GetLatestModelRegistryVersion Cloudera AI Registry.
POST
/api/v1/ml/getLatestWorkspaceVersion
GetLatestWorkspaceVersion Cloudera AI workbench.
POST
/api/v1/ml/getLogs
Gets all the logs belong to a request id.
POST
/api/v1/ml/getMlServingAppKubeconfig
Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.
POST
/api/v1/ml/getModelRegistryKubeconfig
GetModelRegistryKubeconfig returns kube config for model registry.
POST
/api/v1/ml/grantMlServingAppAccess
Grants admin access to a Cloudera AI Inference Service cluster.
POST
/api/v1/ml/grantModelRegistryAccess
GrantModelRegistryAccess Cloudera AI Model Registry.
POST
/api/v1/ml/grantWorkspaceAccess
GrantWorkspaceAccess Cloudera AI workbench.
POST
/api/v1/ml/listInstanceTypeConfiguration
List the instance configuration for a given instance type.
POST
/api/v1/ml/listMlServingAppAccess
List members that have Kubernetes access to a Cloudera AI Inference Service cluster.
POST
/api/v1/ml/listMlServingApps
List all Cloudera AI Inference Service instances.
POST
/api/v1/ml/listModelRegistries
Lists all model registries.
POST
/api/v1/ml/listModelRegistryAccess
ListWorkspaceAccess Cloudera AI Model Registry.
POST
/api/v1/ml/listRelevantInstances
List the instance types for Cloudera AI workbench creation that have the requested resource.
POST
/api/v1/ml/listWorkspaceAccess
ListWorkspaceAccess Cloudera AI workbench.
POST
/api/v1/ml/listWorkspaceBackups
List backup snapshots of a workbench.
POST
/api/v1/ml/listWorkspaces
List Cloudera AI workbenches.
POST
/api/v1/ml/modifyClusterInstanceGroup
Modify Cloudera AI workbench cluster instance group.
POST
/api/v1/ml/modifyClusterSecurity
Modify Cloudera AI workbench cluster security.
POST
/api/v1/ml/modifyMlServingApp
Modify instance groups for a Cloudera AI Inference Service cluster.
POST
/api/v1/ml/modifyWorkspaceLoadBalancer
Modify Cloudera AI workbench loadbalancer.
POST
/api/v1/ml/refreshAiInference
Refresh AI Inference trust store.
POST
/api/v1/ml/refreshAiRegistry
Refreshes the AI Registry with the latest trust store certificates for the selected instance.
POST
/api/v1/ml/refreshModelRegistryConfigmap
Refreshes the model registry configmap of the workbench.
POST
/api/v1/ml/requestWorkflowCancellation
Request a workflow cancellation.
POST
/api/v1/ml/requestWorkflowRollback
Request a workflow rollback
POST
/api/v1/ml/restoreWorkspace
Restore a Cloudera AI workbench.
POST
/api/v1/ml/resumeWorkspace
Resume Cloudera AI workbench.
POST
/api/v1/ml/revokeMlServingAppAccess
Revokes access to a Cloudera AI Inference Service cluster.
POST
/api/v1/ml/revokeModelRegistryAccess
RevokeModelRegistryAccess Cloudera AI Model Registry.
POST
/api/v1/ml/revokeWorkspaceAccess
RevokeWorkspaceAccess Cloudera AI workbench.
POST
/api/v1/ml/rollbackModelRegistryUpgrade
Rollback a model registry upgrade. Restore prior model registry.
POST
/api/v1/ml/suspendWorkspace
Suspend Cloudera AI workbench.
POST
/api/v1/ml/updateMlServingAppS3Creds
Update S3 credentials for a Cloudera AI Inference Service.
POST
/api/v1/ml/upgradeMlServingApp
Upgrade a Cloudera AI Inference Service instance.
POST
/api/v1/ml/upgradeModelRegistry
Upgrade a model registry.
POST
/api/v1/ml/upgradeWorkspace
Upgrade Cloudera AI workbench.
Schemas 162
The contract defines 162 schemas that model the data the API accepts and returns. The most detailed are Workspace (40 properties), CreateWorkspaceRequest (24 properties), WorkspaceSummary (24 properties), CreateModelRegistryRequest (18 properties). Each schema is shown below with its type and property counts.
Error
object
An object returned on an error.
2 properties
FailOverFileSystemRequest
object
FailOverFileSystemRequest request to fallback to the replica.
1 property
1 required
FailOverFileSystemResponse
object
FailOverFileSystemResponse response to fallback to the replica.
RootVolume
object
Configuration for instance root device volume.
1 property
1 required
GetLogsRequest
object
GetLogsRequest for getting logs for a request ID.
5 properties
1 required
GetLogsResponse
object
GetLogsResponse contains all the logs for a given request id.
1 property
1 required
AuditLogs
object
AuditLogs contains all the logs for a given request id.
3 properties
3 required
AuditLog
object
Audit log represents an individual log.
2 properties
2 required
GetAuditEventsRequest
object
GetAuditEventsRequest to get all audit events for a given workbench crn.
2 properties
GetAuditEventsResponse
object
GetAuditEventsResponse containes all the audit events for a given workbench crn.
1 property
1 required
AuditEvents
object
AuditEvents contains all the audit events for a given workbench crn.
2 properties
2 required
AuditEvent
object
Audit event descibes an performed or performing in a given workbench.
5 properties
5 required
Autoscaling
object
Configuration for instance auto scaling.
3 properties
2 required
InstanceGroup
object
Contains the necessary info for an instance group.
10 properties
1 required
AwsCrConfig
object
The capacity reservation config for EKS
2 properties
Network
object
The network config for capacity reservation.
1 property
Accelerator
object
Accelerator, i.e. GPU configurations.
2 properties
AcceleratorResponse
object
Accelerator, i.e. GPU configurations.
2 properties
WorkspaceInstanceGroup
object
Instance group information to show in workbench details.
13 properties
7 required
Instance
object
Represents each instance in an instance group.
2 properties
2 required
Tag
object
Contains a single tag entry associated with a workbench.
2 properties
2 required
ProvisionTag
object
Contains a single tag entry that will be configured on cloud resources associated with a workbench.
2 properties
2 required
ProvisionK8sRequest
object
Request object for workbench provision. Required in public cloud.
4 properties
2 required
ModelRegistryProvisionK8sRequest
object
Request object for provisioning model registry.
2 properties
OverlayNetwork
object
Contains the information about overlay network.
3 properties
Topology
object
Contains the information about topology.
1 property
Gcp
object
Contains the information about gcp.
1 property
ExistingDatabaseConfig
object
Configurations for bringing an existing database for model metrics
5 properties
DeleteInstanceGroupMlServingAppRequest
object
Request object for the DeleteInstanceGroupMlServingApp method.
2 properties
2 required
DeleteInstanceGroupMlServingAppResponse
object
Response object for the DeleteInstanceGroupMlServingApp method.
AddInstanceGroupsMlServingAppRequest
object
Request object for AddInstanceGroupsMlServingApp method.
2 properties
2 required
AddInstanceGroupsMlServingAppResponse
object
Response object for AddInstanceGroupsMlServingApp method.
CreateWorkspaceRequest
object
Request object for the CreateWorkspace method.
24 properties
2 required
OutboundTypes
string
List of possible Outbound types.
RestoreWorkspaceRequest
object
Request object for RestoreWorkspace method.
4 properties
CreateWorkspaceResponse
object
Response object for the CreateWorkspace method.
RestoreWorkspaceResponse
object
Response object for the RestoreWorkspace method.
2 properties
ListWorkspacesRequest
object
Request object for the ListWorkspaces method.
1 property
ListWorkspacesResponse
object
Response object for the ListWorkspaces method.
1 property
ListWorkspaceBackupsQueryOptions
object
Query options object for ListWorkspaceBackups method.
1 property
ListWorkspaceBackupsRequest
object
Request object for ListWorkspaceBackups method.
4 properties
DescribeWorkspaceBackupRequest
object
Request object for DescribeWorkspaceBackup method.
1 property
DescribeWorkspaceBackupResponse
object
Response object for DescribeWorkspaceBackup method.
8 properties
BackupDetail
object
Backup Detail response object for listing backups.
6 properties
ListWorkspaceBackupsResponse
object
Response object for ListWorkspaceBackups method.
1 property
UpgradeState
object
Response object for the workbench summary.
2 properties
BackupMetadata
object
Backup metadata response object for the workbench summary.
5 properties
WorkspaceSummary
object
A Cloudera AI workbench which includes the deployed configuration details.
24 properties
13 required
Workspace
object
A ML workbench, which includes the cluster and storage.
40 properties
16 required
UpgradeWorkspaceRequest
object
Request object for the UpgradeWorkspace method.
6 properties
UpgradeWorkspaceResponse
object
Response object for the UpgradeWorkspace method.
DescribeWorkspaceRequest
object
Request object for the DescribeWorkspace method.
3 properties
DescribeWorkspaceResponse
object
Response object for the DescribeWorkspace method.
1 property
1 required
DeleteFileReplicaRequest
object
Request object for DeleteFileReplica method.
1 property
1 required
DeleteFileReplicaResponse
object
Response object for DeleteFileReplica method.
DescribeModelRegistryRequest
object
Request object for the DescribeModelRegistry method.
1 property
1 required
DescribeModelRegistryResponse
object
Response object for the DescribeModelRegistry method.
1 property
1 required
DeleteInstanceGroupRequest
object
Request object for the DeleteInstanceGroup method.
2 properties
2 required
DeleteInstanceGroupResponse
object
Response object for the DeleteInstanceGroup method.
DeleteWorkspaceRequest
object
Request object for the DeleteWorkspace method.
5 properties
1 required
DeleteWorkspaceResponse
object
Response object for the DeleteWorkspace method.
CreateFileReplicaRequest
object
Request object for create file replica method.
1 property
1 required
CreateFileReplicaResponse
object
Response object for the CreateFileReplica method.
GrantWorkspaceAccessRequest
object
Request object for the GrantWorkspaceAccess method.
5 properties
GrantWorkspaceAccessResponse
object
Response object for the GrantWorkspaceAccess method.
1 property
1 required
RevokeWorkspaceAccessRequest
object
Request object for the RevokeWorkspace method.
5 properties
RevokeWorkspaceAccessResponse
object
Response object for the RevokeWorkspaceAccess method.
ListWorkspaceAccessRequest
object
Request object for the ListWorkspace method.
3 properties
ListWorkspaceAccessResponse
object
Response object for the ListWorkspaceAccess method.
1 property
1 required
GetKubeconfigRequest
object
Request object for the GetKubeconfig method.
3 properties
GetMlServingAppKubeconfigRequest
object
Request object for the GetMlServingAppKubeconfig method.
1 property
GetModelRegistryKubeconfigRequest
object
Request object for GetModelRegistryKubeconfig.
1 property
GetModelRegistryKubeconfigResponse
object
GetModelRegistryKubeconfigResponse response provides model registry kube config.
1 property
GetKubeconfigResponse
object
Response object for the GetKubeconfig method.
1 property
1 required
GetMlServingAppKubeconfigResponse
object
Response object for the GetMlServingAppKubeconfig method.
1 property
1 required
GetLatestWorkspaceVersionRequest
object
Request object for GetLatestWorkspaceVersion.
GetLatestWorkspaceVersionResponse
object
Response object for GetLatestWorkspaceVersion.
1 property
1 required
HealthInfo
object
Healthinfo object contains the health information of a resource.
5 properties
5 required
ModifyClusterInstanceGroupRequest
object
Request object for ModifyClusterInstanceGroup.
7 properties
5 required
AddInstanceGroupsRequest
object
Request object for AddInstanceGroups.
2 properties
2 required
AddInstanceGroupsResponse
object
Response object for AddInstanceGroups.
ModifyClusterInstanceGroupResponse
object
Response object for ModifyClusterInstanceGroup.
ModifyClusterSecurityRequest
object
Request object for ModifyClusterSecurity.
3 properties
3 required
ModifyClusterSecurityResponse
object
Response object for ModifyClusterSecurity.
ModifyWorkspaceLoadBalancerRequest
object
Request object for ModifyWorkspaceLoadBalancer.
2 properties
2 required
ModifyWorkspaceLoadBalancerResponse
object
Response object for ModifyWorkspaceLoadBalancer.
SuspendWorkspaceRequest
object
Request object for SuspendWorkspace.
1 property
1 required
SuspendWorkspaceResponse
object
Response object for SuspendWorkspace.
ResumeWorkspaceRequest
object
Request object for ResumeWorkspace.
1 property
1 required
ResumeWorkspaceResponse
object
Response object for ResumeWorkspace.
BackupWorkspaceRequest
object
The request object for Cloudera AI workbench backup.
4 properties
2 required
BackupWorkspaceResponse
object
The response object for Cloudera AI workbench backup.
3 properties
DeleteBackupRequest
object
The request object for DeleteBackup operation.
2 properties
1 required
DeleteBackupResponse
object
The response object for DeleteBackup operation.
1 property
WorkflowMetadata
object
The workflow metadata.
5 properties
RequestWorkflowCancellationRequest
object
Request object for RequestWorkflowCancellation.
2 properties
RequestWorkflowCancellationResponse
object
Response object for RequestWorkflowCancellation.
1 property
RequestWorkflowRollbackRequest
object
Request object for RequestWorkflowRollbackRequest.
2 properties
RequestWorkflowRollbackResponse
object
Response object for RequestRollbackCancellation.
1 property
CreateModelRegistryRequest
object
Request object for creating model registry.
18 properties
CreateModelRegistryResponse
object
Response for creating model registry request.
ListModelRegistriesRequest
object
Request object for deleting model registry.
ListModelRegistriesResponse
object
List of all available model registries.
1 property
ModelRegistry
object
Model registry object
17 properties
DeleteModelRegistryRequest
object
Request for deleting model registry.
4 properties
DeleteModelRegistryResponse
object
Delete model registry response.
UpgradeModelRegistryRequest
object
Request for upgrading model registry.
3 properties
AzureUpgradeOptions
object
AzureUpgradeOptions upgrade options for model registry. This message contains configuration options specific to Azure deployments when using User Defined Routi…
1 property
UpgradeModelRegistryResponse
object
Response for upgrading model registry.
1 property
RollbackModelRegistryUpgradeRequest
object
Request for rollback model registry upgrade.
1 property
RollbackModelRegistryUpgradeResponse
object
Response for rollback model registry request.
RefreshModelRegistryConfigmapRequest
object
Request for refreshing workbench's model registry configmap.
1 property
RefreshModelRegistryConfigmapResponse
object
Response for refreshing workbench's model registry configmap.
RefreshAiRegistryRequest
object
Request for refreshing AI registry configmap with enhanced trust store functionality.
1 property
1 required
RefreshAiRegistryResponse
object
Response for refreshing AI registry configmap with enhanced trust store functionality.
ResourceQuota
object
Resource quota configuration for quota management.
3 properties
2 required
ResourcePoolConfig
object
Resource pool configuration for quota management.
2 properties
QuotaConfig
object
Quota configuration for quota management.
3 properties
2 required
GrantModelRegistryAccessRequest
object
Request object for the GrantModelRegistryAccess method.
2 properties
GrantModelRegistryAccessResponse
object
Response object for the GrantModelRegistryAccess method.
1 property
1 required
RevokeModelRegistryAccessRequest
object
Request object for the RevokeModelRegistry method.
2 properties
RevokeModelRegistryAccessResponse
object
Response object for the RevokeModelRegistryAccess method.
ListModelRegistryAccessRequest
object
Request object for the ListModelRegistryAccess method.
1 property
ListModelRegistryAccessResponse
object
Response object for the ListModelRegistryAccess method.
1 property
1 required
CreateMlServingAppRequest
object
Request object for the CreateMlServingApp method.
11 properties
2 required
MlServingOzoneCreds
object
Request object for the MlServingOzoneCreds method.
4 properties
CreateMlServingAppResponse
object
Response object for the CreateMlServingApp method.
1 property
UpgradeMlServingAppRequest
object
Request object for the UpgradeMlServingApp method.
1 property
1 required
UpgradeMlServingAppResponse
object
Response object for the UpgradeMlServingApp method.
DeleteMlServingAppRequest
object
Request object for the DeleteMlServingApp method.
2 properties
1 required
DeleteMlServingAppResponse
object
Response object for the DeleteMlServingApp method.
RefreshAiInferenceRequest
object
Request object for the RefreshAiInference method.
1 property
1 required
RefreshAiInferenceResponse
object
Response object for the RefreshAiInference method.
MlServingProvisionK8sRequest
object
Request object for provisioning Cloudera AI Inference Service instance groups.
4 properties
1 required
ListMlServingAppsRequest
object
Request object for the ListMlServingApps method.
1 property
ListMlServingAppsResponse
object
Response object for the ListMlServingApps method.
1 property
DescribeMlServingAppRequest
object
Request object for the DescribeMlServingApp method.
1 property
1 required
DescribeMlServingAppResponse
object
Response object for the DescribeMlServingApp method.
1 property
MlServingApp
object
The Cloudera AI Inference Service instance.
17 properties
1 required
VersionCompatibilityInfo
object
Version compatibility information for a Cloudera AI Inference Service instance.
3 properties
KubernetesCluster
object
The Kubernetes cluster information
12 properties
ListRelevantInstancesRequest
object
Request object for the ListRelevantInstances method.
6 properties
4 required
ListRelevantInstancesResponse
object
Response object for the ListRelevantInstances method.
1 property
1 required
ListInstanceTypeConfigurationRequest
object
Request object for the ListInstanceTypeConfiguration method.
6 properties
4 required
ListInstanceTypeConfigurationResponse
object
Response object for the ListInstanceTypeConfiguration method.
1 property
1 required
RequestResourceInfo
object
Instance Details
8 properties
InstanceDetails
object
Instance Details
10 properties
5 required
GrantMlServingAppAccessRequest
object
Request object for the GrantMlServingAppAccess method.
2 properties
GrantMlServingAppAccessResponse
object
Response object for the GrantMlServingAppAccess method.
1 property
1 required
RevokeMlServingAppAccessRequest
object
Request object for the RevokeMlServingAppAccess method.
2 properties
RevokeMlServingAppAccessResponse
object
Response object for the RevokeMlServingAppAccess method.
ListMlServingAppAccessRequest
object
Request object for the ListMlServingAppAccess method.
1 property
ListMlServingAppAccessResponse
object
Response object for the ListMlServingAppAccess method.
1 property
1 required
ModifyMlServingAppRequest
object
Request object for the ModifyMlServingApp method.
5 properties
5 required
ModifyMlServingAppResponse
object
Response object for ModifyMlServingApp method.
GetLatestModelRegistryVersionRequest
object
Request object for GetLatestModelRegistryVersion.
GetLatestModelRegistryVersionResponse
object
Response object for GetLatestModelRegistryVersion.
1 property
1 required
UpdateMlServingAppS3CredsRequest
object
Request object for the UpdateMlServingAppS3Creds method.
5 properties
2 required
UpdateMlServingAppS3CredsResponse
object
Response object for the UpdateMlServingAppS3Creds method.
FetchAiRegistriesStorageConfigRequest
object
Request object for the FetchAiRegistriesStorageConfig method.
1 property
1 required
AiRegistryStorageConfigEntry
object
One AI Registry storage row keyed by Kubernetes namespace in FetchAiRegistriesStorageConfigResponse.
6 properties
FetchAiRegistriesStorageConfigResponse
object
Response object for the FetchAiRegistriesStorageConfig method.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cloudera 12
Other APIs Cloudera publishes across the network.
Cloudera Audit Service API
Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
#Machine Learning#Cloudera AI#Workspaces
Where this information came from
This is an independent, third-party profile of Cloudera AI 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.