datarobot-deployments - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /datarobot-deployments | Type: Application | PCID required: Yes

Tools

Tool	Description
`datarobot_deployments_agent_card_delete_many`	Delete the agent card for a deployment.
`datarobot_deployments_agent_card_list`	Retrieve the agent card for a deployment.
`datarobot_deployments_agent_card_put_many`	Create or replace the agent card for the deployment.
`datarobot_deployments_capabilities_list`	Retrieve capabilities.
`datarobot_deployments_custom_model_deployments_limit_state_list`	Get custom model deployment limits.
`datarobot_deployments_custom_model_deployments_list`	List custom model deployments.
`datarobot_deployments_custom_model_deployments_logs_create`	Get custom model log.
`datarobot_deployments_custom_model_deployments_logs_list`	Get custom model log.
`datarobot_deployments_custom_model_deployments_logs_retrieve`	Get custom model log.
`datarobot_deployments_deleted_deployments_list`	List deleted deployments
`datarobot_deployments_deleted_deployments_patch_many`	Erase deleted deployments
`datarobot_deployments_deployments_delete`	Delete deployment
`datarobot_deployments_deployments_list`	List deployments
`datarobot_deployments_deployments_retrieve`	Retrieve deployment
`datarobot_deployments_deployments_update`	Update deployment
`datarobot_deployments_execution_environments_access_control_list`	Get a list of users who have access to this execution environment and their roles.
`datarobot_deployments_execution_environments_access_control_patch_many`	Grant access or update roles for users on this execution environment.
`datarobot_deployments_features_list`	Get deployment features
`datarobot_deployments_from_learning_model_create`	Create deployment from DataRobot model
`datarobot_deployments_from_model_package_create`	Create deployment from model package
`datarobot_deployments_health_settings_defaults_list`	Retrieve default deployment health settings.
`datarobot_deployments_health_settings_list`	Retrieve deployment health settings.
`datarobot_deployments_health_settings_patch_many`	Update deployment health settings.
`datarobot_deployments_limits_list`	Get deployment limits.
`datarobot_deployments_migrate_dpsto_serverless_create`	Update a deployment’s prediction environment from dedicated to serverless.
`datarobot_deployments_mlops_compute_bundles_list`	List resource bundles.
`datarobot_deployments_mlops_compute_bundles_retrieve`	Retrieve resource 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.
`datarobot_deployments_model_secondary_dataset_configuration_history_list`	List the secondary datasets configuration history for a deployment.
`datarobot_deployments_model_secondary_dataset_configuration_list`	Retrieve secondary datasets configuration for a deployment.
`datarobot_deployments_model_secondary_dataset_configuration_patch_many`	Update the secondary datasets configuration for the deployed model.
`datarobot_deployments_on_demand_reports_create`	Add report to execution queue.
`datarobot_deployments_quota_consumers_list`	Retrieve deployment consumers.
`datarobot_deployments_scoring_code_builds_create`	Build Java package containing Scoring Code with agent integration.
`datarobot_deployments_scoring_code_list`	Retrieve Scoring Code
`datarobot_deployments_settings_checklist_list`	Retrieve deployment settings checklist.
`datarobot_deployments_settings_list`	Retrieve deployment settings.
`datarobot_deployments_settings_patch_many`	Update deployment settings
`datarobot_deployments_status_patch_many`	Change deployment status
`datarobot-deployments_shared_roles_list`	Get the model deployment access control list.
`datarobot-deployments_shared_roles_patch_many`	Update the model deployment access controls.

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_capabilities_list

Retrieve capabilities. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_custom_model_deployments_limit_state_list

