Skip to main content
Server path: /datarobot-deployments | Type: Application | PCID required: Yes

Tools

ToolDescription
datarobot_deployments_agent_card_delete_manyDelete the agent card for a deployment.
datarobot_deployments_agent_card_listRetrieve the agent card for a deployment.
datarobot_deployments_agent_card_put_manyCreate or replace the agent card for the deployment.
datarobot_deployments_capabilities_listRetrieve capabilities.
datarobot_deployments_custom_model_deployments_limit_state_listGet custom model deployment limits.
datarobot_deployments_custom_model_deployments_listList custom model deployments.
datarobot_deployments_custom_model_deployments_logs_createGet custom model log.
datarobot_deployments_custom_model_deployments_logs_listGet custom model log.
datarobot_deployments_custom_model_deployments_logs_retrieveGet custom model log.
datarobot_deployments_deleted_deployments_listList deleted deployments
datarobot_deployments_deleted_deployments_patch_manyErase deleted deployments
datarobot_deployments_deployments_deleteDelete deployment
datarobot_deployments_deployments_listList deployments
datarobot_deployments_deployments_retrieveRetrieve deployment
datarobot_deployments_deployments_updateUpdate deployment
datarobot_deployments_execution_environments_access_control_listGet a list of users who have access to this execution environment and their roles.
datarobot_deployments_execution_environments_access_control_patch_manyGrant access or update roles for users on this execution environment.
datarobot_deployments_features_listGet deployment features
datarobot_deployments_from_learning_model_createCreate deployment from DataRobot model
datarobot_deployments_from_model_package_createCreate deployment from model package
datarobot_deployments_health_settings_defaults_listRetrieve default deployment health settings.
datarobot_deployments_health_settings_listRetrieve deployment health settings.
datarobot_deployments_health_settings_patch_manyUpdate deployment health settings.
datarobot_deployments_limits_listGet deployment limits.
datarobot_deployments_migrate_dpsto_serverless_createUpdate a deployment’s prediction environment from dedicated to serverless.
datarobot_deployments_mlops_compute_bundles_listList resource bundles.
datarobot_deployments_mlops_compute_bundles_retrieveRetrieve resource bundle.
datarobot_deployments_mlops_portable_prediction_server_image_listDownloads the latest Portable Prediction Server (PPS) Docker image
datarobot_deployments_mlops_portable_prediction_server_image_metadata_listFetches currently active PPS Docker image metadata
datarobot_deployments_model_history_listRetrieve champion model history of deployment.
datarobot_deployments_model_secondary_dataset_configuration_history_listList the secondary datasets configuration history for a deployment.
datarobot_deployments_model_secondary_dataset_configuration_listRetrieve secondary datasets configuration for a deployment.
datarobot_deployments_model_secondary_dataset_configuration_patch_manyUpdate the secondary datasets configuration for the deployed model.
datarobot_deployments_on_demand_reports_createAdd report to execution queue.
datarobot_deployments_quota_consumers_listRetrieve deployment consumers.
datarobot_deployments_scoring_code_builds_createBuild Java package containing Scoring Code with agent integration.
datarobot_deployments_scoring_code_listRetrieve Scoring Code
datarobot_deployments_settings_checklist_listRetrieve deployment settings checklist.
datarobot_deployments_settings_listRetrieve deployment settings.
datarobot_deployments_settings_patch_manyUpdate deployment settings
datarobot_deployments_status_patch_manyChange deployment status

datarobot_deployments_agent_card_delete_many

Delete the agent card for a deployment. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the deployment.

datarobot_deployments_agent_card_list

Retrieve the agent card for a deployment. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the deployment.

datarobot_deployments_agent_card_put_many

Create or replace the agent card for the deployment. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the deployment.

datarobot_deployments_capabilities_list

Retrieve capabilities. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique 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:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThis many results will be skipped.
limitintegerYesAt most this many results are returned.
customModelIdsany[]NoList of ID’s of the custom model which model deployments will be retrieved.
environmentIdsany[]NoList 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:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the custom model deployment.

datarobot_deployments_custom_model_deployments_logs_list

Get custom model log. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the custom model deployment.

datarobot_deployments_custom_model_deployments_logs_retrieve

Get custom model log. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesThe ID of the custom model deployment.
logIdstringYesThe ID of the custom model deployment log.

datarobot_deployments_deleted_deployments_list

List deleted deployments Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThe number of deleted deployments to skip.
limitintegerYesThe number of deleted deployments to return.

datarobot_deployments_deleted_deployments_patch_many

Erase deleted deployments Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesAction to perform on these deleted deployments.
deploymentIdsany[]YesID of a list of deleted deployments to perform action on.

