/datarobot-deployments | Type: Application | PCID required: Yes
Tools
datarobot_deployments_agent_card_delete_many
Delete the agent card for a deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the deployment. |
datarobot_deployments_agent_card_list
Retrieve the agent card for a deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the deployment. |
datarobot_deployments_agent_card_put_many
Create or replace the agent card for the deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the deployment. |
datarobot_deployments_capabilities_list
Retrieve capabilities. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_custom_model_deployments_limit_state_list
Get custom model deployment limits.datarobot_deployments_custom_model_deployments_list
List custom model deployments. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | This many results will be skipped. |
limit | integer | Yes | — | At most this many results are returned. |
customModelIds | any[] | No | — | List of ID’s of the custom model which model deployments will be retrieved. |
environmentIds | any[] | No | — | List of ID’s of the execution environment which model deployments will be retrieved. |
datarobot_deployments_custom_model_deployments_logs_create
Get custom model log. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the custom model deployment. |
datarobot_deployments_custom_model_deployments_logs_list
Get custom model log. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the custom model deployment. |
datarobot_deployments_custom_model_deployments_logs_retrieve
Get custom model log. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | The ID of the custom model deployment. |
logId | string | Yes | — | The ID of the custom model deployment log. |
datarobot_deployments_deleted_deployments_list
List deleted deployments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | The number of deleted deployments to skip. |
limit | integer | Yes | — | The number of deleted deployments to return. |
datarobot_deployments_deleted_deployments_patch_many
Erase deleted deployments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | Action to perform on these deleted deployments. |
deploymentIds | any[] | Yes | — | ID of a list of deleted deployments to perform action on. |
datarobot_deployments_deployments_delete
Delete deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ignoreManagementAgent | string | No | — | Do not wait for management agent to delete the deployment first. |
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_deployments_list
List deployments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | The number of deployments to skip. Defaults to 0. |
limit | integer | Yes | — | The number of deployments (greater than zero, max 100) to return. Defaults to 20. |
orderBy | string | No | — | The order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order. |
search | string | No | — | Case insensitive search against deployment’s label and description. |
serviceHealth | any[] | No | — | Filters deployments by their service health status. |
modelHealth | any[] | No | — | Filters deployments by their model health status. |
accuracyHealth | any[] | No | — | Filters deployments by their accuracy health status. |
role | string | No | — | Filter deployments to only those that the authenticated user has the specified role for. |
status | any[] | No | — | Filters deployments by their status |
importance | any[] | No | — | Filters deployments by their importance |
lastPredictionTimestampStart | string | No | — | Only include deployments that have had a prediction request on or after the specified timestamp. |
lastPredictionTimestampEnd | string | No | — | Only include deployments that have had a prediction request before the specified timestamp. |
predictionUsageDailyAvgGreaterThan | integer | No | — | only include deployments that have had more than the specified number of predictions per day on average over the past week. |
predictionUsageDailyAvgLessThan | integer | No | — | Only include deployments that have had fewer than the specified number of predictions per day on average over the past week. |
defaultPredictionServerId | any[] | No | — | Filter deployments to those whose default prediction server has the specified id. |
buildEnvironmentType | any[] | No | — | Filter deployments based on the type of their current model’s build environment type. |
executionEnvironmentType | any[] | No | — | Filter deployments based on the type of their execution environment. |
predictionEnvironmentPlatform | any[] | No | — | Filter deployments based on prediction environment platform |
createdByMe | string | No | — | Filter deployments to those created by the current user. |
createdBy | string | No | — | Filters deployments by those created by the given user. |
championModelExecutionType | string | No | — | Filter deployments by the execution type of the champion model. |
championModelTargetType | string | No | — | Filter deployments by the target type of the champion model. Example: Binary |
tagKeys | any[] | No | — | List of tag keys to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned. |
tagValues | any[] | No | — | List of tag values to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned. |
isA2AAgent | string | No | — | Filter deployments by whether the deployment is an A2A agent. When true, returns only deployments that are A2A agents. When false, returns only deployments that are not A2A agents. |
datarobot_deployments_deployments_retrieve
Retrieve deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_deployments_update
Update deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
description | string | No | — | A description for the deployment. |
importance | string | No | — | Shows how important this deployment is. |
label | string | No | — | A human-readable name for the deployment. |
datarobot_deployments_execution_environments_access_control_list
Get a list of users who have access to this execution environment and their roles. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | This many results will be skipped |
limit | integer | Yes | — | At most this many results are returned |
username | string | No | — | Optional, only return the access control information for a user with this username. |
userId | string | No | — | Optional, only return the access control information for a user with this user ID. |
environmentId | string | Yes | — | The ID of the environment. |
datarobot_deployments_execution_environments_access_control_patch_many
Grant access or update roles for users on this execution environment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
environmentId | string | Yes | — | The ID of the environment. |
data | any[] | Yes | — | List of sharing roles to update. |
datarobot_deployments_features_list
Get deployment features Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | The number of features to skip, defaults to 0. |
limit | integer | Yes | — | The number of features to return, defaults to 0. |
includeNonPredictionFeatures | string | No | — | When True will return all raw features in the universe dataset associated with the deployment, and when False will return only those raw features used to make predictions on the deployment. |
forSegmentedAnalysis | string | No | — | When True, features returned will be filtered to those usable for segmented analysis. |
search | string | No | — | Case insensitive search against names of the deployment’s features. |
orderBy | string | No | — | The sort order to apply to the list of features. Prefix the attribute name with a dash to sort in descending order, e.g., “-name”. |
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_from_learning_model_create
Create deployment from DataRobot model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
defaultPredictionServerId | string | No | — | ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations. |
description | string | Yes | — | A description for the deployment. |
grantInitialDeploymentRolesFromProject | boolean | No | — | If True, initial roles on the deployment will be granted to users who have roles on the project that the deployed model comes from. If False, only the creator of the deployment will be given a role on the deployment. Defaults to True. |
importance | string | No | — | Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled. |
label | string | Yes | — | A human-readable name for the deployment. |
modelId | string | Yes | — | ID of the model to be deployed. |
predictionThreshold | number | No | — | Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used. |
status | string | No | — | Status of the deployment |
datarobot_deployments_from_model_package_create
Create deployment from model package Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additionalMetadata | any[] | No | — | Key/Value pair list, with additional metadata |
defaultPredictionServerId | string | No | — | ID of the default prediction server for deployment. Required for DataRobot Cloud for non-external models, must be omitted for Enterprise installations. |
description | string | Yes | — | A description for the deployment. |
importance | string | No | — | Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled. |
label | string | Yes | — | A human-readable name for the deployment. |
modelPackageId | string | Yes | — | ID of the model package to deploy. |
predictionEnvironmentId | string | No | — | ID of prediction environment where to deploy |
runtimeParameterValues | string | No | — | Inject values into a model at runtime. The fieldName must match a fieldName defined in the model package. This list is merged with any existing runtime values set through the deployed model package. |
status | string | No | — | Status of the deployment |
userProvidedId | string | No | — | A user-provided unique ID associated with a deployment definition in a remote git repository. |
datarobot_deployments_health_settings_defaults_list
Retrieve default deployment health settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_health_settings_list
Retrieve deployment health settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_health_settings_patch_many
Update deployment health settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
accuracy | object | No | — | Accuracy health status setting. |
actualsTimeliness | object | No | — | Predictions timeliness health setting. |
customMetrics | object | No | — | Custom metrics health status setting. |
dataDrift | object | No | — | Data drift health status setting. |
fairness | object | No | — | Fairness health status setting. Only available if deployment supports fairness. |
predictionsTimeliness | object | No | — | Predictions timeliness health setting. |
service | object | No | — | Service health status setting. |
datarobot_deployments_limits_list
Get deployment limits.datarobot_deployments_migrate_dpsto_serverless_create
Update a deployment’s prediction environment from dedicated to serverless. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dpsDeploymentId | string | Yes | — | The ID of the deployment on dedicated prediction environment that will be updated to serverless. |
serverlessPredictionEnvironmentId | string | Yes | — | The ID of serverless prediction environment. |
datarobot_deployments_mlops_compute_bundles_list
List resource bundles. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityId | string | No | — | Identifier used to return recommended resource bundles. Must be used together with entityType parameter. |
entityType | string | No | — | Type of entity for which to get recommended bundles. Must be provided with entityId. |
useCases | string | No | — | If it is specified, only bundles for this use case will be returned. |
offset | integer | No | — | Number of results to skip. |
limit | integer | No | — | At most this many results are returned. The default may change without notice. |
datarobot_deployments_mlops_compute_bundles_retrieve
Retrieve resource bundle. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
resourceRequestBundleId | string | Yes | — | ID of the bundle. |
datarobot_deployments_mlops_portable_prediction_server_image_list
Downloads the latest Portable Prediction Server (PPS) Docker imagedatarobot_deployments_mlops_portable_prediction_server_image_metadata_list
Fetches currently active PPS Docker image metadatadatarobot_deployments_model_history_list
Retrieve champion model history of deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | No | — | This many results will be skipped. |
limit | integer | No | — | At most this many results are returned. |
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_model_secondary_dataset_configuration_history_list
List the secondary datasets configuration history for a deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | Yes | — | Number of items to skip. Defaults to 0 if not provided. |
limit | integer | Yes | — | Number of items to return, defaults to 100 if not provided. |
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_model_secondary_dataset_configuration_list
Retrieve secondary datasets configuration for a deployment. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_model_secondary_dataset_configuration_patch_many
Update the secondary datasets configuration for the deployed model. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
credentialsIds | any[] | No | — | The list of credentials used by the secondary datasets. |
secondaryDatasetConfigId | string | Yes | — | ID of the secondary datasets configuration to be used at the time of prediction. |
datarobot_deployments_on_demand_reports_create
Add report to execution queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
id | string | Yes | — | ID of Scheduled report record. |
datarobot_deployments_quota_consumers_list
Retrieve deployment consumers. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_scoring_code_builds_create
Build Java package containing Scoring Code with agent integration. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
includeAgent | boolean | No | — | Whether the Scoring Code built will include tracking agent |
includePredictionExplanations | boolean | No | — | Whether the Scoring Code built will include prediction explanations |
includePredictionIntervals | boolean | No | — | Whether the Scoring Code built will include prediction intervals |
datarobot_deployments_scoring_code_list
Retrieve Scoring Code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceCode | string | No | — | Whether source code or binary of the Scoring Code will be retrieved |
includeAgent | string | No | — | Whether the Scoring code retrieved will include tracking agent |
includePe | string | No | — | Please use includePredictionExplanations parameter instead |
includePredictionExplanations | string | No | — | Whether the Scoring Code retrieved will include prediction explanations |
includePredictionIntervals | string | No | — | Whether the Scoring Code retrieved will include prediction intervals |
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_settings_checklist_list
Retrieve deployment settings checklist. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_settings_list
Retrieve deployment settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
datarobot_deployments_settings_patch_many
Update deployment settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
associationId | object | No | — | The association ID setting for the deployment. |
automaticActuals | object | No | — | Automatic actuals setting for the deployment. |
biasAndFairness | object | No | — | Bias and fairness setting for the deployment. |
challengerModels | object | No | — | Challenger models setting for the deployment. |
featureDrift | object | No | — | The feature drift setting for the deployment. |
humility | object | No | — | Humility setting for the deployment. |
predictionIntervals | object | No | — | The prediction intervals setting for the deployment. |
predictionsByForecastDate | object | No | — | Forecast date setting for the deployment. |
predictionsDataCollection | object | No | — | The predictions data collection setting for the deployment. |
predictionWarning | object | No | — | The prediction warning setting for the deployment. |
processingLimits | object | No | — | Processing limits setting for the deployment. |
segmentAnalysis | object | No | — | The segment analysis setting for the deployment. |
targetDrift | object | No | — | The target drift setting for the deployment. |
datarobot_deployments_status_patch_many
Change deployment status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Unique identifier of the deployment. |
status | string | Yes | — | Status that deployment should be transition in. |

