REST API for Oracle AI Data Platform Workbench

All REST Endpoints

Audit

The operations from the Audit category.

Manage audit logs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/actions/manageAuditLogs
Search audit logs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/actions/searchAuditLogs

Bundle

The operations from the Bundle category.

(Preview) Create a new bundle in a workspace folder: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles
(Preview) Deploy all bundle resources: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/deploy
(Preview) Destroy all deployed bundle resources: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/purge
(Preview) Return the latest known deployment summary for a bundle: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/getDeploymentStatus

Catalog

The operations from the Catalog category.

Create a catalog: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs
Delete a catalog: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}
Get a list of catalogs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs
Get catalog details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}
Get list of catalog permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/permissions
Refresh catalog through crawler: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/actions/refresh
Test external catalog connection: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/actions/testConnection
Update catalog details: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}
Update permissions for a catalog: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/actions/managePermission

Cluster

The operations from the Cluster category.

Create a cluster: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters
Delete a cluster: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}
Get cluster details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}
Get cluster libraries: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/libraries
Get cluster permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/permissions
Get clusters in a workspace: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters
Get default cluster: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/defaultCluster
Patch cluster libraries: Method: patch
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/libraries
Restart running cluster: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/restart
Start a termintated cluster: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/start
Stop a Cluster: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/stop
Update cluster details: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}
Update cluster permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/managePermission

DeltaShare

The operations from the DeltaShare category.

Create a Delta Share: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares
Create a Delta Share recipient: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients
Delete a Delta Share: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}
Delete a recipient: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}
Get a list of Delta Share access for a recipient: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/shares
Get a list of Delta Share access for a recipient: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/permissions
Get a list of Delta Share recipients: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients
Get a list of Delta Shares: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares
Get a list of recipients specific to a Delta Share: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/recipients
Get Delta Share details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}
Get Delta Share recipient details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}
Get list of Delta Share recipient permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/permissions
Gets a list of Delta Share assets: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/dataAssets
Update a Delta Share: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}
Update a Delta Share recipient: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}
Update consumer-side access on a share for a recipient: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/manageAccess
Update Delta Share permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/managePermission
Update recipient permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/actions/managePermission
Updates Delta Share data assets: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/manageDataAsset

GitService

The operations from the GitService category.

(Preview) Check out a Git branch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/checkOutBranch
(Preview) Commit and push Git changes: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/commitPush
(Preview) Create a Git branch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/gitBranches
(Preview) Get a list of Git branches: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/gitBranches
(Preview) Get connected Git repository: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}
(Preview) Get Git file diff: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitDiffDetails
(Preview) Get Git operation state: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitOperationState
(Preview) Get list of file-level Git diffs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitDiff
(Preview) Merge Git branch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/merge
(Preview) Pull Git changes: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/pull
(Preview) Rebase Git branch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/rebase
(Preview) Reset Git branch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/reset
(Preview) Reset workspace Git state: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/resetState
(Preview) Resolve Git conflicts: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/resolveConflicts
(Preview) Update Git repository metadata: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}

MLOps

The operations from the MLOps category.

(Preview) Create a model version: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/create
(Preview) Create a model version in a workspace: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/model-versions/create
(Preview) Create a new experiment run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/create
(Preview) Create a registered model: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/create
(Preview) Create an experiment: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/create
(Preview) Delete a model version: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/delete
(Preview) Delete a registered model: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/delete
(Preview) Delete an experiment: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/delete
(Preview) Delete an experiment run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/delete
(Preview) Delete an experiment run tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/delete-tag
(Preview) Delete an experiment tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/delete-experiment-tag
(Preview) Delete model version tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/delete-tag
(Preview) Delete registered model tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/delete-tag
(Preview) Get experiment metadata by ID: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/get
(Preview) Get experiment run details by ID: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/get
(Preview) Get experiment run metric history: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/metrics/get-history
(Preview) Get metadata for an experiment by name: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/get-by-name
(Preview) Get model version details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/get
(Preview) Get registered model details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/get
(Preview) List artifacts: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/artifacts/list
(Preview) List experiment runs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/search
(Preview) List experiments: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/search
(Preview) List logged models: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/logged-models/search
(Preview) List model versions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/search
(Preview) List registered models: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/search
(Preview) Log an experiment run batch: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-batch
(Preview) Log an experiment run metric: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-metric
(Preview) Log an experiment run model: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-model
(Preview) Log an experiment run parameter: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-parameter
(Preview) Log experiment run inputs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-inputs
(Preview) Rename a registered model: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/rename
(Preview) Restore an experiment: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/restore
(Preview) Restore an experiment run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/restore
(Preview) Set an experiment run tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/set-tag
(Preview) Set an experiment tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/set-experiment-tag
(Preview) Set model version tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/set-tag
(Preview) Set registered model tag: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/set-tag
(Preview) Transition a model version stage: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/transition-stage
(Preview) Update a model version: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/update
(Preview) Update a registered model: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/update
(Preview) Update an experiment: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/update
(Preview) Update an experiment run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/update
(Preview) Update experiment run tags: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/internal/runs/update-tags
(Preview) Update experiment tags: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/internal/experiments/update-experiment-tags
(Preview) Update model version tags: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/internal/model-versions/update-tags
(Preview) Update registered model tags: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/internal/registered-models/update-tags