datarobot_deployments_deployments_delete

Delete deployment Parameters:
ParameterTypeRequiredDefaultDescription
ignoreManagementAgentstringNoDo not wait for management agent to delete the deployment first.
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_deployments_list

List deployments Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThe number of deployments to skip. Defaults to 0.
limitintegerYesThe number of deployments (greater than zero, max 100) to return. Defaults to 20.
orderBystringNoThe order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order.
searchstringNoCase insensitive search against deployment’s label and description.
serviceHealthany[]NoFilters deployments by their service health status.
modelHealthany[]NoFilters deployments by their model health status.
accuracyHealthany[]NoFilters deployments by their accuracy health status.
rolestringNoFilter deployments to only those that the authenticated user has the specified role for.
statusany[]NoFilters deployments by their status
importanceany[]NoFilters deployments by their importance
lastPredictionTimestampStartstringNoOnly include deployments that have had a prediction request on or after the specified timestamp.
lastPredictionTimestampEndstringNoOnly include deployments that have had a prediction request before the specified timestamp.
predictionUsageDailyAvgGreaterThanintegerNoonly include deployments that have had more than the specified number of predictions per day on average over the past week.
predictionUsageDailyAvgLessThanintegerNoOnly include deployments that have had fewer than the specified number of predictions per day on average over the past week.
defaultPredictionServerIdany[]NoFilter deployments to those whose default prediction server has the specified id.
buildEnvironmentTypeany[]NoFilter deployments based on the type of their current model’s build environment type.
executionEnvironmentTypeany[]NoFilter deployments based on the type of their execution environment.
predictionEnvironmentPlatformany[]NoFilter deployments based on prediction environment platform
createdByMestringNoFilter deployments to those created by the current user.
createdBystringNoFilters deployments by those created by the given user.
championModelExecutionTypestringNoFilter deployments by the execution type of the champion model.
championModelTargetTypestringNoFilter deployments by the target type of the champion model. Example: Binary
tagKeysany[]NoList of tag keys to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned.
tagValuesany[]NoList of tag values to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned.
isA2AAgentstringNoFilter 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:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_deployments_update

Update deployment Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
descriptionstringNoA description for the deployment.
importancestringNoShows how important this deployment is.
labelstringNoA 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:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThis many results will be skipped
limitintegerYesAt most this many results are returned
usernamestringNoOptional, only return the access control information for a user with this username.
userIdstringNoOptional, only return the access control information for a user with this user ID.
environmentIdstringYesThe ID of the environment.

datarobot_deployments_execution_environments_access_control_patch_many

Grant access or update roles for users on this execution environment. Parameters:
ParameterTypeRequiredDefaultDescription
environmentIdstringYesThe ID of the environment.
dataany[]YesList of sharing roles to update.

datarobot_deployments_features_list

Get deployment features Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThe number of features to skip, defaults to 0.
limitintegerYesThe number of features to return, defaults to 0.
includeNonPredictionFeaturesstringNoWhen 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.
forSegmentedAnalysisstringNoWhen True, features returned will be filtered to those usable for segmented analysis.
searchstringNoCase insensitive search against names of the deployment’s features.
orderBystringNoThe sort order to apply to the list of features. Prefix the attribute name with a dash to sort in descending order, e.g., “-name”.
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_from_learning_model_create

Create deployment from DataRobot model Parameters:
ParameterTypeRequiredDefaultDescription
defaultPredictionServerIdstringNoID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations.
descriptionstringYesA description for the deployment.
grantInitialDeploymentRolesFromProjectbooleanNoIf 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.
importancestringNoImportance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.
labelstringYesA human-readable name for the deployment.
modelIdstringYesID of the model to be deployed.
predictionThresholdnumberNoPrediction threshold used for binary classification. If not specified, model default prediction threshold will be used.
statusstringNoStatus of the deployment

datarobot_deployments_from_model_package_create

Create deployment from model package Parameters:
ParameterTypeRequiredDefaultDescription
additionalMetadataany[]NoKey/Value pair list, with additional metadata
defaultPredictionServerIdstringNoID of the default prediction server for deployment. Required for DataRobot Cloud for non-external models, must be omitted for Enterprise installations.
descriptionstringYesA description for the deployment.
importancestringNoImportance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.
labelstringYesA human-readable name for the deployment.
modelPackageIdstringYesID of the model package to deploy.
predictionEnvironmentIdstringNoID of prediction environment where to deploy
runtimeParameterValuesstringNoInject 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.
statusstringNoStatus of the deployment
userProvidedIdstringNoA 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:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_health_settings_list

Retrieve deployment health settings. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_health_settings_patch_many