Get custom model deployment limits.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

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`	string[]	No	—	List of ID’s of the custom model which model deployments will be retrieved.
`environmentIds`	string[]	No	—	List of ID’s of the execution environment which model deployments will be retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "This many results will be skipped."
    },
    "limit": {
      "type": "integer",
      "description": "At most this many results are returned."
    },
    "customModelIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of ID's of the custom model which model deployments will be retrieved."
    },
    "environmentIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of ID's of the execution environment which model deployments will be retrieved."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the custom model deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the custom model deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The ID of the custom model deployment."
    },
    "logId": {
      "type": "string",
      "description": "The ID of the custom model deployment log."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "logId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of deleted deployments to skip."
    },
    "limit": {
      "type": "integer",
      "description": "The number of deleted deployments to return."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit"
  ]
}

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`	string[]	Yes	—	ID of a list of deleted deployments to perform action on.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "string",
      "description": "Action to perform on these deleted deployments.",
      "enum": [
        "PermanentlyErase"
      ]
    },
    "deploymentIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "ID of a list of deleted deployments to perform action on."
    }
  },
  "required": [
    "PCID",
    "action",
    "deploymentIds"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ignoreManagementAgent": {
      "type": "string",
      "description": "Do not wait for management agent to delete the deployment first.",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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`	string[]	No	—	Filters deployments by their service health status.
`modelHealth`	string[]	No	—	Filters deployments by their model health status.
`accuracyHealth`	string[]	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`	string[]	No	—	Filters deployments by their status
`importance`	string[]	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`	string[]	No	—	Filter deployments to those whose default prediction server has the specified id.
`buildEnvironmentType`	string[]	No	—	Filter deployments based on the type of their current model’s build environment type.
`executionEnvironmentType`	string[]	No	—	Filter deployments based on the type of their execution environment.
`predictionEnvironmentPlatform`	string[]	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`	string[]	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`	string[]	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.
`predictionEnvironmentTagKeys`	string[]	No	—	List of tag keys. If specified, only deployments with prediction environments that have tags matching any of the keys will be returned.
`predictionEnvironmentTagValues`	string[]	No	—	List of tag values. If specified, only deployments with prediction environments that have tags matching any of the values will be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of deployments to skip. Defaults to 0."
    },
    "limit": {
      "type": "integer",
      "description": "The number of deployments (greater than zero, max 100) to return. Defaults to 20."
    },
    "orderBy": {
      "type": "string",
      "description": "The order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order.",
      "enum": [
        "label",
        "-label",
        "serviceHealth",
        "-serviceHealth",
        "modelHealth",
        "-modelHealth",
        "accuracyHealth",
        "-accuracyHealth",
        "recentPredictions",
        "-recentPredictions",
        "lastPredictionTimestamp",
        "-lastPredictionTimestamp",
        "currentModelDeployedTimestamp",
        "-currentModelDeployedTimestamp",
        "createdAtTimestamp",
        "-createdAtTimestamp",
        "importance",
        "-importance",
        "fairnessHealth",
        "-fairnessHealth",
        "customMetricsHealth",
        "-customMetricsHealth",
        "actualsTimelinessHealth",
        "-actualsTimelinessHealth",
        "predictionsTimelinessHealth",
        "-predictionsTimelinessHealth"
      ]
    },
    "search": {
      "type": "string",
      "description": "Case insensitive search against deployment's label and description."
    },
    "serviceHealth": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "failing",
          "not_started",
          "passing",
          "unavailable",
          "unknown",
          "warning"
        ]
      },
      "description": "Filters deployments by their service health status."
    },
    "modelHealth": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "failing",
          "not_started",
          "passing",
          "unavailable",
          "unknown",
          "warning"
        ]
      },
      "description": "Filters deployments by their model health status."
    },
    "accuracyHealth": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "failing",
          "not_started",
          "passing",
          "unavailable",
          "unknown",
          "warning"
        ]
      },
      "description": "Filters deployments by their accuracy health status."
    },
    "role": {
      "type": "string",
      "description": "Filter deployments to only those that the authenticated user has the specified role for.",
      "enum": [
        "OWNER",
        "USER"
      ]
    },
    "status": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "active",
          "archived",
          "errored",
          "inactive",
          "launching",
          "replacingModel",
          "stopping"
        ]
      },
      "description": "Filters deployments by their status"
    },
    "importance": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CRITICAL",
          "HIGH",
          "MODERATE",
          "LOW"
        ]
      },
      "description": "Filters deployments by their importance"
    },
    "lastPredictionTimestampStart": {
      "type": "string",
      "description": "Only include deployments that have had a prediction request on or after the specified timestamp."
    },
    "lastPredictionTimestampEnd": {
      "type": "string",
      "description": "Only include deployments that have had a prediction request before the specified timestamp."
    },
    "predictionUsageDailyAvgGreaterThan": {
      "type": "integer",
      "description": "only include deployments that have had more than the specified number of predictions per day on average over the past week."
    },
    "predictionUsageDailyAvgLessThan": {
      "type": "integer",
      "description": "Only include deployments that have had fewer than the specified number of predictions per day on average over the past week."
    },
    "defaultPredictionServerId": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter deployments to those whose default prediction server has the specified id."
    },
    "buildEnvironmentType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "DataRobot",
          "Python",
          "R",
          "Java",
          "Julia",
          "Legacy",
          "Other"
        ]
      },
      "description": "Filter deployments based on the type of their current model's build environment type."
    },
    "executionEnvironmentType": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "datarobot",
          "external"
        ]
      },
      "description": "Filter deployments based on the type of their execution environment."
    },
    "predictionEnvironmentPlatform": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "aws",
          "gcp",
          "azure",
          "onPremise",
          "datarobot",
          "datarobotServerless",
          "openShift",
          "other",
          "snowflake",
          "sapAiCore"
        ]
      },
      "description": "Filter deployments based on prediction environment platform"
    },
    "createdByMe": {
      "type": "string",
      "description": "Filter deployments to those created by the current user.",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "createdBy": {
      "type": "string",
      "description": "Filters deployments by those created by the given user."
    },
    "championModelExecutionType": {
      "type": "string",
      "description": "Filter deployments by the execution type of the champion model.",
      "enum": [
        "custom_inference_model",
        "external",
        "dedicated"
      ]
    },
    "championModelTargetType": {
      "type": "string",
      "description": "Filter deployments by the target type of the champion model. Example: Binary"
    },
    "tagKeys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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": {
      "type": "string",
      "description": "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.",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "predictionEnvironmentTagKeys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag keys. If specified, only deployments with prediction environments that have tags matching any of the keys will be returned."
    },
    "predictionEnvironmentTagValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag values. If specified, only deployments with prediction environments that have tags matching any of the values will be returned."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit"
  ]
}

datarobot_deployments_deployments_retrieve

Retrieve deployment Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_deployments_update

Update deployment Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.
`description`	string	null	No	—	A description for the deployment.
`importance`	string	No	—	Shows how important this deployment is.
`label`	string	null	No	—	A human-readable name for the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "A description for the deployment."
    },
    "importance": {
      "type": "string",
      "description": "Shows how important this deployment is.",
      "enum": [
        "CRITICAL",
        "HIGH",
        "MODERATE",
        "LOW"
      ]
    },
    "label": {
      "type": [
        "string",
        "null"
      ],
      "description": "A human-readable name for the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "This many results will be skipped"
    },
    "limit": {
      "type": "integer",
      "description": "At most this many results are returned"
    },
    "username": {
      "type": "string",
      "description": "Optional, only return the access control information for a user with this username."
    },
    "userId": {
      "type": "string",
      "description": "Optional, only return the access control information for a user with this user ID."
    },
    "environmentId": {
      "type": "string",
      "description": "The ID of the environment."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit",
    "environmentId"
  ]
}

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`	object[]	Yes	—	List of sharing roles to update.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "environmentId": {
      "type": "string",
      "description": "The ID of the environment."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "canShare": {
            "type": "boolean",
            "description": "Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored."
          },
          "role": {
            "type": "string",
            "enum": [
              "ADMIN",
              "CONSUMER",
              "DATA_SCIENTIST",
              "EDITOR",
              "OBSERVER",
              "OWNER",
              "READ_ONLY",
              "READ_WRITE",
              "USER"
            ],
            "description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity."
          },
          "username": {
            "type": "string",
            "description": "The username of the user to update the access role for."
          }
        },
        "required": [
          "role",
          "username"
        ]
      },
      "description": "List of sharing roles to update."
    }
  },
  "required": [
    "PCID",
    "environmentId",
    "data"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of features to skip, defaults to 0."
    },
    "limit": {
      "type": "integer",
      "description": "The number of features to return, defaults to 0."
    },
    "includeNonPredictionFeatures": {
      "type": "string",
      "description": "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.",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "forSegmentedAnalysis": {
      "type": "string",
      "description": "When True, features returned will be filtered to those usable for segmented analysis.",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "search": {
      "type": "string",
      "description": "Case insensitive search against names of the deployment's features."
    },
    "orderBy": {
      "type": "string",
      "description": "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\".",
      "enum": [
        "name",
        "-name",
        "importance",
        "-importance"
      ]
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit",
    "deploymentId"
  ]
}

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	null	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	null	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	null	No	—	Status of the deployment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "defaultPredictionServerId": {
      "type": "string",
      "description": "ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "A description for the deployment."
    },
    "grantInitialDeploymentRolesFromProject": {
      "type": "boolean",
      "description": "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": {
      "type": [
        "string",
        "null"
      ],
      "description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
      "enum": [
        "CRITICAL",
        "HIGH",
        "MODERATE",
        "LOW"
      ]
    },
    "label": {
      "type": "string",
      "description": "A human-readable name for the deployment."
    },
    "modelId": {
      "type": "string",
      "description": "ID of the model to be deployed."
    },
    "predictionThreshold": {
      "type": "number",
      "description": "Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used."
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "description": "Status of the deployment",
      "enum": [
        "active",
        "inactive"
      ]
    }
  },
  "required": [
    "PCID",
    "description",
    "label",
    "modelId"
  ]
}