Notebook

The operations from the Notebook category.

Create a new notebook file or directory: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}
Create a new session: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions
Delete a notebook file or directory: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}
Delete a session: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions/{sessionId}
Export notebook file contents: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/actions/export/contents/{contentPath}
Get available sessions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions
Get file or directory content: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}
Get session details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions/{sessionId}
Patch a session: Method: patch
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions/{sessionId}
Rename a file or directory: Method: patch
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}
Update notebook contents: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}

Role

The operations from the Role category.

Add member to role: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/actions/addMember
Create a role: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles
Delete a role: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}
Get list of role permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/permissions
Get list of roles: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles
Get role details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}
Remove member from role: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/actions/removeMember
Update a role: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}

Schema

The operations from the Schema category.

Create a managed table from sample file: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/dataTables
Create a schema: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas
Create a table: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables
Create a view: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views
Delete a table: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}
Delete a view: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}
Delete schema: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}
Generate URI for uploading a sample file to a temporary folder in a schema: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/generateTempFileUploadTarget
Get schema details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}
Get schema permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/permissions
Get schema views: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views
Get schemas: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas
Get table details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}
Get table permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/permissions
Get table schema and data: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/inferSchemaWithPreview
Get table schema details: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/inferSchema
Get tables in schema: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables
Get view details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}
Get view permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}/permissions
Refresh schema: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/refresh
Refresh table: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/refresh
Retrieve PAR for created entities: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/getPar
Update a table: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}
Update a view: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}
Update schema: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}
Update schema permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/managePermission
Update table permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/managePermission
Update view permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}/actions/managePermission

UserSetting

The operations from the UserSetting category.

(Preview) Delete a user setting: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings/{settingKey}
(Preview) Get list of user settings by type or default status: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings
(Preview) Get user settings: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings/{settingKey}
(Preview) Manage user credentials and integrations: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings
(Preview) Update a stored user setting: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings/{settingKey}

Volume

The operations from the Volume category.

Create a volume: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes
Create directory in volume: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/mkdir
Delete a volume: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}
Delete a volume file: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/deleteFile
Delete volume directory: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/deleteDir
Download a file to Volume by generating par: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/downloadFileMeta
Download file from volume: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/downloadFile
Get files in volume: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/files
Get volume details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}
Get volume permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/permissions
Get volumes: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes
Update a volume: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}
Update volume directory: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/updateDir
Update volume permissions: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/managePermission
Upload a file to volume: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/uploadFile
Upload a file to volume by generating PAR: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/uploadFileMeta

Workflow

The operations from the Workflow category.

Cancel a job run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}/actions/cancel
Cancel job runs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/actions/cancelJobRuns
Create a job: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs
Create a job run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns
Delete a job: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}
Delete a job run: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}
Export task run output: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}/outputs/{taskRunOutputKey}/actions/export
Fetch task run output from runtime engine: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}/actions/fetchOutput
Get job details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}
Get job permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/permissions
Get job run details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}
Get job runs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns
Get latest job runs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/recentJobRuns
Get list of jobs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs
Get task run details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}
Get task runs: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns
Repair job run: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}/actions/repair
Update job permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/actions/managePermission
Updates a job: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}

Workspace

The operations from the Workspace category.

Create a workspace: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces
Creates a git folder in the workspace: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitFolders
Delete a workspace: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}
Get a list of create workspace permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/createWorkspacePermissions
Get a list of workspace permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/permissions
Get a list of workspaces: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces
Get workspace details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}
Update a workspace: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}
Update create workspace permissions on a workspace: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/actions/manageCreateWorkspacePermission
Update permissions on a workspace: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/managePermission
Update workspace status: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/asyncOperations/{asyncOperationKey}/status

WorkspaceObject

The operations from the WorkspaceObject category.

Copy a workspace object: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/copyObject
Create a workspace object: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects
Delete a workspace object: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectPath}
Download a workspace file by generating PAR: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/downloadFileMeta
Get a list of objects in the workspace: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects
Get a list of workspace object permissions: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectKey}/permissions
Get workspace object details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectPath}
Get workspace object summary metadata: Method: head
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectPath}
Move a workspace object: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/moveObject
Rename a workspace object: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/renameObject
Update a workspace object: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectPath}
Update workspace object permissions: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectKey}/actions/managePermission
Upload a workspace file by generating PAR: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/uploadFileMeta

Wrapper

The operations from the Wrapper category.

Download cluster logs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/downloadLogs
Search cluster logs: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/searchLogs
Summarize compute metrics data: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/summarizeMetricsData

credentialStore

The operations from the credentialStore category.

(Preview) Create new credential: Method: post
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/credentials
(Preview) Delete credentials: Method: delete
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/credentials/{credentialKey}
(Preview) Get credential details: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/credentials/{credentialKey}
(Preview) Get list of credentials: Method: get
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/credentials
(Preview) Update credentials: Method: put
Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/credentials/{credentialKey}