Update deployment health settings. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
accuracyobjectNoAccuracy health status setting.
actualsTimelinessobjectNoPredictions timeliness health setting.
customMetricsobjectNoCustom metrics health status setting.
dataDriftobjectNoData drift health status setting.
fairnessobjectNoFairness health status setting. Only available if deployment supports fairness.
predictionsTimelinessobjectNoPredictions timeliness health setting.
serviceobjectNoService 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:
ParameterTypeRequiredDefaultDescription
dpsDeploymentIdstringYesThe ID of the deployment on dedicated prediction environment that will be updated to serverless.
serverlessPredictionEnvironmentIdstringYesThe ID of serverless prediction environment.

datarobot_deployments_mlops_compute_bundles_list

List resource bundles. Parameters:
ParameterTypeRequiredDefaultDescription
entityIdstringNoIdentifier used to return recommended resource bundles. Must be used together with entityType parameter.
entityTypestringNoType of entity for which to get recommended bundles. Must be provided with entityId.
useCasesstringNoIf it is specified, only bundles for this use case will be returned.
offsetintegerNoNumber of results to skip.
limitintegerNoAt most this many results are returned. The default may change without notice.

datarobot_deployments_mlops_compute_bundles_retrieve

Retrieve resource bundle. Parameters:
ParameterTypeRequiredDefaultDescription
resourceRequestBundleIdstringYesID of the bundle.

datarobot_deployments_mlops_portable_prediction_server_image_list

Downloads the latest Portable Prediction Server (PPS) Docker image

datarobot_deployments_mlops_portable_prediction_server_image_metadata_list

Fetches currently active PPS Docker image metadata

datarobot_deployments_model_history_list

Retrieve champion model history of deployment. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThis many results will be skipped.
limitintegerNoAt most this many results are returned.
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_model_secondary_dataset_configuration_history_list

List the secondary datasets configuration history for a deployment. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYesNumber of items to skip. Defaults to 0 if not provided.
limitintegerYesNumber of items to return, defaults to 100 if not provided.
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_model_secondary_dataset_configuration_list

Retrieve secondary datasets configuration for a deployment. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_model_secondary_dataset_configuration_patch_many

Update the secondary datasets configuration for the deployed model. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
credentialsIdsany[]NoThe list of credentials used by the secondary datasets.
secondaryDatasetConfigIdstringYesID 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:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
idstringYesID of Scheduled report record.

datarobot_deployments_quota_consumers_list

Retrieve deployment consumers. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_scoring_code_builds_create

Build Java package containing Scoring Code with agent integration. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
includeAgentbooleanNoWhether the Scoring Code built will include tracking agent
includePredictionExplanationsbooleanNoWhether the Scoring Code built will include prediction explanations
includePredictionIntervalsbooleanNoWhether the Scoring Code built will include prediction intervals

datarobot_deployments_scoring_code_list

Retrieve Scoring Code Parameters:
ParameterTypeRequiredDefaultDescription
sourceCodestringNoWhether source code or binary of the Scoring Code will be retrieved
includeAgentstringNoWhether the Scoring code retrieved will include tracking agent
includePestringNoPlease use includePredictionExplanations parameter instead
includePredictionExplanationsstringNoWhether the Scoring Code retrieved will include prediction explanations
includePredictionIntervalsstringNoWhether the Scoring Code retrieved will include prediction intervals
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_settings_checklist_list

Retrieve deployment settings checklist. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_settings_list

Retrieve deployment settings. Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.

datarobot_deployments_settings_patch_many

Update deployment settings Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
associationIdobjectNoThe association ID setting for the deployment.
automaticActualsobjectNoAutomatic actuals setting for the deployment.
biasAndFairnessobjectNoBias and fairness setting for the deployment.
challengerModelsobjectNoChallenger models setting for the deployment.
featureDriftobjectNoThe feature drift setting for the deployment.
humilityobjectNoHumility setting for the deployment.
predictionIntervalsobjectNoThe prediction intervals setting for the deployment.
predictionsByForecastDateobjectNoForecast date setting for the deployment.
predictionsDataCollectionobjectNoThe predictions data collection setting for the deployment.
predictionWarningobjectNoThe prediction warning setting for the deployment.
processingLimitsobjectNoProcessing limits setting for the deployment.
segmentAnalysisobjectNoThe segment analysis setting for the deployment.
targetDriftobjectNoThe target drift setting for the deployment.

datarobot_deployments_status_patch_many

Change deployment status Parameters:
ParameterTypeRequiredDefaultDescription
deploymentIdstringYesUnique identifier of the deployment.
statusstringYesStatus that deployment should be transition in.