datarobot_deployments_from_model_package_create

Create deployment from model package Parameters:

Parameter	Type	Required	Default	Description
`additionalMetadata`	object[]	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	null	Yes	—	A description for the deployment.
`importance`	string	null	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	null	No	—	Status of the deployment
`userProvidedId`	string	No	—	A user-provided unique ID associated with a deployment definition in a remote git repository.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "additionalMetadata": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The key, a unique identifier for this item of metadata"
          },
          "value": {
            "type": "string",
            "description": "The value, the actual content for this item of metadata"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "description": "Key/Value pair list, with additional metadata"
    },
    "defaultPredictionServerId": {
      "type": "string",
      "description": "ID of the default prediction server for deployment. Required for DataRobot Cloud for non-external models, must be omitted for Enterprise installations."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "A description for the deployment."
    },
    "importance": {
      "type": [
        "string",
        "null"
      ],
      "description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
      "enum": [
        "CRITICAL",
        "HIGH",
        "MODERATE",
        "LOW"
      ]
    },
    "label": {
      "type": "string",
      "description": "A human-readable name for the deployment."
    },
    "modelPackageId": {
      "type": "string",
      "description": "ID of the model package to deploy."
    },
    "predictionEnvironmentId": {
      "type": "string",
      "description": "ID of prediction environment where to deploy"
    },
    "runtimeParameterValues": {
      "type": "string",
      "description": "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": {
      "type": [
        "string",
        "null"
      ],
      "description": "Status of the deployment",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "userProvidedId": {
      "type": "string",
      "description": "A user-provided unique ID associated with a deployment definition in a remote git repository."
    }
  },
  "required": [
    "PCID",
    "description",
    "label",
    "modelPackageId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_health_settings_list

Retrieve deployment health settings. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "accuracy": {
      "type": "object",
      "description": "Accuracy health status setting.",
      "properties": {
        "batchCount": {
          "type": "integer",
          "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ]
        },
        "failingThreshold": {
          "type": "number",
          "description": "Threshold for failing status."
        },
        "measurement": {
          "type": "string",
          "description": "Measurement for calculating accuracy health status.",
          "enum": [
            "percent",
            "value"
          ]
        },
        "metric": {
          "type": "string",
          "description": "Metric used for calculating accuracy health status.",
          "enum": [
            "AUC",
            "Accuracy",
            "Balanced Accuracy",
            "F1",
            "FPR",
            "FVE Binomial",
            "FVE Gamma",
            "FVE Multinomial",
            "FVE Poisson",
            "FVE Tweedie",
            "Gamma Deviance",
            "Gini Norm",
            "Kolmogorov-Smirnov",
            "LogLoss",
            "MAE",
            "MAPE",
            "MCC",
            "NPV",
            "PPV",
            "Poisson Deviance",
            "R Squared",
            "RMSE",
            "RMSLE",
            "Rate@Top10%",
            "Rate@Top5%",
            "TNR",
            "TPR",
            "Tweedie Deviance",
            "WGS84 MAE",
            "WGS84 RMSE"
          ]
        },
        "warningThreshold": {
          "type": "number",
          "description": "Threshold for warning status."
        }
      }
    },
    "actualsTimeliness": {
      "type": "object",
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates if timeliness status is enabled."
        },
        "expectedFrequency": {
          "type": "string",
          "description": "Expected frequency for receiving data as an ISO 8601 duration string."
        }
      }
    },
    "customMetrics": {
      "type": "object",
      "description": "Custom metrics health status setting.",
      "properties": {
        "failingConditions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Conditions for failing status."
        },
        "warningConditions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Conditions for warning status."
        }
      }
    },
    "dataDrift": {
      "type": "object",
      "description": "Data drift health status setting.",
      "properties": {
        "batchCount": {
          "type": "integer",
          "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ]
        },
        "driftThreshold": {
          "type": "number",
          "description": "The drift metric threshold above which the feature is considered as drifted."
        },
        "excludedFeatures": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Features that are excluded from data drift status consideration."
        },
        "highImportanceFailingCount": {
          "type": "integer",
          "description": "Threshold of drifted high importance feature count for failing status."
        },
        "highImportanceWarningCount": {
          "type": "integer",
          "description": "Threshold of drifted high importance feature count for warning status."
        },
        "importanceThreshold": {
          "type": "number",
          "description": "The feature importance threshold above which the feature is considered as important."
        },
        "lowImportanceFailingCount": {
          "type": "integer",
          "description": "Threshold of drifted low importance feature count for failing status."
        },
        "lowImportanceWarningCount": {
          "type": "integer",
          "description": "Threshold of drifted low importance feature count for warning status."
        },
        "starredFeatures": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold."
        },
        "timeInterval": {
          "type": "string",
          "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ]
        }
      }
    },
    "fairness": {
      "type": "object",
      "description": "Fairness health status setting. Only available if deployment supports fairness.",
      "properties": {
        "protectedClassFailingCount": {
          "type": "integer",
          "description": "Number of protected class below fairness threshold for failing status."
        },
        "protectedClassWarningCount": {
          "type": "integer",
          "description": "Number of protected class below fairness threshold for warning status."
        }
      }
    },
    "predictionsTimeliness": {
      "type": "object",
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates if timeliness status is enabled."
        },
        "expectedFrequency": {
          "type": "string",
          "description": "Expected frequency for receiving data as an ISO 8601 duration string."
        }
      }
    },
    "service": {
      "type": "object",
      "description": "Service health status setting.",
      "properties": {
        "batchCount": {
          "type": "integer",
          "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ]
        },
        "failingConditions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Conditions for \"failing\" status."
        },
        "timeInterval": {
          "type": "string",
          "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T1H",
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ]
        },
        "warningConditions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Conditions for \"warning\" status."
        }
      }
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_limits_list

Get deployment limits.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dpsDeploymentId": {
      "type": "string",
      "description": "The ID of the deployment on dedicated prediction environment that will be updated to serverless."
    },
    "serverlessPredictionEnvironmentId": {
      "type": "string",
      "description": "The ID of serverless prediction environment."
    }
  },
  "required": [
    "PCID",
    "dpsDeploymentId",
    "serverlessPredictionEnvironmentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "entityId": {
      "type": "string",
      "description": "Identifier used to return recommended resource bundles. Must be used together with entityType parameter."
    },
    "entityType": {
      "type": "string",
      "description": "Type of entity for which to get recommended bundles. Must be provided with entityId.",
      "enum": [
        "customModelTemplate"
      ]
    },
    "useCases": {
      "type": "string",
      "description": "If it is specified, only bundles for this use case will be returned.",
      "enum": [
        "customApplication",
        "customJob",
        "customModel",
        "customTaskFit",
        "modelingMachineWorker",
        "predictionAPI",
        "sapAICore",
        "sparkApplication"
      ]
    },
    "offset": {
      "type": "integer",
      "description": "Number of results to skip."
    },
    "limit": {
      "type": "integer",
      "description": "At most this many results are returned. The default may change without notice."
    }
  },
  "required": [
    "PCID"
  ]
}

datarobot_deployments_mlops_compute_bundles_retrieve

Retrieve resource bundle. Parameters:

Parameter	Type	Required	Default	Description
`resourceRequestBundleId`	string	Yes	—	ID of the bundle.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "resourceRequestBundleId": {
      "type": "string",
      "description": "ID of the bundle."
    }
  },
  "required": [
    "PCID",
    "resourceRequestBundleId"
  ]
}

datarobot_deployments_mlops_portable_prediction_server_image_list

Downloads the latest Portable Prediction Server (PPS) Docker image

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

datarobot_deployments_mlops_portable_prediction_server_image_metadata_list

Fetches currently active PPS Docker image metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

datarobot_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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "This many results will be skipped."
    },
    "limit": {
      "type": "integer",
      "description": "At most this many results are returned."
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "Number of items to skip. Defaults to 0 if not provided."
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to return, defaults to 100 if not provided."
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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`	object[]	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "credentialsIds": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "catalogVersionId": {
            "type": "string",
            "description": "ID of the catalog version."
          },
          "credentialId": {
            "type": "string",
            "description": "ID of the credential store to be used for the given catalog version."
          },
          "url": {
            "type": "string",
            "description": "The URL of the datasource."
          }
        },
        "required": [
          "catalogVersionId",
          "credentialId"
        ]
      },
      "description": "The list of credentials used by the secondary datasets."
    },
    "secondaryDatasetConfigId": {
      "type": "string",
      "description": "ID of the secondary datasets configuration to be used at the time of prediction."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "secondaryDatasetConfigId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "id": {
      "type": "string",
      "description": "ID of Scheduled report record."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "id"
  ]
}

datarobot_deployments_quota_consumers_list

Retrieve deployment consumers. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "includeAgent": {
      "type": "boolean",
      "description": "Whether the Scoring Code built will include tracking agent"
    },
    "includePredictionExplanations": {
      "type": "boolean",
      "description": "Whether the Scoring Code built will include prediction explanations"
    },
    "includePredictionIntervals": {
      "type": "boolean",
      "description": "Whether the Scoring Code built will include prediction intervals"
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceCode": {
      "type": "string",
      "description": "Whether source code or binary of the Scoring Code will be retrieved",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "includeAgent": {
      "type": "string",
      "description": "Whether the Scoring code retrieved will include tracking agent",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "includePe": {
      "type": "string",
      "description": "Please use includePredictionExplanations parameter instead",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "includePredictionExplanations": {
      "type": "string",
      "description": "Whether the Scoring Code retrieved will include prediction explanations",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "includePredictionIntervals": {
      "type": "string",
      "description": "Whether the Scoring Code retrieved will include prediction intervals",
      "enum": [
        "false",
        "False",
        "true",
        "True"
      ]
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_settings_checklist_list

Retrieve deployment settings checklist. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

datarobot_deployments_settings_list

Retrieve deployment settings. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	Unique identifier of the deployment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "associationId": {
      "type": "object",
      "description": "The association ID setting for the deployment.",
      "properties": {
        "columnNames": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of column names used to represent an association ID."
        },
        "requiredInPredictionRequests": {
          "type": "boolean",
          "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made."
        }
      }
    },
    "automaticActuals": {
      "type": "object",
      "description": "Automatic actuals setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether automatic actuals is enabled for the deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "biasAndFairness": {
      "type": "object",
      "description": "Bias and fairness setting for the deployment.",
      "properties": {
        "fairnessMetricsSet": {
          "type": "string",
          "description": "A set of fairness metrics to use for calculating fairness.",
          "enum": [
            "proportionalParity",
            "equalParity",
            "predictionBalance",
            "trueFavorableAndUnfavorableRateParity",
            "favorableAndUnfavorablePredictiveValueParity"
          ]
        },
        "fairnessThreshold": {
          "type": "number",
          "description": "Threshold value of the fairness metric."
        },
        "preferableTargetValue": {
          "description": "A target value that should be treated as a positive outcome for the prediction."
        },
        "protectedFeatures": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of features to mark as protected for bias and fairness measurement."
        }
      },
      "required": [
        "fairnessMetricsSet",
        "fairnessThreshold",
        "preferableTargetValue",
        "protectedFeatures"
      ]
    },
    "challengerModels": {
      "type": "object",
      "description": "Challenger models setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether challenger models are enabled for the deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "featureDrift": {
      "type": "object",
      "description": "The feature drift setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether feature drift tracking is enabled for this deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "humility": {
      "type": "object",
      "description": "Humility setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether humility rules are enabled for the deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "predictionIntervals": {
      "type": "object",
      "description": "The prediction intervals setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether prediction intervals are enabled for this deployment."
        },
        "percentiles": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "predictionsByForecastDate": {
      "type": "object",
      "description": "Forecast date setting for the deployment.",
      "properties": {
        "columnName": {
          "type": "string",
          "description": "The column name in prediction datasets to be used as forecast date"
        },
        "datetimeFormat": {
          "type": "string",
          "description": "The datetime format of the forecast date column in prediction datasets."
        },
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether predictions by forecast dates is enabled for the deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "predictionsDataCollection": {
      "type": "object",
      "description": "The predictions data collection setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "predictionWarning": {
      "type": "object",
      "description": "The prediction warning setting for the deployment.",
      "properties": {
        "customBoundaries": {
          "type": "object",
          "description": "Null if default boundaries for the model are used"
        },
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether prediction warnings are enabled for this deployment."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "processingLimits": {
      "type": "object",
      "description": "Processing limits setting for the deployment.",
      "properties": {
        "interval": {
          "type": "string",
          "description": "A time interval that is applied when calculating processing limits.",
          "enum": [
            "hour",
            "day",
            "week"
          ]
        }
      },
      "required": [
        "interval"
      ]
    },
    "segmentAnalysis": {
      "type": "object",
      "description": "The segment analysis setting for the deployment.",
      "properties": {
        "attributes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified"
        },
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data."
        }
      },
      "required": [
        "enabled"
      ]
    },
    "targetDrift": {
      "type": "object",
      "description": "The target drift setting for the deployment.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether target drift tracking is enabled for this deployment."
        }
      },
      "required": [
        "enabled"
      ]
    }
  },
  "required": [
    "PCID",
    "deploymentId"
  ]
}

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "Unique identifier of the deployment."
    },
    "status": {
      "type": "string",
      "description": "Status that deployment should be transition in.",
      "enum": [
        "active",
        "inactive"
      ]
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "status"
  ]
}

datarobot-deployments_shared_roles_list

Get the model deployment access control list. Parameters:

Parameter	Type	Required	Default	Description
`id`	string	No	—	Only return roles for a user, group or organization with this identifier.
`offset`	integer	Yes	—	This many results will be skipped
`limit`	integer	Yes	—	At most this many results are returned
`name`	string	No	—	Only return roles for a user, group or organization with this name.
`shareRecipientType`	string	No	—	The list of access controls for recipients with this type.
`deploymentId`	string	Yes	—	The deployment ID.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Only return roles for a user, group or organization with this identifier."
    },
    "offset": {
      "type": "integer",
      "description": "This many results will be skipped"
    },
    "limit": {
      "type": "integer",
      "description": "At most this many results are returned"
    },
    "name": {
      "type": "string",
      "description": "Only return roles for a user, group or organization with this name."
    },
    "shareRecipientType": {
      "type": "string",
      "description": "The list of access controls for recipients with this type.",
      "enum": [
        "user",
        "group",
        "organization",
        "externalApplication"
      ]
    },
    "deploymentId": {
      "type": "string",
      "description": "The deployment ID."
    }
  },
  "required": [
    "PCID",
    "offset",
    "limit",
    "deploymentId"
  ]
}

datarobot-deployments_shared_roles_patch_many

Update the model deployment access controls. Parameters:

Parameter	Type	Required	Default	Description
`deploymentId`	string	Yes	—	The deployment ID.
`operation`	string	Yes	—	Name of the action being taken. The only operation is ‘updateRoles’.
`roles`	any[]	Yes	—	An array of RoleRequest objects. May contain at most 100 such objects.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deploymentId": {
      "type": "string",
      "description": "The deployment ID."
    },
    "operation": {
      "type": "string",
      "description": "Name of the action being taken. The only operation is 'updateRoles'.",
      "enum": [
        "updateRoles"
      ]
    },
    "roles": {
      "type": "array",
      "description": "An array of RoleRequest objects. May contain at most 100 such objects."
    }
  },
  "required": [
    "PCID",
    "deploymentId",
    "operation",
    "roles"
  ]
}

datarobot-batch-predictions datarobot-projects

⌘I

​Tools

​datarobot_deployments_agent_card_delete_many

​datarobot_deployments_agent_card_list

​datarobot_deployments_agent_card_put_many

​datarobot_deployments_capabilities_list

​datarobot_deployments_custom_model_deployments_limit_state_list

​datarobot_deployments_custom_model_deployments_list

​datarobot_deployments_custom_model_deployments_logs_create

​datarobot_deployments_custom_model_deployments_logs_list

​datarobot_deployments_custom_model_deployments_logs_retrieve

​datarobot_deployments_deleted_deployments_list

​datarobot_deployments_deleted_deployments_patch_many

​datarobot_deployments_deployments_delete

​datarobot_deployments_deployments_list

​datarobot_deployments_deployments_retrieve

​datarobot_deployments_deployments_update

​datarobot_deployments_execution_environments_access_control_list

​datarobot_deployments_execution_environments_access_control_patch_many

​datarobot_deployments_features_list

​datarobot_deployments_from_learning_model_create

​datarobot_deployments_from_model_package_create

​datarobot_deployments_health_settings_defaults_list

​datarobot_deployments_health_settings_list

​datarobot_deployments_health_settings_patch_many

​datarobot_deployments_limits_list

​datarobot_deployments_migrate_dpsto_serverless_create

​datarobot_deployments_mlops_compute_bundles_list

​datarobot_deployments_mlops_compute_bundles_retrieve

​datarobot_deployments_mlops_portable_prediction_server_image_list

​datarobot_deployments_mlops_portable_prediction_server_image_metadata_list

​datarobot_deployments_model_history_list

​datarobot_deployments_model_secondary_dataset_configuration_history_list

​datarobot_deployments_model_secondary_dataset_configuration_list

​datarobot_deployments_model_secondary_dataset_configuration_patch_many

​datarobot_deployments_on_demand_reports_create

​datarobot_deployments_quota_consumers_list

​datarobot_deployments_scoring_code_builds_create

​datarobot_deployments_scoring_code_list

​datarobot_deployments_settings_checklist_list

​datarobot_deployments_settings_list

​datarobot_deployments_settings_patch_many

​datarobot_deployments_status_patch_many

​datarobot-deployments_shared_roles_list

​datarobot-deployments_shared_roles_patch_many

Tools

datarobot_deployments_agent_card_delete_many

datarobot_deployments_agent_card_list

datarobot_deployments_agent_card_put_many

datarobot_deployments_capabilities_list

datarobot_deployments_custom_model_deployments_limit_state_list

datarobot_deployments_custom_model_deployments_list

datarobot_deployments_custom_model_deployments_logs_create

datarobot_deployments_custom_model_deployments_logs_list

datarobot_deployments_custom_model_deployments_logs_retrieve

datarobot_deployments_deleted_deployments_list

datarobot_deployments_deleted_deployments_patch_many

datarobot_deployments_deployments_delete

datarobot_deployments_deployments_list

datarobot_deployments_deployments_retrieve

datarobot_deployments_deployments_update

datarobot_deployments_execution_environments_access_control_list

datarobot_deployments_execution_environments_access_control_patch_many

datarobot_deployments_features_list

datarobot_deployments_from_learning_model_create

datarobot_deployments_from_model_package_create

datarobot_deployments_health_settings_defaults_list

datarobot_deployments_health_settings_list

datarobot_deployments_health_settings_patch_many

datarobot_deployments_limits_list

datarobot_deployments_migrate_dpsto_serverless_create

datarobot_deployments_mlops_compute_bundles_list

datarobot_deployments_mlops_compute_bundles_retrieve

datarobot_deployments_mlops_portable_prediction_server_image_list

datarobot_deployments_mlops_portable_prediction_server_image_metadata_list

datarobot_deployments_model_history_list

datarobot_deployments_model_secondary_dataset_configuration_history_list

datarobot_deployments_model_secondary_dataset_configuration_list

datarobot_deployments_model_secondary_dataset_configuration_patch_many

datarobot_deployments_on_demand_reports_create

datarobot_deployments_quota_consumers_list

datarobot_deployments_scoring_code_builds_create

datarobot_deployments_scoring_code_list

datarobot_deployments_settings_checklist_list

datarobot_deployments_settings_list

datarobot_deployments_settings_patch_many

datarobot_deployments_status_patch_many

datarobot-deployments_shared_roles_list

datarobot-deployments_shared_roles_patch_many