Deployment management
Use the endpoints described below to manage deployments.
List custom model deployments
Operation path: GET /api/v2/customModelDeployments/
Authentication requirements: BearerAuth
List of model deployments for user sorted by creation time descending.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
This many results will be skipped. |
| limit |
query |
integer |
true |
At most this many results are returned. |
| customModelIds |
query |
any |
false |
List of ID's of the custom model which model deployments will be retrieved. |
| environmentIds |
query |
any |
false |
List of ID's of the execution environment which model deployments will be retrieved. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom model deployments.",
"items": {
"properties": {
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelImageId": {
"description": "The id of the custom model image associated with this deployment.",
"type": "string"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"deployed": {
"description": "ISO-8601 timestamp of when deployment was created.",
"type": "string"
},
"deployedBy": {
"description": "The username of the user that deployed the custom model.",
"type": "string"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"imageType": {
"description": "The type of the image, either customModelImage if the testing attempt is using a customModelImage as its model or customModelVersion if the testing attempt is using a customModelVersion with dependency management.",
"enum": [
"customModelImage",
"customModelVersion"
],
"type": "string"
},
"label": {
"description": "User-friendly name of the model deployment.",
"type": "string"
},
"status": {
"description": "Deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string"
},
"testingStatus": {
"description": "Latest testing status of the deployed custom model image.",
"enum": [
"not_tested",
"queued",
"failed",
"canceled",
"succeeded",
"in_progress",
"aborted",
"warning",
"skipped"
],
"type": "string"
}
},
"required": [
"customModel",
"customModelImageId",
"customModelVersion",
"deployed",
"deployedBy",
"executionEnvironment",
"executionEnvironmentVersion",
"id",
"label",
"status",
"testingStatus"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Get custom model log by deployment ID
Operation path: GET /api/v2/customModelDeployments/{deploymentId}/logs/
Authentication requirements: BearerAuth
Retrieve the logs generated during deployment of the custom model.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
The ID of the custom model deployment. |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
The response will contain a text file with the contents of the Custom Model deployment log. |
None |
| 404 |
Not Found |
No logs found. |
None |
| Status |
Header |
Type |
Format |
Description |
| 200 |
Content-Disposition |
string |
|
Contains an auto generated filename of the log file ("attachment;filename=deployment-.log"). |
Create logs by id
Operation path: POST /api/v2/customModelDeployments/{deploymentId}/logs/
Authentication requirements: BearerAuth
Request logs from a custom deployed model.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
The ID of the custom model deployment. |
Example responses
202 Response
{
"properties": {
"statusId": {
"description": "ID that can be used with [GET /api/v2/status/{statusId}/][get-apiv2statusstatusid] to poll for the testing job's status",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
}
Responses
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking async job status. |
Retrieve logs by id
Operation path: GET /api/v2/customModelDeployments/{deploymentId}/logs/{logId}/
Authentication requirements: BearerAuth
Retrieve the logs generated during predictions on the deployed custom model.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
The ID of the custom model deployment. |
| logId |
path |
string |
true |
The ID of the custom model deployment log. |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
The response will contain a text file with the contents of the Custom Model deployment log. |
None |
| 404 |
Not Found |
No logs found. |
None |
| Status |
Header |
Type |
Format |
Description |
| 200 |
Content-Disposition |
string |
|
Contains an auto generated filename of the log file ("attachment;filename=deployment-.log"). |
List deleted deployments
Operation path: GET /api/v2/deletedDeployments/
Authentication requirements: BearerAuth
List deleted deployments.Only available as part of an enterprise (on-prem) installation. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
The number of deleted deployments to skip. |
| limit |
query |
integer |
true |
The number of deleted deployments to return. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of deleted deployments.",
"items": {
"properties": {
"deletedAt": {
"description": "The date and time of when the deployment was deleted, in ISO 8601 format.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "ID of the deployment.",
"type": "string"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
}
},
"required": [
"deletedAt",
"id",
"label"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object"
}
Responses
Erase deleted deployments
Operation path: PATCH /api/v2/deletedDeployments/
Authentication requirements: BearerAuth
Permanently erase data for deleted deployments. Only available as part of an on-premise or private/hybrid cloud deployment. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Body parameter
{
"properties": {
"action": {
"description": "Action to perform on these deleted deployments.",
"enum": [
"PermanentlyErase"
],
"type": "string"
},
"deploymentIds": {
"description": "ID of a list of deleted deployments to perform action on.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"action",
"deploymentIds"
],
"type": "object"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 202 |
Accepted |
Job submitted. See Location header. |
None |
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking deployment permanently erase job status. |
List deployments
Operation path: GET /api/v2/deployments/
Authentication requirements: BearerAuth
List deployments a user can view.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
The number of deployments to skip. Defaults to 0. |
| limit |
query |
integer |
true |
The number of deployments (greater than zero, max 100) to return. Defaults to 20. |
| orderBy |
query |
string |
false |
The order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order. |
| search |
query |
string |
false |
Case insensitive search against deployment's label and description. |
| serviceHealth |
query |
array[string] |
false |
Filters deployments by their service health status. |
| modelHealth |
query |
array[string] |
false |
Filters deployments by their model health status. |
| accuracyHealth |
query |
array[string] |
false |
Filters deployments by their accuracy health status. |
| role |
query |
string |
false |
Filter deployments to only those that the authenticated user has the specified role for. |
| status |
query |
array[string] |
false |
Filters deployments by their status |
| importance |
query |
array[string] |
false |
Filters deployments by their importance |
| lastPredictionTimestampStart |
query |
string(date-time) |
false |
Only include deployments that have had a prediction request on or after the specified timestamp. |
| lastPredictionTimestampEnd |
query |
string(date-time) |
false |
Only include deployments that have had a prediction request before the specified timestamp. |
| predictionUsageDailyAvgGreaterThan |
query |
integer |
false |
only include deployments that have had more than the specified number of predictions per day on average over the past week. |
| predictionUsageDailyAvgLessThan |
query |
integer |
false |
Only include deployments that have had fewer than the specified number of predictions per day on average over the past week. |
| defaultPredictionServerId |
query |
array[string] |
false |
Filter deployments to those whose default prediction server has the specified id. |
| buildEnvironmentType |
query |
array[string] |
false |
Filter deployments based on the type of their current model's build environment type. |
| executionEnvironmentType |
query |
array[string] |
false |
Filter deployments based on the type of their execution environment. |
| predictionEnvironmentPlatform |
query |
array[string] |
false |
Filter deployments based on prediction environment platform |
| createdByMe |
query |
string |
false |
Filter deployments to those created by the current user. |
| createdBy |
query |
string |
false |
Filters deployments by those created by the given user. |
| championModelExecutionType |
query |
string |
false |
Filter deployments by the execution type of the champion model. |
| championModelTargetType |
query |
string |
false |
Filter deployments by the target type of the champion model. Example: Binary |
| tagKeys |
query |
any |
false |
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 |
query |
any |
false |
List of tag values to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned. |
Enumerated Values
| Parameter |
Value |
| orderBy |
[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] |
| serviceHealth |
[failing, not_started, passing, unavailable, unknown, warning] |
| modelHealth |
[failing, not_started, passing, unavailable, unknown, warning] |
| accuracyHealth |
[failing, not_started, passing, unavailable, unknown, warning] |
| role |
[OWNER, USER] |
| status |
[active, archived, errored, inactive, launching, replacingModel, stopping] |
| importance |
[CRITICAL, HIGH, MODERATE, LOW] |
| buildEnvironmentType |
[DataRobot, Python, R, Java, Julia, Legacy, Other] |
| executionEnvironmentType |
[datarobot, external] |
| predictionEnvironmentPlatform |
[aws, gcp, azure, onPremise, datarobot, datarobotServerless, openShift, other, snowflake, sapAiCore] |
| createdByMe |
[false, False, true, True] |
| championModelExecutionType |
[custom_inference_model, external, dedicated] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of deployments.",
"items": {
"properties": {
"accuracyHealth": {
"description": "Accuracy health of the deployment.",
"properties": {
"endDate": {
"description": "End date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Accuracy health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"createdAt": {
"description": "The date and time of when the deployment was created, in ISO 8601 format.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.20"
},
"creator": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"defaultPredictionServer": {
"description": "The prediction server associated with the deployment.",
"properties": {
"datarobot-key": {
"description": "The `datarobot-key` header used in requests to this prediction server.",
"type": "string"
},
"id": {
"description": "ID of the prediction server for the deployment.",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the prediction server.",
"type": "string"
}
},
"required": [
"datarobot-key",
"id",
"url"
],
"type": "object"
},
"description": {
"description": "Description of the deployment.",
"type": [
"string",
"null"
]
},
"governance": {
"description": "Deployment governance info.",
"properties": {
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"hasOpenedChangeRequests": {
"description": "If there are change request related to this deployment with `PENDING` status.",
"type": "boolean"
},
"reviewers": {
"description": "A list of reviewers to approve deployment change requests.",
"items": {
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 20,
"type": "array",
"x-versionadded": "v2.37"
}
},
"required": [
"approvalStatus",
"hasOpenedChangeRequests"
],
"type": "object"
},
"hasError": {
"description": "Whether the deployment is not operational because it failed to start properly.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
},
"model": {
"description": "Information related to the current model of the deployment.",
"properties": {
"buildEnvironmentType": {
"description": "Build environment type of the current model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"customModelImage": {
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
},
"deployedAt": {
"description": "Timestamp of when current model was deployed.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"id": {
"description": "ID of the current model.",
"type": "string"
},
"isDeprecated": {
"description": "Whether the current model is deprecated model. eg. python2 based model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"projectId": {
"description": "Project ID of the current model.",
"type": [
"string",
"null"
]
},
"projectName": {
"description": "Project name of the current model.",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Target name of the current model.",
"type": "string"
},
"targetType": {
"description": "Target type of the current model.",
"type": "string"
},
"type": {
"description": "Type of the current model.",
"type": "string"
},
"unstructuredModelKind": {
"description": "Whether the current model is an unstructured model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"unsupervisedMode": {
"description": "Whether the current model's project is unsupervised.",
"type": "boolean",
"x-versionadded": "v2.18"
},
"unsupervisedType": {
"description": "Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.",
"enum": [
"anomaly",
"clustering"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"id",
"isDeprecated",
"projectName",
"targetType",
"type",
"unstructuredModelKind",
"unsupervisedMode"
],
"type": "object"
},
"modelHealth": {
"description": "Model health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Model health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelPackage": {
"description": "Information related to the current ModelPackage.",
"properties": {
"id": {
"description": "ID of the ModelPackage.",
"type": "string"
},
"name": {
"description": "Name of the ModelPackage.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of the associated registered model",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"registeredModelId"
],
"type": "object"
},
"modelPackageInitialDownload": {
"description": "If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time model package was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"openedChangeRequests": {
"description": "An array of the change request IDs related to this deployment that have.",
"items": {
"type": "string"
},
"type": "array"
},
"owners": {
"description": "Count and preview of owners of the deployment.",
"properties": {
"count": {
"description": "Total count of owners.",
"type": "integer"
},
"preview": {
"description": "A list of owner objects.",
"items": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"count",
"preview"
],
"type": "object"
},
"permissions": {
"description": "Permissions that the user making the request has on the deployment.",
"items": {
"enum": [
"CAN_ADD_CHALLENGERS",
"CAN_APPROVE_REPLACEMENT_MODEL",
"CAN_BE_MANAGED_BY_MLOPS_AGENT",
"CAN_DELETE_CHALLENGERS",
"CAN_DELETE_DEPLOYMENT",
"CAN_DOWNLOAD_DOCUMENTATION",
"CAN_EDIT_CHALLENGERS",
"CAN_EDIT_DEPLOYMENT",
"CAN_GENERATE_DOCUMENTATION",
"CAN_MAKE_PREDICTIONS",
"CAN_REPLACE_MODEL",
"CAN_SCORE_CHALLENGERS",
"CAN_SHARE",
"CAN_SHARE_DEPLOYMENT_OWNERSHIP",
"CAN_SUBMIT_ACTUALS",
"CAN_UPDATE_DEPLOYMENT_THRESHOLDS",
"CAN_VIEW"
],
"type": "string"
},
"type": "array",
"x-versionadded": "v2.18"
},
"predictionEnvironment": {
"description": "Information related to the current PredictionEnvironment.",
"properties": {
"id": {
"description": "ID of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"isManagedByManagementAgent": {
"description": "True if PredictionEnvironment is using Management Agent.",
"type": "boolean"
},
"name": {
"description": "Name of the PredictionEnvironment.",
"type": "string"
},
"platform": {
"description": "Platform of the PredictionEnvironment.",
"enum": [
"aws",
"gcp",
"azure",
"onPremise",
"datarobot",
"datarobotServerless",
"openShift",
"other",
"snowflake",
"sapAiCore"
],
"type": "string"
},
"plugin": {
"description": "Plugin name of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"supportedModelFormats": {
"description": "Model formats that the PredictionEnvironment supports.",
"items": {
"enum": [
"datarobot",
"datarobotScoringCode",
"customModel",
"externalModel"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"isManagedByManagementAgent",
"name",
"platform"
],
"type": "object"
},
"predictionUsage": {
"description": "Prediction usage of the deployment.",
"properties": {
"dailyRates": {
"description": "Number of predictions made in the last 7 days.",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Timestamp of the last prediction request.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"serverErrorRates": {
"description": "Number of server errors (5xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
},
"userErrorRates": {
"description": "Number of user errors (4xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
}
},
"required": [
"dailyRates",
"lastTimestamp",
"serverErrorRates",
"userErrorRates"
],
"type": "object"
},
"scoringCodeInitialDownload": {
"description": "If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time scoring code was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Service health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model service period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "Start date of service health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Service health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"startDate",
"status"
],
"type": "object"
},
"settings": {
"description": "Settings of the deployment.",
"properties": {
"batchMonitoringEnabled": {
"description": "if batch monitoring is enabled.",
"type": "boolean"
},
"humbleAiEnabled": {
"description": "if humble ai is enabled.",
"type": "boolean"
},
"predictionIntervalsEnabled": {
"description": "If prediction intervals are enabled.",
"type": "boolean"
},
"predictionWarningEnabled": {
"description": "If prediction warning is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "Displays current deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string",
"x-versionadded": "v2.22"
},
"tags": {
"description": "The list of formatted deployment tags.",
"items": {
"properties": {
"id": {
"description": "The ID of the tag.",
"type": "string"
},
"name": {
"description": "The name of the tag.",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value of the tag.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"id",
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"accuracyHealth",
"createdAt",
"defaultPredictionServer",
"description",
"id",
"label",
"model",
"modelHealth",
"permissions",
"predictionUsage",
"serviceHealth",
"settings",
"status",
"tags"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Create deployment
Operation path: POST /api/v2/deployments/fromLearningModel/
Authentication requirements: BearerAuth
Create a deployment from a DataRobot model.
.. minversion:: v2.37
DEPRECATED: Please register the leaderboard model with [POST /api/v2/modelPackages/fromLeaderboard/][post-apiv2modelpackagesfromleaderboard],
then use the following route to create a deployment [POST /api/v2/deployments/fromModelPackage/][post-apiv2deploymentsfrommodelpackage].
Body parameter
{
"properties": {
"defaultPredictionServerId": {
"description": "ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations.",
"type": "string"
},
"description": {
"default": null,
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"grantInitialDeploymentRolesFromProject": {
"default": true,
"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.",
"type": "boolean",
"x-versionadded": "v2.31"
},
"importance": {
"description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": "string"
},
"modelId": {
"description": "ID of the model to be deployed.",
"type": "string"
},
"predictionThreshold": {
"description": "Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"status": {
"default": "active",
"description": "Status of the deployment",
"enum": [
"active",
"inactive"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"description",
"label",
"modelId"
],
"type": "object"
}
Parameters
Example responses
202 Response
{
"properties": {
"id": {
"description": "The ID of the created deployment.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Responses
Create a deployment from a model package
Operation path: POST /api/v2/deployments/fromModelPackage/
Authentication requirements: BearerAuth
Create a deployment from a model package.
Body parameter
{
"properties": {
"additionalMetadata": {
"description": "Key/Value pair list, with additional metadata",
"items": {
"properties": {
"key": {
"description": "The key, a unique identifier for this item of metadata",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value, the actual content for this item of metadata",
"maxLength": 256,
"type": "string"
}
},
"required": [
"key",
"value"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 40,
"type": "array"
},
"defaultPredictionServerId": {
"description": "ID of the default prediction server for deployment. Required for DataRobot Cloud for non-external models, must be omitted for Enterprise installations.",
"type": "string"
},
"description": {
"default": null,
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"importance": {
"description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": "string"
},
"modelPackageId": {
"description": "ID of the model package to deploy.",
"type": "string"
},
"predictionEnvironmentId": {
"description": "ID of prediction environment where to deploy",
"type": "string"
},
"runtimeParameterValues": {
"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.\n <blockquote>This property is gated behind the feature flags **`['CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT']`**.\n To enable this feature, you can contact your DataRobot representative or administrator.\n </blockquote>",
"feature_flags": [
{
"description": "Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package.",
"enabled_by_default": true,
"maturity": "PUBLIC_PREVIEW",
"name": "CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT"
}
],
"public_preview": true,
"type": "string",
"x-datarobot-public-preview": true,
"x-datarobot-required-feature-flags": [
{
"description": "Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package.",
"enabled_by_default": true,
"maturity": "PUBLIC_PREVIEW",
"name": "CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT"
}
]
},
"status": {
"default": "active",
"description": "Status of the deployment",
"enum": [
"active",
"inactive"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"description",
"label",
"modelPackageId"
],
"type": "object",
"x-versionadded": "v2.37"
}
Parameters
Example responses
202 Response
{
"properties": {
"id": {
"description": "The ID of the created deployment.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 202 |
Accepted |
Job submitted. The URL at the Location header can be used to track when the deployment is ready for predictions. |
DeploymentCreateResponse |
| 422 |
Unprocessable Entity |
Unable to process the deployment creation request. |
None |
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking async job status. |
Update a deployment's prediction environment from dedicated
Operation path: POST /api/v2/deployments/migrateDPStoServerless/
Authentication requirements: BearerAuth
Update a deployment's prediction environment from dedicated to serverless.
Body parameter
{
"properties": {
"dpsDeploymentId": {
"description": "The ID of the deployment on dedicated prediction environment that will be updated to serverless.",
"type": "string"
},
"serverlessPredictionEnvironmentId": {
"description": "The ID of serverless prediction environment.",
"type": "string"
}
},
"required": [
"dpsDeploymentId",
"serverlessPredictionEnvironmentId"
],
"type": "object",
"x-versionadded": "v2.38"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 204 |
No Content |
Deployment successfully updated. |
None |
Delete deployment by deployment ID
Operation path: DELETE /api/v2/deployments/{deploymentId}/
Authentication requirements: BearerAuth
Delete a deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| ignoreManagementAgent |
query |
string |
false |
Do not wait for management agent to delete the deployment first. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| ignoreManagementAgent |
[false, False, true, True] |
Responses
Retrieve deployment by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/
Authentication requirements: BearerAuth
Retrieve a deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Example responses
200 Response
{
"properties": {
"accuracyHealth": {
"description": "Accuracy health of the deployment.",
"properties": {
"endDate": {
"description": "End date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Accuracy health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"createdAt": {
"description": "The date and time of when the deployment was created, in ISO 8601 format.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.20"
},
"creator": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"defaultPredictionServer": {
"description": "The prediction server associated with the deployment.",
"properties": {
"datarobot-key": {
"description": "The `datarobot-key` header used in requests to this prediction server.",
"type": "string"
},
"id": {
"description": "ID of the prediction server for the deployment.",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the prediction server.",
"type": "string"
}
},
"required": [
"datarobot-key",
"id",
"url"
],
"type": "object"
},
"description": {
"description": "Description of the deployment.",
"type": [
"string",
"null"
]
},
"governance": {
"description": "Deployment governance info.",
"properties": {
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"hasOpenedChangeRequests": {
"description": "If there are change request related to this deployment with `PENDING` status.",
"type": "boolean"
},
"reviewers": {
"description": "A list of reviewers to approve deployment change requests.",
"items": {
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 20,
"type": "array",
"x-versionadded": "v2.37"
}
},
"required": [
"approvalStatus",
"hasOpenedChangeRequests"
],
"type": "object"
},
"hasError": {
"description": "Whether the deployment is not operational because it failed to start properly.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
},
"model": {
"description": "Information related to the current model of the deployment.",
"properties": {
"buildEnvironmentType": {
"description": "Build environment type of the current model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"customModelImage": {
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
},
"deployedAt": {
"description": "Timestamp of when current model was deployed.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"id": {
"description": "ID of the current model.",
"type": "string"
},
"isDeprecated": {
"description": "Whether the current model is deprecated model. eg. python2 based model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"projectId": {
"description": "Project ID of the current model.",
"type": [
"string",
"null"
]
},
"projectName": {
"description": "Project name of the current model.",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Target name of the current model.",
"type": "string"
},
"targetType": {
"description": "Target type of the current model.",
"type": "string"
},
"type": {
"description": "Type of the current model.",
"type": "string"
},
"unstructuredModelKind": {
"description": "Whether the current model is an unstructured model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"unsupervisedMode": {
"description": "Whether the current model's project is unsupervised.",
"type": "boolean",
"x-versionadded": "v2.18"
},
"unsupervisedType": {
"description": "Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.",
"enum": [
"anomaly",
"clustering"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"id",
"isDeprecated",
"projectName",
"targetType",
"type",
"unstructuredModelKind",
"unsupervisedMode"
],
"type": "object"
},
"modelHealth": {
"description": "Model health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Model health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelPackage": {
"description": "Information related to the current ModelPackage.",
"properties": {
"id": {
"description": "ID of the ModelPackage.",
"type": "string"
},
"name": {
"description": "Name of the ModelPackage.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of the associated registered model",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"registeredModelId"
],
"type": "object"
},
"modelPackageInitialDownload": {
"description": "If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time model package was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"openedChangeRequests": {
"description": "An array of the change request IDs related to this deployment that have.",
"items": {
"type": "string"
},
"type": "array"
},
"owners": {
"description": "Count and preview of owners of the deployment.",
"properties": {
"count": {
"description": "Total count of owners.",
"type": "integer"
},
"preview": {
"description": "A list of owner objects.",
"items": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"count",
"preview"
],
"type": "object"
},
"permissions": {
"description": "Permissions that the user making the request has on the deployment.",
"items": {
"enum": [
"CAN_ADD_CHALLENGERS",
"CAN_APPROVE_REPLACEMENT_MODEL",
"CAN_BE_MANAGED_BY_MLOPS_AGENT",
"CAN_DELETE_CHALLENGERS",
"CAN_DELETE_DEPLOYMENT",
"CAN_DOWNLOAD_DOCUMENTATION",
"CAN_EDIT_CHALLENGERS",
"CAN_EDIT_DEPLOYMENT",
"CAN_GENERATE_DOCUMENTATION",
"CAN_MAKE_PREDICTIONS",
"CAN_REPLACE_MODEL",
"CAN_SCORE_CHALLENGERS",
"CAN_SHARE",
"CAN_SHARE_DEPLOYMENT_OWNERSHIP",
"CAN_SUBMIT_ACTUALS",
"CAN_UPDATE_DEPLOYMENT_THRESHOLDS",
"CAN_VIEW"
],
"type": "string"
},
"type": "array",
"x-versionadded": "v2.18"
},
"predictionEnvironment": {
"description": "Information related to the current PredictionEnvironment.",
"properties": {
"id": {
"description": "ID of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"isManagedByManagementAgent": {
"description": "True if PredictionEnvironment is using Management Agent.",
"type": "boolean"
},
"name": {
"description": "Name of the PredictionEnvironment.",
"type": "string"
},
"platform": {
"description": "Platform of the PredictionEnvironment.",
"enum": [
"aws",
"gcp",
"azure",
"onPremise",
"datarobot",
"datarobotServerless",
"openShift",
"other",
"snowflake",
"sapAiCore"
],
"type": "string"
},
"plugin": {
"description": "Plugin name of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"supportedModelFormats": {
"description": "Model formats that the PredictionEnvironment supports.",
"items": {
"enum": [
"datarobot",
"datarobotScoringCode",
"customModel",
"externalModel"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"isManagedByManagementAgent",
"name",
"platform"
],
"type": "object"
},
"predictionUsage": {
"description": "Prediction usage of the deployment.",
"properties": {
"dailyRates": {
"description": "Number of predictions made in the last 7 days.",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Timestamp of the last prediction request.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"serverErrorRates": {
"description": "Number of server errors (5xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
},
"userErrorRates": {
"description": "Number of user errors (4xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
}
},
"required": [
"dailyRates",
"lastTimestamp",
"serverErrorRates",
"userErrorRates"
],
"type": "object"
},
"scoringCodeInitialDownload": {
"description": "If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time scoring code was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Service health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model service period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "Start date of service health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Service health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"startDate",
"status"
],
"type": "object"
},
"settings": {
"description": "Settings of the deployment.",
"properties": {
"batchMonitoringEnabled": {
"description": "if batch monitoring is enabled.",
"type": "boolean"
},
"humbleAiEnabled": {
"description": "if humble ai is enabled.",
"type": "boolean"
},
"predictionIntervalsEnabled": {
"description": "If prediction intervals are enabled.",
"type": "boolean"
},
"predictionWarningEnabled": {
"description": "If prediction warning is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "Displays current deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string",
"x-versionadded": "v2.22"
},
"tags": {
"description": "The list of formatted deployment tags.",
"items": {
"properties": {
"id": {
"description": "The ID of the tag.",
"type": "string"
},
"name": {
"description": "The name of the tag.",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value of the tag.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"id",
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"accuracyHealth",
"createdAt",
"defaultPredictionServer",
"description",
"id",
"label",
"model",
"modelHealth",
"permissions",
"predictionUsage",
"serviceHealth",
"settings",
"status",
"tags"
],
"type": "object"
}
Responses
Update deployment by deployment ID
Operation path: PATCH /api/v2/deployments/{deploymentId}/
Authentication requirements: BearerAuth
Update a deployment's label and description.
Body parameter
{
"properties": {
"description": {
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
DeploymentUpdate |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 204 |
No Content |
Deployment successfully updated |
None |
Retrieve capabilities by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/capabilities/
Authentication requirements: BearerAuth
Retrieve the capabilities for the deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Example responses
200 Response
{
"properties": {
"data": {
"description": "List of all capabilities.",
"items": {
"properties": {
"messages": {
"description": "Messages explaining why the capability is supported or not supported.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the capability.",
"type": "string"
},
"supported": {
"description": "If the capability is supported.",
"type": "boolean"
}
},
"required": [
"messages",
"name",
"supported"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Responses
Get deployment features by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/features/
Authentication requirements: BearerAuth
Retrieve features contained within the universe dataset associated with a specific deployment. By default, this returns all raw features required for predictions.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
The number of features to skip, defaults to 0. |
| limit |
query |
integer |
true |
The number of features to return, defaults to 0. |
| includeNonPredictionFeatures |
query |
string |
false |
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 |
query |
string |
false |
When True, features returned will be filtered to those usable for segmented analysis. |
| search |
query |
string |
false |
Case insensitive search against names of the deployment's features. |
| orderBy |
query |
string |
false |
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 |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| includeNonPredictionFeatures |
[false, False, true, True] |
| forSegmentedAnalysis |
[false, False, true, True] |
| orderBy |
[name, -name, importance, -importance] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "An array of features.",
"items": {
"properties": {
"dateFormat": {
"description": "The date format string for how this feature was interpreted.",
"type": [
"string",
"null"
]
},
"featureType": {
"description": "Feature type.",
"type": [
"string",
"null"
]
},
"importance": {
"description": "Numeric measure of the relationship strength between the feature and target (independent of model or other features).",
"type": [
"number",
"null"
]
},
"knownInAdvance": {
"description": "Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.",
"type": "boolean"
},
"name": {
"description": "Feature name.",
"type": "string"
}
},
"required": [
"dateFormat",
"featureType",
"importance",
"knownInAdvance",
"name"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.35"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
Retrieve champion model history of deployment by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/modelHistory/
Authentication requirements: BearerAuth
Retrieve champion model history of deployment.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
false |
This many results will be skipped. |
| limit |
query |
integer |
false |
At most this many results are returned. |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "History of deployment's champion models, including the current champion model.",
"items": {
"properties": {
"customModelImage": {
"description": "Contains information about the custom model image.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": [
"string",
"null"
]
},
"customModelName": {
"description": "Name of the custom model.",
"type": [
"string",
"null"
]
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": [
"string",
"null"
]
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": [
"string",
"null"
]
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object",
"x-versionadded": "v2.36"
},
"endDate": {
"description": "The timestamp when the model is replaced by another model.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastEndDate": {
"description": "The max timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastStartDate": {
"description": "The min timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"modelPackage": {
"description": "Contains information about the model package.",
"properties": {
"id": {
"description": "ID of the model package.",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "ID of the model.",
"type": "string"
},
"name": {
"description": "Name of the model package.",
"type": [
"string",
"null"
]
},
"predictionThreshold": {
"description": "The threshold value used for binary classification prediction.",
"type": [
"number",
"null"
]
},
"projectId": {
"description": "ID of the project.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the associated registered model.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"modelId",
"name",
"predictionThreshold",
"registeredModelId"
],
"type": "object",
"x-versionadded": "v2.36"
},
"predictionWarningBoundaries": {
"description": "Lower and upper boundaries for outlier detection.",
"properties": {
"lower": {
"description": "Lower boundary for outlier detection.",
"type": "number"
},
"upper": {
"description": "Upper boundary for outlier detection.",
"type": "number"
}
},
"required": [
"lower",
"upper"
],
"type": "object",
"x-versionadded": "v2.36"
},
"replacementReason": {
"description": "Reason for model replacement.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The timestamp when the model becomes champion of the deployment.",
"format": "date-time",
"type": "string"
}
},
"required": [
"endDate",
"forecastEndDate",
"forecastStartDate",
"modelPackage",
"replacementReason",
"startDate"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
Add report by deployment ID
Operation path: POST /api/v2/deployments/{deploymentId}/onDemandReports/
Authentication requirements: BearerAuth
Add report to execution queue.
Body parameter
{
"properties": {
"id": {
"description": "ID of Scheduled report record.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
ScheduledReportOnDemmand |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Scheduled report job was addded to execution. |
None |
| Status |
Header |
Type |
Format |
Description |
| 200 |
Location |
string |
|
URL to poll to track report generation has finished. |
Retrieve Scoring Code by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/scoringCode/
Authentication requirements: BearerAuth
Retrieve Scoring Code of the current deployed model for making predictions outside of a DataRobot prediction server.
You need the "Scoring Code" feature enabled to use this route.
By default, returns a compiled executable JAR that can be executed locally to calculate model predictions, or it can be used as a library for a Java application. Execute it with the '--help` parameters to learn how to use it as a command-line utility.
See model API documentation at https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html to be able to use it inside an existing Java application.
With sourceCode query parameter set to 'true', returns a source code archive that can be used to review internal calculations of the model.
This JAR is NOT executable.
See "https://docs.datarobot.com/en/docs/predictions/port-pred/scoring-code/index.html" documentation in DataRobot application for more information.
Note
Cannot retrieve source code if agent is included.
Parameters
| Name |
In |
Type |
Required |
Description |
| sourceCode |
query |
string |
false |
Whether source code or binary of the Scoring Code will be retrieved |
| includeAgent |
query |
string |
false |
Whether the Scoring code retrieved will include tracking agent |
| includePe |
query |
string |
false |
Please use includePredictionExplanations parameter instead |
| includePredictionExplanations |
query |
string |
false |
Whether the Scoring Code retrieved will include prediction explanations |
| includePredictionIntervals |
query |
string |
false |
Whether the Scoring Code retrieved will include prediction intervals |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Enumerated Values
| Parameter |
Value |
| sourceCode |
[false, False, true, True] |
| includeAgent |
[false, False, true, True] |
| includePe |
[false, False, true, True] |
| includePredictionExplanations |
[false, False, true, True] |
| includePredictionIntervals |
[false, False, true, True] |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
JAR file |
None |
| Status |
Header |
Type |
Format |
Description |
| 200 |
Content-Disposition |
string |
|
Indicating the content is supposed to be downloaded as an attachment |
| 200 |
Content-Type |
string |
|
application/java-archive |
Build Java package containing Scoring Code by deployment ID
Operation path: POST /api/v2/deployments/{deploymentId}/scoringCodeBuilds/
Authentication requirements: BearerAuth
Build Java package containing Scoring Code with agent integration.
Body parameter
{
"properties": {
"includeAgent": {
"description": "Whether the Scoring Code built will include tracking agent",
"type": "boolean"
},
"includePredictionExplanations": {
"description": "Whether the Scoring Code built will include prediction explanations",
"type": "boolean"
},
"includePredictionIntervals": {
"description": "Whether the Scoring Code built will include prediction intervals",
"type": "boolean"
}
},
"type": "object"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
Retrieve deployment settings checklist by deployment ID
Operation path: GET /api/v2/deployments/{deploymentId}/settings/checklist/
Authentication requirements: BearerAuth
Return a checklist of deployment settings indicating which settings are configured and which are not.
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
Example responses
200 Response
{
"properties": {
"data": {
"description": "A list of settings for the deployment.",
"items": {
"properties": {
"hint": {
"description": "An optional hint for the setting.",
"maxLength": 255,
"type": [
"string",
"null"
]
},
"label": {
"description": "A descriptive label for the setting.",
"maxLength": 80,
"type": "string"
},
"setting": {
"description": "The identifier of the setting.",
"enum": [
"deploymentName",
"DeploymentName",
"DEPLOYMENT_NAME",
"settingsDataDrift",
"SettingsDataDrift",
"SETTINGS_DATA_DRIFT",
"settingsAccuracy",
"SettingsAccuracy",
"SETTINGS_ACCURACY",
"settingsFairness",
"SettingsFairness",
"SETTINGS_FAIRNESS",
"settingsCustomMetrics",
"SettingsCustomMetrics",
"SETTINGS_CUSTOM_METRICS",
"settingsHumility",
"SettingsHumility",
"SETTINGS_HUMILITY",
"settingsChallengers",
"SettingsChallengers",
"SETTINGS_CHALLENGERS",
"settingsPredictions",
"SettingsPredictions",
"SETTINGS_PREDICTIONS",
"settingsRetraining",
"SettingsRetraining",
"SETTINGS_RETRAINING",
"settingsUsage",
"SettingsUsage",
"SETTINGS_USAGE",
"settingsDataExploration",
"SettingsDataExploration",
"SETTINGS_DATA_EXPLORATION",
"settingsNotifications",
"SettingsNotifications",
"SETTINGS_NOTIFICATIONS"
],
"type": "string"
},
"status": {
"description": "Indicates the completion status of the setting.",
"enum": [
"notSet",
"NotSet",
"NOT_SET",
"partial",
"Partial",
"PARTIAL",
"configured",
"Configured",
"CONFIGURED"
],
"type": "string"
}
},
"required": [
"hint",
"label",
"setting",
"status"
],
"type": "object",
"x-versionadded": "v2.38"
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.38"
}
Responses
Change deployment status by deployment ID
Operation path: PATCH /api/v2/deployments/{deploymentId}/status/
Authentication requirements: BearerAuth
Change deployment status.
Body parameter
{
"properties": {
"status": {
"description": "Status that deployment should be transition in.",
"enum": [
"active",
"inactive"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
DeploymentStatusUpdate |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 202 |
Accepted |
Job submitted. See Location header. |
None |
| 409 |
Conflict |
Deployment is already in process of status change or already in requested status. |
None |
| 422 |
Unprocessable Entity |
Deployment status change request could not be processed. |
None |
| Status |
Header |
Type |
Format |
Description |
| 202 |
Location |
string |
|
URL for tracking async job status. |
List resource bundles
Operation path: GET /api/v2/mlops/compute/bundles/
Authentication requirements: BearerAuth
Retrieve metadata for all resource bundles the user has access to.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
| Feature Flag |
Maturity |
Enabled by default |
Description |
| MLOPS_RESOURCE_REQUEST_BUNDLES |
PUBLIC_PREVIEW |
false |
Instead of managing resources (i.e. CPU, memory, and GPU) individually, users select an available bundle of resources that best fits their Custom Model/Job/App, etc. |
Parameters
| Name |
In |
Type |
Required |
Description |
| entityId |
query |
string |
false |
Identifier used to return recommended resource bundles. Must be used together with entityType parameter. |
| entityType |
query |
string |
false |
Type of entity for which to get recommended bundles. Must be provided with entityId. |
| useCases |
query |
string |
false |
If it is specified, only bundles for this use case will be returned. |
| offset |
query |
integer |
false |
Number of results to skip. |
| limit |
query |
integer |
false |
At most this many results are returned. The default may change without notice. |
Enumerated Values
| Parameter |
Value |
| entityType |
customModelTemplate |
| useCases |
[customApplication, customJob, customModel, modelingMachineWorker, predictionAPI, sapAICore, sparkApplication] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.35"
},
"data": {
"description": "List of bundles.",
"items": {
"properties": {
"cpuCount": {
"description": "Max number of CPUs available.",
"type": "number"
},
"description": {
"description": "A short description of CPU, Memory and other resources.",
"type": "string"
},
"gpuCount": {
"description": "Max number of GPUs available.",
"type": [
"number",
"null"
]
},
"gpuMaker": {
"description": "The manufacture of the GPU.",
"enum": [
"nvidia",
"amd",
"intel"
],
"type": [
"string",
"null"
]
},
"gpuMemoryBytes": {
"description": "Max amount of GPU memory available.",
"type": "integer",
"x-versionadded": "v2.36"
},
"hasGpu": {
"description": "If this bundle provides at least one GPU resource.",
"type": "boolean"
},
"id": {
"description": "The id of the bundle.",
"type": "string"
},
"isDefault": {
"description": "If this should be the default resource choice.",
"type": "boolean"
},
"isDeleted": {
"description": "If the bundle has been deleted and should not be used.",
"type": "boolean"
},
"memoryBytes": {
"description": "Max amount of memory available.",
"type": "integer"
},
"name": {
"description": "A short name for the bundle.",
"type": "string"
},
"useCases": {
"description": "List of use cases this bundle supports.",
"items": {
"enum": [
"customApplication",
"customJob",
"customModel",
"modelingMachineWorker",
"predictionAPI",
"sapAICore",
"sparkApplication"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"cpuCount",
"description",
"gpuMemoryBytes",
"hasGpu",
"id",
"memoryBytes",
"name",
"useCases"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.35"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.35"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.35"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
Retrieve resource bundle by resource request bundle ID
Operation path: GET /api/v2/mlops/compute/bundles/{resourceRequestBundleId}/
Authentication requirements: BearerAuth
Retrieve resource bundle.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
| Feature Flag |
Maturity |
Enabled by default |
Description |
| MLOPS_RESOURCE_REQUEST_BUNDLES |
PUBLIC_PREVIEW |
false |
Instead of managing resources (i.e. CPU, memory, and GPU) individually, users select an available bundle of resources that best fits their Custom Model/Job/App, etc. |
Parameters
| Name |
In |
Type |
Required |
Description |
| resourceRequestBundleId |
path |
string |
true |
ID of the bundle. |
Example responses
200 Response
{
"properties": {
"cpuCount": {
"description": "Max number of CPUs available.",
"type": "number"
},
"description": {
"description": "A short description of CPU, Memory and other resources.",
"type": "string"
},
"gpuCount": {
"description": "Max number of GPUs available.",
"type": [
"number",
"null"
]
},
"gpuMaker": {
"description": "The manufacture of the GPU.",
"enum": [
"nvidia",
"amd",
"intel"
],
"type": [
"string",
"null"
]
},
"gpuMemoryBytes": {
"description": "Max amount of GPU memory available.",
"type": "integer",
"x-versionadded": "v2.36"
},
"hasGpu": {
"description": "If this bundle provides at least one GPU resource.",
"type": "boolean"
},
"id": {
"description": "The id of the bundle.",
"type": "string"
},
"isDefault": {
"description": "If this should be the default resource choice.",
"type": "boolean"
},
"isDeleted": {
"description": "If the bundle has been deleted and should not be used.",
"type": "boolean"
},
"memoryBytes": {
"description": "Max amount of memory available.",
"type": "integer"
},
"name": {
"description": "A short name for the bundle.",
"type": "string"
},
"useCases": {
"description": "List of use cases this bundle supports.",
"items": {
"enum": [
"customApplication",
"customJob",
"customModel",
"modelingMachineWorker",
"predictionAPI",
"sapAICore",
"sparkApplication"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"cpuCount",
"description",
"gpuMemoryBytes",
"hasGpu",
"id",
"memoryBytes",
"name",
"useCases"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses
Downloads the latest Portable Prediction Server (PPS) Docker image
Operation path: GET /api/v2/mlops/portablePredictionServerImage/
Authentication requirements: BearerAuth
Fetches the latest Portable Prediction Server (PPS) Docker image. The resulting image can be docker-loaded. Since the image can be quite large (14GB+) consider querying its metadata to check the image size in advance and content hash to verify the downloaded image afterwards. In some environments it can HTTP redirect to some other service (like S3 or GCP) using pre-signed URLs.
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Download the latest available Portable Prediction Server (PPS) Docker image |
None |
| 302 |
Found |
Redirect to another service for more efficient content download using pre-signed URL |
None |
| 404 |
Not Found |
No PPS images found in the system |
None |
Operation path: GET /api/v2/mlops/portablePredictionServerImage/metadata/
Authentication requirements: BearerAuth
Fetches currently active PPS Docker image metadata.
Example responses
200 Response
{
"properties": {
"baseImageId": {
"description": "Internal base image entity id for troubleshooting purposes",
"type": "string"
},
"created": {
"description": "ISO formatted image upload date",
"format": "date-time",
"type": "string"
},
"datarobotRuntimeImageTag": {
"description": "For internal use only.",
"type": [
"string",
"null"
]
},
"dockerImageId": {
"description": "A Docker image id (immutable, content-based) hash associated with the given image",
"type": "string"
},
"filename": {
"description": "The name of the file when the download requested",
"type": "string"
},
"hash": {
"description": "Hash of the image content, supposed to be used for verifying content after the download. The algorithm used for hashing is specified in `hashAlgorithm` field. Note that hash is calculated over compressed image data.",
"type": "string"
},
"hashAlgorithm": {
"description": "An algorithm name used for calculating content `hash`",
"enum": [
"SHA256"
],
"type": "string"
},
"imageSize": {
"description": "Size in bytes of the compressed PPS image data",
"type": "integer"
},
"shortDockerImageId": {
"description": "A 12-chars shortened version of the `dockerImageId` as shown in 'docker images' command line command output",
"type": "string"
}
},
"required": [
"baseImageId",
"created",
"dockerImageId",
"filename",
"hash",
"hashAlgorithm",
"imageSize",
"shortDockerImageId"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
Available Portable Prediction Server (PPS) image metadata |
PPSImageMetadataResponse |
| 404 |
Not Found |
No PPS images found in the system |
None |
Get a list of users who have access by environment ID
Operation path: GET /api/v2/executionEnvironments/{environmentId}/accessControl/
Authentication requirements: BearerAuth
Get a list of users who have access to this execution environment and their roles.
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
This many results will be skipped |
| limit |
query |
integer |
true |
At most this many results are returned |
| username |
query |
string |
false |
Optional, only return the access control information for a user with this username. |
| userId |
query |
string |
false |
Optional, only return the access control information for a user with this user ID. |
| environmentId |
path |
string |
true |
The ID of the environment. |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"role": {
"description": "The role of the user on this entity.",
"type": "string"
},
"userId": {
"description": "The identifier of the user that has access to this entity.",
"type": "string"
},
"username": {
"description": "The username of the user that has access to the entity.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
SharingListResponse |
| 400 |
Bad Request |
Bad Request. Both username and userId were specified |
None |
| 403 |
Forbidden |
Forbidden. The user does not have permissions to view the execution environment access list. |
None |
| 404 |
Not Found |
Execution environment not found. Either the execution environment does not exist or user does not have permission to view it. |
None |
Grant access by environment ID
Operation path: PATCH /api/v2/executionEnvironments/{environmentId}/accessControl/
Authentication requirements: BearerAuth
Grant access or update roles for users on this execution environment. Up to 100 user roles may be set in a single request.
Body parameter
{
"properties": {
"data": {
"description": "List of sharing roles to update.",
"items": {
"properties": {
"canShare": {
"default": true,
"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.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Parameters
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 204 |
No Content |
Roles updated successfully. |
None |
| 403 |
Forbidden |
User can view execution environment but does not have permission to grant these roles on the execution environment. |
None |
| 404 |
Not Found |
Either the execution environment does not exist or the user does not have permissions to view the execution environment. |
None |
| 409 |
Conflict |
The request would leave the execution environment without an owner. |
None |
| 422 |
Unprocessable Entity |
One of the users in the request does not exist, or the request is otherwise invalid. |
None |
Schemas
AccessControl
{
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"role": {
"description": "The role of the user on this entity.",
"type": "string"
},
"userId": {
"description": "The identifier of the user that has access to this entity.",
"type": "string"
},
"username": {
"description": "The username of the user that has access to the entity.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| canShare |
boolean |
true |
|
Whether the recipient can share the role further. |
| role |
string |
true |
|
The role of the user on this entity. |
| userId |
string |
true |
|
The identifier of the user that has access to this entity. |
| username |
string |
true |
|
The username of the user that has access to the entity. |
CustomModelAsyncOperationResponse
{
"properties": {
"statusId": {
"description": "ID that can be used with [GET /api/v2/status/{statusId}/][get-apiv2statusstatusid] to poll for the testing job's status",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| statusId |
string |
true |
|
ID that can be used with [GET /api/v2/status/{statusId}/][get-apiv2statusstatusid] to poll for the testing job's status |
CustomModelDeploymentListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom model deployments.",
"items": {
"properties": {
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelImageId": {
"description": "The id of the custom model image associated with this deployment.",
"type": "string"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"deployed": {
"description": "ISO-8601 timestamp of when deployment was created.",
"type": "string"
},
"deployedBy": {
"description": "The username of the user that deployed the custom model.",
"type": "string"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"imageType": {
"description": "The type of the image, either customModelImage if the testing attempt is using a customModelImage as its model or customModelVersion if the testing attempt is using a customModelVersion with dependency management.",
"enum": [
"customModelImage",
"customModelVersion"
],
"type": "string"
},
"label": {
"description": "User-friendly name of the model deployment.",
"type": "string"
},
"status": {
"description": "Deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string"
},
"testingStatus": {
"description": "Latest testing status of the deployed custom model image.",
"enum": [
"not_tested",
"queued",
"failed",
"canceled",
"succeeded",
"in_progress",
"aborted",
"warning",
"skipped"
],
"type": "string"
}
},
"required": [
"customModel",
"customModelImageId",
"customModelVersion",
"deployed",
"deployedBy",
"executionEnvironment",
"executionEnvironmentVersion",
"id",
"label",
"status",
"testingStatus"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[CustomModelDeploymentResponse] |
true |
maxItems: 1000
|
List of custom model deployments. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
CustomModelDeploymentResponse
{
"properties": {
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelImageId": {
"description": "The id of the custom model image associated with this deployment.",
"type": "string"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"deployed": {
"description": "ISO-8601 timestamp of when deployment was created.",
"type": "string"
},
"deployedBy": {
"description": "The username of the user that deployed the custom model.",
"type": "string"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"imageType": {
"description": "The type of the image, either customModelImage if the testing attempt is using a customModelImage as its model or customModelVersion if the testing attempt is using a customModelVersion with dependency management.",
"enum": [
"customModelImage",
"customModelVersion"
],
"type": "string"
},
"label": {
"description": "User-friendly name of the model deployment.",
"type": "string"
},
"status": {
"description": "Deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string"
},
"testingStatus": {
"description": "Latest testing status of the deployed custom model image.",
"enum": [
"not_tested",
"queued",
"failed",
"canceled",
"succeeded",
"in_progress",
"aborted",
"warning",
"skipped"
],
"type": "string"
}
},
"required": [
"customModel",
"customModelImageId",
"customModelVersion",
"deployed",
"deployedBy",
"executionEnvironment",
"executionEnvironmentVersion",
"id",
"label",
"status",
"testingStatus"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| customModel |
CustomModelShortResponse |
true |
|
Custom model associated with this deployment. |
| customModelImageId |
string |
true |
|
The id of the custom model image associated with this deployment. |
| customModelVersion |
CustomModelVersionShortResponse |
true |
|
Custom model version associated with this deployment. |
| deployed |
string |
true |
|
ISO-8601 timestamp of when deployment was created. |
| deployedBy |
string |
true |
|
The username of the user that deployed the custom model. |
| executionEnvironment |
ExecutionEnvironmentShortResponse |
true |
|
Execution environment associated with this deployment. |
| executionEnvironmentVersion |
ExecutionEnvironmentVersionShortResponse |
true |
|
Execution environment version associated with this deployment. |
| id |
string |
true |
|
The ID of the deployment. |
| imageType |
string |
false |
|
The type of the image, either customModelImage if the testing attempt is using a customModelImage as its model or customModelVersion if the testing attempt is using a customModelVersion with dependency management. |
| label |
string |
true |
|
User-friendly name of the model deployment. |
| status |
string |
true |
|
Deployment status. |
| testingStatus |
string |
true |
|
Latest testing status of the deployed custom model image. |
Enumerated Values
| Property |
Value |
| imageType |
[customModelImage, customModelVersion] |
| status |
[active, archived, errored, inactive, launching, replacingModel, stopping] |
| testingStatus |
[not_tested, queued, failed, canceled, succeeded, in_progress, aborted, warning, skipped] |
CustomModelImage
{
"description": "Contains information about the custom model image.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": [
"string",
"null"
]
},
"customModelName": {
"description": "Name of the custom model.",
"type": [
"string",
"null"
]
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": [
"string",
"null"
]
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": [
"string",
"null"
]
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object",
"x-versionadded": "v2.36"
}
Contains information about the custom model image.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| customModelId |
string,null |
true |
|
ID of the custom model. |
| customModelName |
string,null |
true |
|
Name of the custom model. |
| customModelVersionId |
string,null |
true |
|
ID of the custom model version. |
| customModelVersionLabel |
string,null |
true |
|
Label of the custom model version. |
| executionEnvironmentId |
string,null |
true |
|
ID of the execution environment. |
| executionEnvironmentName |
string,null |
true |
|
Name of the execution environment. |
| executionEnvironmentVersionId |
string,null |
true |
|
ID of the execution environment version. |
| executionEnvironmentVersionLabel |
string,null |
true |
|
Label of the execution environment version. |
CustomModelShortResponse
{
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
Custom model associated with this deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the custom model. |
| name |
string |
true |
|
User-friendly name of the model. |
CustomModelVersionShortResponse
{
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
}
Custom model version associated with this deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the custom model version. |
| label |
string |
true |
|
User-friendly name of the model version. |
DeletedDeploymentListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of deleted deployments.",
"items": {
"properties": {
"deletedAt": {
"description": "The date and time of when the deployment was deleted, in ISO 8601 format.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "ID of the deployment.",
"type": "string"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
}
},
"required": [
"deletedAt",
"id",
"label"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next",
"previous"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[DeletedDeploymentResponse] |
true |
|
List of deleted deployments. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
DeletedDeploymentResponse
{
"properties": {
"deletedAt": {
"description": "The date and time of when the deployment was deleted, in ISO 8601 format.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "ID of the deployment.",
"type": "string"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
}
},
"required": [
"deletedAt",
"id",
"label"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| deletedAt |
string(date-time) |
true |
|
The date and time of when the deployment was deleted, in ISO 8601 format. |
| id |
string |
true |
|
ID of the deployment. |
| label |
string |
true |
maxLength: 512
|
Label of the deployment. |
DeploymentAccuracyHealthResponse
{
"description": "Accuracy health of the deployment.",
"properties": {
"endDate": {
"description": "End date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Accuracy health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
Accuracy health of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| endDate |
string,null(date-time) |
true |
|
End date of accuracy health period. |
| message |
string |
true |
|
A message providing more detail on the status. |
| startDate |
string,null(date-time) |
true |
|
Start date of accuracy health period. |
| status |
string |
true |
|
Accuracy health status. |
Enumerated Values
| Property |
Value |
| status |
[failing, notStarted, passing, unavailable, unknown, warning] |
DeploymentCapabilitiesRetrieveResponse
{
"properties": {
"data": {
"description": "List of all capabilities.",
"items": {
"properties": {
"messages": {
"description": "Messages explaining why the capability is supported or not supported.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the capability.",
"type": "string"
},
"supported": {
"description": "If the capability is supported.",
"type": "boolean"
}
},
"required": [
"messages",
"name",
"supported"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[DeploymentCapability] |
true |
|
List of all capabilities. |
DeploymentCapability
{
"properties": {
"messages": {
"description": "Messages explaining why the capability is supported or not supported.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the capability.",
"type": "string"
},
"supported": {
"description": "If the capability is supported.",
"type": "boolean"
}
},
"required": [
"messages",
"name",
"supported"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| messages |
[string] |
true |
|
Messages explaining why the capability is supported or not supported. |
| name |
string |
true |
|
The name of the capability. |
| supported |
boolean |
true |
|
If the capability is supported. |
DeploymentChecklistResponse
{
"properties": {
"data": {
"description": "A list of settings for the deployment.",
"items": {
"properties": {
"hint": {
"description": "An optional hint for the setting.",
"maxLength": 255,
"type": [
"string",
"null"
]
},
"label": {
"description": "A descriptive label for the setting.",
"maxLength": 80,
"type": "string"
},
"setting": {
"description": "The identifier of the setting.",
"enum": [
"deploymentName",
"DeploymentName",
"DEPLOYMENT_NAME",
"settingsDataDrift",
"SettingsDataDrift",
"SETTINGS_DATA_DRIFT",
"settingsAccuracy",
"SettingsAccuracy",
"SETTINGS_ACCURACY",
"settingsFairness",
"SettingsFairness",
"SETTINGS_FAIRNESS",
"settingsCustomMetrics",
"SettingsCustomMetrics",
"SETTINGS_CUSTOM_METRICS",
"settingsHumility",
"SettingsHumility",
"SETTINGS_HUMILITY",
"settingsChallengers",
"SettingsChallengers",
"SETTINGS_CHALLENGERS",
"settingsPredictions",
"SettingsPredictions",
"SETTINGS_PREDICTIONS",
"settingsRetraining",
"SettingsRetraining",
"SETTINGS_RETRAINING",
"settingsUsage",
"SettingsUsage",
"SETTINGS_USAGE",
"settingsDataExploration",
"SettingsDataExploration",
"SETTINGS_DATA_EXPLORATION",
"settingsNotifications",
"SettingsNotifications",
"SETTINGS_NOTIFICATIONS"
],
"type": "string"
},
"status": {
"description": "Indicates the completion status of the setting.",
"enum": [
"notSet",
"NotSet",
"NOT_SET",
"partial",
"Partial",
"PARTIAL",
"configured",
"Configured",
"CONFIGURED"
],
"type": "string"
}
},
"required": [
"hint",
"label",
"setting",
"status"
],
"type": "object",
"x-versionadded": "v2.38"
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.38"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[SingleDeploymentSetting] |
true |
maxItems: 12
|
A list of settings for the deployment. |
DeploymentCreateFromLearningModel
{
"properties": {
"defaultPredictionServerId": {
"description": "ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations.",
"type": "string"
},
"description": {
"default": null,
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"grantInitialDeploymentRolesFromProject": {
"default": true,
"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.",
"type": "boolean",
"x-versionadded": "v2.31"
},
"importance": {
"description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": "string"
},
"modelId": {
"description": "ID of the model to be deployed.",
"type": "string"
},
"predictionThreshold": {
"description": "Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"status": {
"default": "active",
"description": "Status of the deployment",
"enum": [
"active",
"inactive"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"description",
"label",
"modelId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| defaultPredictionServerId |
string |
false |
|
ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations. |
| description |
string,null |
true |
maxLength: 10000
|
A description for the deployment. |
| grantInitialDeploymentRolesFromProject |
boolean |
false |
|
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 |
false |
|
Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled. |
| label |
string |
true |
maxLength: 512
|
A human-readable name for the deployment. |
| modelId |
string |
true |
|
ID of the model to be deployed. |
| predictionThreshold |
number |
false |
maximum: 1
minimum: 0
|
Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used. |
| status |
string,null |
false |
|
Status of the deployment |
Enumerated Values
| Property |
Value |
| importance |
[CRITICAL, HIGH, MODERATE, LOW] |
| status |
[active, inactive] |
DeploymentCreateFromModelPackage
{
"properties": {
"additionalMetadata": {
"description": "Key/Value pair list, with additional metadata",
"items": {
"properties": {
"key": {
"description": "The key, a unique identifier for this item of metadata",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value, the actual content for this item of metadata",
"maxLength": 256,
"type": "string"
}
},
"required": [
"key",
"value"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 40,
"type": "array"
},
"defaultPredictionServerId": {
"description": "ID of the default prediction server for deployment. Required for DataRobot Cloud for non-external models, must be omitted for Enterprise installations.",
"type": "string"
},
"description": {
"default": null,
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"importance": {
"description": "Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": "string"
},
"modelPackageId": {
"description": "ID of the model package to deploy.",
"type": "string"
},
"predictionEnvironmentId": {
"description": "ID of prediction environment where to deploy",
"type": "string"
},
"runtimeParameterValues": {
"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.\n <blockquote>This property is gated behind the feature flags **`['CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT']`**.\n To enable this feature, you can contact your DataRobot representative or administrator.\n </blockquote>",
"feature_flags": [
{
"description": "Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package.",
"enabled_by_default": true,
"maturity": "PUBLIC_PREVIEW",
"name": "CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT"
}
],
"public_preview": true,
"type": "string",
"x-datarobot-public-preview": true,
"x-datarobot-required-feature-flags": [
{
"description": "Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package.",
"enabled_by_default": true,
"maturity": "PUBLIC_PREVIEW",
"name": "CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT"
}
]
},
"status": {
"default": "active",
"description": "Status of the deployment",
"enum": [
"active",
"inactive"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"description",
"label",
"modelPackageId"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| additionalMetadata |
[KeyValuePair] |
false |
maxItems: 40
|
Key/Value pair list, with additional metadata |
| defaultPredictionServerId |
string |
false |
|
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 |
true |
maxLength: 10000
|
A description for the deployment. |
| importance |
string,null |
false |
|
Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled. |
| label |
string |
true |
maxLength: 512
|
A human-readable name for the deployment. |
| modelPackageId |
string |
true |
|
ID of the model package to deploy. |
| predictionEnvironmentId |
string |
false |
|
ID of prediction environment where to deploy |
| runtimeParameterValues |
string |
false |
|
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.
This property is gated behind the feature flags ['CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT'].
To enable this feature, you can contact your DataRobot representative or administrator.
|
| status |
string,null |
false |
|
Status of the deployment |
| userProvidedId |
string |
false |
maxLength: 100
|
A user-provided unique ID associated with a deployment definition in a remote git repository. |
Enumerated Values
| Property |
Value |
| importance |
[CRITICAL, HIGH, MODERATE, LOW] |
| status |
[active, inactive] |
DeploymentCreateResponse
{
"properties": {
"id": {
"description": "The ID of the created deployment.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the created deployment. |
DeploymentDefaultPredictionServerResponse
{
"description": "The prediction server associated with the deployment.",
"properties": {
"datarobot-key": {
"description": "The `datarobot-key` header used in requests to this prediction server.",
"type": "string"
},
"id": {
"description": "ID of the prediction server for the deployment.",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the prediction server.",
"type": "string"
}
},
"required": [
"datarobot-key",
"id",
"url"
],
"type": "object"
}
The prediction server associated with the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| datarobot-key |
string |
true |
|
The datarobot-key header used in requests to this prediction server. |
| id |
string,null |
true |
|
ID of the prediction server for the deployment. |
| url |
string |
true |
|
URL of the prediction server. |
DeploymentGovernanceResponse
{
"description": "Deployment governance info.",
"properties": {
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"hasOpenedChangeRequests": {
"description": "If there are change request related to this deployment with `PENDING` status.",
"type": "boolean"
},
"reviewers": {
"description": "A list of reviewers to approve deployment change requests.",
"items": {
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 20,
"type": "array",
"x-versionadded": "v2.37"
}
},
"required": [
"approvalStatus",
"hasOpenedChangeRequests"
],
"type": "object"
}
Deployment governance info.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| approvalStatus |
string |
true |
|
Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response. |
| hasOpenedChangeRequests |
boolean |
true |
|
If there are change request related to this deployment with PENDING status. |
| reviewers |
[DeploymentReviewerResponse] |
false |
maxItems: 20
|
A list of reviewers to approve deployment change requests. |
Enumerated Values
| Property |
Value |
| approvalStatus |
[PENDING, APPROVED] |
DeploymentListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of deployments.",
"items": {
"properties": {
"accuracyHealth": {
"description": "Accuracy health of the deployment.",
"properties": {
"endDate": {
"description": "End date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Accuracy health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"createdAt": {
"description": "The date and time of when the deployment was created, in ISO 8601 format.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.20"
},
"creator": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"defaultPredictionServer": {
"description": "The prediction server associated with the deployment.",
"properties": {
"datarobot-key": {
"description": "The `datarobot-key` header used in requests to this prediction server.",
"type": "string"
},
"id": {
"description": "ID of the prediction server for the deployment.",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the prediction server.",
"type": "string"
}
},
"required": [
"datarobot-key",
"id",
"url"
],
"type": "object"
},
"description": {
"description": "Description of the deployment.",
"type": [
"string",
"null"
]
},
"governance": {
"description": "Deployment governance info.",
"properties": {
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"hasOpenedChangeRequests": {
"description": "If there are change request related to this deployment with `PENDING` status.",
"type": "boolean"
},
"reviewers": {
"description": "A list of reviewers to approve deployment change requests.",
"items": {
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 20,
"type": "array",
"x-versionadded": "v2.37"
}
},
"required": [
"approvalStatus",
"hasOpenedChangeRequests"
],
"type": "object"
},
"hasError": {
"description": "Whether the deployment is not operational because it failed to start properly.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
},
"model": {
"description": "Information related to the current model of the deployment.",
"properties": {
"buildEnvironmentType": {
"description": "Build environment type of the current model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"customModelImage": {
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
},
"deployedAt": {
"description": "Timestamp of when current model was deployed.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"id": {
"description": "ID of the current model.",
"type": "string"
},
"isDeprecated": {
"description": "Whether the current model is deprecated model. eg. python2 based model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"projectId": {
"description": "Project ID of the current model.",
"type": [
"string",
"null"
]
},
"projectName": {
"description": "Project name of the current model.",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Target name of the current model.",
"type": "string"
},
"targetType": {
"description": "Target type of the current model.",
"type": "string"
},
"type": {
"description": "Type of the current model.",
"type": "string"
},
"unstructuredModelKind": {
"description": "Whether the current model is an unstructured model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"unsupervisedMode": {
"description": "Whether the current model's project is unsupervised.",
"type": "boolean",
"x-versionadded": "v2.18"
},
"unsupervisedType": {
"description": "Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.",
"enum": [
"anomaly",
"clustering"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"id",
"isDeprecated",
"projectName",
"targetType",
"type",
"unstructuredModelKind",
"unsupervisedMode"
],
"type": "object"
},
"modelHealth": {
"description": "Model health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Model health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelPackage": {
"description": "Information related to the current ModelPackage.",
"properties": {
"id": {
"description": "ID of the ModelPackage.",
"type": "string"
},
"name": {
"description": "Name of the ModelPackage.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of the associated registered model",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"registeredModelId"
],
"type": "object"
},
"modelPackageInitialDownload": {
"description": "If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time model package was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"openedChangeRequests": {
"description": "An array of the change request IDs related to this deployment that have.",
"items": {
"type": "string"
},
"type": "array"
},
"owners": {
"description": "Count and preview of owners of the deployment.",
"properties": {
"count": {
"description": "Total count of owners.",
"type": "integer"
},
"preview": {
"description": "A list of owner objects.",
"items": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"count",
"preview"
],
"type": "object"
},
"permissions": {
"description": "Permissions that the user making the request has on the deployment.",
"items": {
"enum": [
"CAN_ADD_CHALLENGERS",
"CAN_APPROVE_REPLACEMENT_MODEL",
"CAN_BE_MANAGED_BY_MLOPS_AGENT",
"CAN_DELETE_CHALLENGERS",
"CAN_DELETE_DEPLOYMENT",
"CAN_DOWNLOAD_DOCUMENTATION",
"CAN_EDIT_CHALLENGERS",
"CAN_EDIT_DEPLOYMENT",
"CAN_GENERATE_DOCUMENTATION",
"CAN_MAKE_PREDICTIONS",
"CAN_REPLACE_MODEL",
"CAN_SCORE_CHALLENGERS",
"CAN_SHARE",
"CAN_SHARE_DEPLOYMENT_OWNERSHIP",
"CAN_SUBMIT_ACTUALS",
"CAN_UPDATE_DEPLOYMENT_THRESHOLDS",
"CAN_VIEW"
],
"type": "string"
},
"type": "array",
"x-versionadded": "v2.18"
},
"predictionEnvironment": {
"description": "Information related to the current PredictionEnvironment.",
"properties": {
"id": {
"description": "ID of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"isManagedByManagementAgent": {
"description": "True if PredictionEnvironment is using Management Agent.",
"type": "boolean"
},
"name": {
"description": "Name of the PredictionEnvironment.",
"type": "string"
},
"platform": {
"description": "Platform of the PredictionEnvironment.",
"enum": [
"aws",
"gcp",
"azure",
"onPremise",
"datarobot",
"datarobotServerless",
"openShift",
"other",
"snowflake",
"sapAiCore"
],
"type": "string"
},
"plugin": {
"description": "Plugin name of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"supportedModelFormats": {
"description": "Model formats that the PredictionEnvironment supports.",
"items": {
"enum": [
"datarobot",
"datarobotScoringCode",
"customModel",
"externalModel"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"isManagedByManagementAgent",
"name",
"platform"
],
"type": "object"
},
"predictionUsage": {
"description": "Prediction usage of the deployment.",
"properties": {
"dailyRates": {
"description": "Number of predictions made in the last 7 days.",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Timestamp of the last prediction request.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"serverErrorRates": {
"description": "Number of server errors (5xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
},
"userErrorRates": {
"description": "Number of user errors (4xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
}
},
"required": [
"dailyRates",
"lastTimestamp",
"serverErrorRates",
"userErrorRates"
],
"type": "object"
},
"scoringCodeInitialDownload": {
"description": "If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time scoring code was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Service health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model service period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "Start date of service health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Service health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"startDate",
"status"
],
"type": "object"
},
"settings": {
"description": "Settings of the deployment.",
"properties": {
"batchMonitoringEnabled": {
"description": "if batch monitoring is enabled.",
"type": "boolean"
},
"humbleAiEnabled": {
"description": "if humble ai is enabled.",
"type": "boolean"
},
"predictionIntervalsEnabled": {
"description": "If prediction intervals are enabled.",
"type": "boolean"
},
"predictionWarningEnabled": {
"description": "If prediction warning is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "Displays current deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string",
"x-versionadded": "v2.22"
},
"tags": {
"description": "The list of formatted deployment tags.",
"items": {
"properties": {
"id": {
"description": "The ID of the tag.",
"type": "string"
},
"name": {
"description": "The name of the tag.",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value of the tag.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"id",
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"accuracyHealth",
"createdAt",
"defaultPredictionServer",
"description",
"id",
"label",
"model",
"modelHealth",
"permissions",
"predictionUsage",
"serviceHealth",
"settings",
"status",
"tags"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[DeploymentRetrieveResponse] |
true |
|
List of deployments. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
DeploymentModelCustomModelImageResponse
{
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
}
Information related to the custom model image of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| customModelId |
string |
true |
|
ID of the custom model. |
| customModelName |
string |
true |
|
Name of the custom model. |
| customModelVersionId |
string |
true |
|
ID of the custom model version. |
| customModelVersionLabel |
string |
true |
|
Label of the custom model version. |
| executionEnvironmentId |
string |
true |
|
ID of the execution environment. |
| executionEnvironmentName |
string |
true |
|
Name of the execution environment. |
| executionEnvironmentVersionId |
string |
true |
|
ID of the execution environment version. |
| executionEnvironmentVersionLabel |
string |
true |
|
Label of the execution environment version. |
DeploymentModelHealthResponse
{
"description": "Model health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Model health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
Model health of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| endDate |
string,null(date-time) |
true |
|
End date of model health period. |
| message |
string |
true |
|
A message providing more detail on the status. |
| startDate |
string,null(date-time) |
true |
|
Start date of model health period. |
| status |
string |
true |
|
Model health status. |
Enumerated Values
| Property |
Value |
| status |
[failing, notStarted, passing, unavailable, unknown, warning] |
DeploymentModelPackageInitialDownloadResponse
{
"description": "If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time model package was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
}
If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| timestamp |
string,null(date-time) |
true |
|
Timestamp of the first time model package was downloaded. |
DeploymentModelPackageResponse
{
"description": "Information related to the current ModelPackage.",
"properties": {
"id": {
"description": "ID of the ModelPackage.",
"type": "string"
},
"name": {
"description": "Name of the ModelPackage.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of the associated registered model",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"registeredModelId"
],
"type": "object"
}
Information related to the current ModelPackage.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
ID of the ModelPackage. |
| name |
string |
true |
|
Name of the ModelPackage. |
| registeredModelId |
string,null |
true |
|
The ID of the associated registered model |
DeploymentModelResponse
{
"description": "Information related to the current model of the deployment.",
"properties": {
"buildEnvironmentType": {
"description": "Build environment type of the current model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"customModelImage": {
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
},
"deployedAt": {
"description": "Timestamp of when current model was deployed.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"id": {
"description": "ID of the current model.",
"type": "string"
},
"isDeprecated": {
"description": "Whether the current model is deprecated model. eg. python2 based model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"projectId": {
"description": "Project ID of the current model.",
"type": [
"string",
"null"
]
},
"projectName": {
"description": "Project name of the current model.",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Target name of the current model.",
"type": "string"
},
"targetType": {
"description": "Target type of the current model.",
"type": "string"
},
"type": {
"description": "Type of the current model.",
"type": "string"
},
"unstructuredModelKind": {
"description": "Whether the current model is an unstructured model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"unsupervisedMode": {
"description": "Whether the current model's project is unsupervised.",
"type": "boolean",
"x-versionadded": "v2.18"
},
"unsupervisedType": {
"description": "Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.",
"enum": [
"anomaly",
"clustering"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"id",
"isDeprecated",
"projectName",
"targetType",
"type",
"unstructuredModelKind",
"unsupervisedMode"
],
"type": "object"
}
Information related to the current model of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| buildEnvironmentType |
string,null |
false |
|
Build environment type of the current model. |
| customModelImage |
DeploymentModelCustomModelImageResponse |
false |
|
Information related to the custom model image of the deployment. |
| deployedAt |
string,null(date-time) |
false |
|
Timestamp of when current model was deployed. |
| id |
string |
true |
|
ID of the current model. |
| isDeprecated |
boolean |
true |
|
Whether the current model is deprecated model. eg. python2 based model. |
| projectId |
string,null |
false |
|
Project ID of the current model. |
| projectName |
string,null |
true |
|
Project name of the current model. |
| targetName |
string |
false |
|
Target name of the current model. |
| targetType |
string |
true |
|
Target type of the current model. |
| type |
string |
true |
|
Type of the current model. |
| unstructuredModelKind |
boolean |
true |
|
Whether the current model is an unstructured model. |
| unsupervisedMode |
boolean |
true |
|
Whether the current model's project is unsupervised. |
| unsupervisedType |
string,null |
false |
|
Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'. |
Enumerated Values
| Property |
Value |
| unsupervisedType |
[anomaly, clustering] |
DeploymentOwnerResponse
{
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
}
Creator of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| email |
string,null |
true |
|
Email address of the owner. |
| firstName |
string,null |
true |
|
First name of the owner. |
| id |
string |
true |
|
ID of the owner. |
| lastName |
string,null |
true |
|
Last name of the owner. |
DeploymentOwnersResponse
{
"description": "Count and preview of owners of the deployment.",
"properties": {
"count": {
"description": "Total count of owners.",
"type": "integer"
},
"preview": {
"description": "A list of owner objects.",
"items": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"count",
"preview"
],
"type": "object"
}
Count and preview of owners of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
true |
|
Total count of owners. |
| preview |
[DeploymentOwnerResponse] |
true |
|
A list of owner objects. |
DeploymentPermanentDelete
{
"properties": {
"action": {
"description": "Action to perform on these deleted deployments.",
"enum": [
"PermanentlyErase"
],
"type": "string"
},
"deploymentIds": {
"description": "ID of a list of deleted deployments to perform action on.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"action",
"deploymentIds"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| action |
string |
true |
|
Action to perform on these deleted deployments. |
| deploymentIds |
[string] |
true |
maxItems: 100
minItems: 1
|
ID of a list of deleted deployments to perform action on. |
Enumerated Values
| Property |
Value |
| action |
PermanentlyErase |
DeploymentPredictionEnvironmentResponse
{
"description": "Information related to the current PredictionEnvironment.",
"properties": {
"id": {
"description": "ID of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"isManagedByManagementAgent": {
"description": "True if PredictionEnvironment is using Management Agent.",
"type": "boolean"
},
"name": {
"description": "Name of the PredictionEnvironment.",
"type": "string"
},
"platform": {
"description": "Platform of the PredictionEnvironment.",
"enum": [
"aws",
"gcp",
"azure",
"onPremise",
"datarobot",
"datarobotServerless",
"openShift",
"other",
"snowflake",
"sapAiCore"
],
"type": "string"
},
"plugin": {
"description": "Plugin name of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"supportedModelFormats": {
"description": "Model formats that the PredictionEnvironment supports.",
"items": {
"enum": [
"datarobot",
"datarobotScoringCode",
"customModel",
"externalModel"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"isManagedByManagementAgent",
"name",
"platform"
],
"type": "object"
}
Information related to the current PredictionEnvironment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string,null |
true |
|
ID of the PredictionEnvironment. |
| isManagedByManagementAgent |
boolean |
true |
|
True if PredictionEnvironment is using Management Agent. |
| name |
string |
true |
|
Name of the PredictionEnvironment. |
| platform |
string |
true |
|
Platform of the PredictionEnvironment. |
| plugin |
string,null |
false |
|
Plugin name of the PredictionEnvironment. |
| supportedModelFormats |
[string] |
false |
maxItems: 4
minItems: 1
|
Model formats that the PredictionEnvironment supports. |
Enumerated Values
| Property |
Value |
| platform |
[aws, gcp, azure, onPremise, datarobot, datarobotServerless, openShift, other, snowflake, sapAiCore] |
DeploymentPredictionEnvironmentUpdate
{
"properties": {
"dpsDeploymentId": {
"description": "The ID of the deployment on dedicated prediction environment that will be updated to serverless.",
"type": "string"
},
"serverlessPredictionEnvironmentId": {
"description": "The ID of serverless prediction environment.",
"type": "string"
}
},
"required": [
"dpsDeploymentId",
"serverlessPredictionEnvironmentId"
],
"type": "object",
"x-versionadded": "v2.38"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dpsDeploymentId |
string |
true |
|
The ID of the deployment on dedicated prediction environment that will be updated to serverless. |
| serverlessPredictionEnvironmentId |
string |
true |
|
The ID of serverless prediction environment. |
DeploymentPredictionUsageResponse
{
"description": "Prediction usage of the deployment.",
"properties": {
"dailyRates": {
"description": "Number of predictions made in the last 7 days.",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Timestamp of the last prediction request.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"serverErrorRates": {
"description": "Number of server errors (5xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
},
"userErrorRates": {
"description": "Number of user errors (4xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
}
},
"required": [
"dailyRates",
"lastTimestamp",
"serverErrorRates",
"userErrorRates"
],
"type": "object"
}
Prediction usage of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dailyRates |
[integer] |
true |
|
Number of predictions made in the last 7 days. |
| lastTimestamp |
string,null(date-time) |
true |
|
Timestamp of the last prediction request. |
| serverErrorRates |
[integer] |
true |
maxItems: 7
|
Number of server errors (5xx) in the last 7 days. |
| userErrorRates |
[integer] |
true |
maxItems: 7
|
Number of user errors (4xx) in the last 7 days. |
DeploymentRetrieveResponse
{
"properties": {
"accuracyHealth": {
"description": "Accuracy health of the deployment.",
"properties": {
"endDate": {
"description": "End date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of accuracy health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Accuracy health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"createdAt": {
"description": "The date and time of when the deployment was created, in ISO 8601 format.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.20"
},
"creator": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"defaultPredictionServer": {
"description": "The prediction server associated with the deployment.",
"properties": {
"datarobot-key": {
"description": "The `datarobot-key` header used in requests to this prediction server.",
"type": "string"
},
"id": {
"description": "ID of the prediction server for the deployment.",
"type": [
"string",
"null"
]
},
"url": {
"description": "URL of the prediction server.",
"type": "string"
}
},
"required": [
"datarobot-key",
"id",
"url"
],
"type": "object"
},
"description": {
"description": "Description of the deployment.",
"type": [
"string",
"null"
]
},
"governance": {
"description": "Deployment governance info.",
"properties": {
"approvalStatus": {
"description": "Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.",
"enum": [
"PENDING",
"APPROVED"
],
"type": "string"
},
"hasOpenedChangeRequests": {
"description": "If there are change request related to this deployment with `PENDING` status.",
"type": "boolean"
},
"reviewers": {
"description": "A list of reviewers to approve deployment change requests.",
"items": {
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"maxItems": 20,
"type": "array",
"x-versionadded": "v2.37"
}
},
"required": [
"approvalStatus",
"hasOpenedChangeRequests"
],
"type": "object"
},
"hasError": {
"description": "Whether the deployment is not operational because it failed to start properly.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "Label of the deployment.",
"maxLength": 512,
"type": "string"
},
"model": {
"description": "Information related to the current model of the deployment.",
"properties": {
"buildEnvironmentType": {
"description": "Build environment type of the current model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"customModelImage": {
"description": "Information related to the custom model image of the deployment.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": "string"
},
"customModelName": {
"description": "Name of the custom model.",
"type": "string"
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": "string"
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": "string"
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": "string"
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": "string"
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": "string"
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": "string"
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object"
},
"deployedAt": {
"description": "Timestamp of when current model was deployed.",
"format": "date-time",
"type": [
"string",
"null"
],
"x-versionadded": "v2.21"
},
"id": {
"description": "ID of the current model.",
"type": "string"
},
"isDeprecated": {
"description": "Whether the current model is deprecated model. eg. python2 based model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"projectId": {
"description": "Project ID of the current model.",
"type": [
"string",
"null"
]
},
"projectName": {
"description": "Project name of the current model.",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Target name of the current model.",
"type": "string"
},
"targetType": {
"description": "Target type of the current model.",
"type": "string"
},
"type": {
"description": "Type of the current model.",
"type": "string"
},
"unstructuredModelKind": {
"description": "Whether the current model is an unstructured model.",
"type": "boolean",
"x-versionadded": "v2.29"
},
"unsupervisedMode": {
"description": "Whether the current model's project is unsupervised.",
"type": "boolean",
"x-versionadded": "v2.18"
},
"unsupervisedType": {
"description": "Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.",
"enum": [
"anomaly",
"clustering"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.23"
}
},
"required": [
"id",
"isDeprecated",
"projectName",
"targetType",
"type",
"unstructuredModelKind",
"unsupervisedMode"
],
"type": "object"
},
"modelHealth": {
"description": "Model health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "A message providing more detail on the status.",
"type": "string"
},
"startDate": {
"description": "Start date of model health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Model health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelPackage": {
"description": "Information related to the current ModelPackage.",
"properties": {
"id": {
"description": "ID of the ModelPackage.",
"type": "string"
},
"name": {
"description": "Name of the ModelPackage.",
"type": "string"
},
"registeredModelId": {
"description": "The ID of the associated registered model",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"registeredModelId"
],
"type": "object"
},
"modelPackageInitialDownload": {
"description": "If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time model package was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"openedChangeRequests": {
"description": "An array of the change request IDs related to this deployment that have.",
"items": {
"type": "string"
},
"type": "array"
},
"owners": {
"description": "Count and preview of owners of the deployment.",
"properties": {
"count": {
"description": "Total count of owners.",
"type": "integer"
},
"preview": {
"description": "A list of owner objects.",
"items": {
"description": "Creator of the deployment.",
"properties": {
"email": {
"description": "Email address of the owner.",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of the owner.",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the owner.",
"type": "string"
},
"lastName": {
"description": "Last name of the owner.",
"type": [
"string",
"null"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"count",
"preview"
],
"type": "object"
},
"permissions": {
"description": "Permissions that the user making the request has on the deployment.",
"items": {
"enum": [
"CAN_ADD_CHALLENGERS",
"CAN_APPROVE_REPLACEMENT_MODEL",
"CAN_BE_MANAGED_BY_MLOPS_AGENT",
"CAN_DELETE_CHALLENGERS",
"CAN_DELETE_DEPLOYMENT",
"CAN_DOWNLOAD_DOCUMENTATION",
"CAN_EDIT_CHALLENGERS",
"CAN_EDIT_DEPLOYMENT",
"CAN_GENERATE_DOCUMENTATION",
"CAN_MAKE_PREDICTIONS",
"CAN_REPLACE_MODEL",
"CAN_SCORE_CHALLENGERS",
"CAN_SHARE",
"CAN_SHARE_DEPLOYMENT_OWNERSHIP",
"CAN_SUBMIT_ACTUALS",
"CAN_UPDATE_DEPLOYMENT_THRESHOLDS",
"CAN_VIEW"
],
"type": "string"
},
"type": "array",
"x-versionadded": "v2.18"
},
"predictionEnvironment": {
"description": "Information related to the current PredictionEnvironment.",
"properties": {
"id": {
"description": "ID of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"isManagedByManagementAgent": {
"description": "True if PredictionEnvironment is using Management Agent.",
"type": "boolean"
},
"name": {
"description": "Name of the PredictionEnvironment.",
"type": "string"
},
"platform": {
"description": "Platform of the PredictionEnvironment.",
"enum": [
"aws",
"gcp",
"azure",
"onPremise",
"datarobot",
"datarobotServerless",
"openShift",
"other",
"snowflake",
"sapAiCore"
],
"type": "string"
},
"plugin": {
"description": "Plugin name of the PredictionEnvironment.",
"type": [
"string",
"null"
]
},
"supportedModelFormats": {
"description": "Model formats that the PredictionEnvironment supports.",
"items": {
"enum": [
"datarobot",
"datarobotScoringCode",
"customModel",
"externalModel"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"isManagedByManagementAgent",
"name",
"platform"
],
"type": "object"
},
"predictionUsage": {
"description": "Prediction usage of the deployment.",
"properties": {
"dailyRates": {
"description": "Number of predictions made in the last 7 days.",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Timestamp of the last prediction request.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"serverErrorRates": {
"description": "Number of server errors (5xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
},
"userErrorRates": {
"description": "Number of user errors (4xx) in the last 7 days.",
"items": {
"type": "integer"
},
"maxItems": 7,
"type": "array",
"x-versionadded": "v2.39"
}
},
"required": [
"dailyRates",
"lastTimestamp",
"serverErrorRates",
"userErrorRates"
],
"type": "object"
},
"scoringCodeInitialDownload": {
"description": "If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time scoring code was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Service health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model service period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "Start date of service health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Service health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"startDate",
"status"
],
"type": "object"
},
"settings": {
"description": "Settings of the deployment.",
"properties": {
"batchMonitoringEnabled": {
"description": "if batch monitoring is enabled.",
"type": "boolean"
},
"humbleAiEnabled": {
"description": "if humble ai is enabled.",
"type": "boolean"
},
"predictionIntervalsEnabled": {
"description": "If prediction intervals are enabled.",
"type": "boolean"
},
"predictionWarningEnabled": {
"description": "If prediction warning is enabled.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "Displays current deployment status.",
"enum": [
"active",
"archived",
"errored",
"inactive",
"launching",
"replacingModel",
"stopping"
],
"type": "string",
"x-versionadded": "v2.22"
},
"tags": {
"description": "The list of formatted deployment tags.",
"items": {
"properties": {
"id": {
"description": "The ID of the tag.",
"type": "string"
},
"name": {
"description": "The name of the tag.",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value of the tag.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"id",
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"userProvidedId": {
"description": "A user-provided unique ID associated with a deployment definition in a remote git repository.",
"maxLength": 100,
"type": "string",
"x-versionadded": "v2.29"
}
},
"required": [
"accuracyHealth",
"createdAt",
"defaultPredictionServer",
"description",
"id",
"label",
"model",
"modelHealth",
"permissions",
"predictionUsage",
"serviceHealth",
"settings",
"status",
"tags"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| accuracyHealth |
DeploymentAccuracyHealthResponse |
true |
|
Accuracy health of the deployment. |
| approvalStatus |
string |
false |
|
Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response. |
| createdAt |
string(date-time) |
true |
|
The date and time of when the deployment was created, in ISO 8601 format. |
| creator |
DeploymentOwnerResponse |
false |
|
Creator of the deployment. |
| defaultPredictionServer |
DeploymentDefaultPredictionServerResponse |
true |
|
The prediction server associated with the deployment. |
| description |
string,null |
true |
|
Description of the deployment. |
| governance |
DeploymentGovernanceResponse |
false |
|
Deployment governance info. |
| hasError |
boolean |
false |
|
Whether the deployment is not operational because it failed to start properly. |
| id |
string |
true |
|
The ID of the deployment. |
| importance |
string |
false |
|
Shows how important this deployment is. |
| label |
string |
true |
maxLength: 512
|
Label of the deployment. |
| model |
DeploymentModelResponse |
true |
|
Information related to the current model of the deployment. |
| modelHealth |
DeploymentModelHealthResponse |
true |
|
Model health of the deployment. |
| modelPackage |
DeploymentModelPackageResponse |
false |
|
Information related to the current ModelPackage. |
| modelPackageInitialDownload |
DeploymentModelPackageInitialDownloadResponse |
false |
|
If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded. |
| openedChangeRequests |
[string] |
false |
|
An array of the change request IDs related to this deployment that have. |
| owners |
DeploymentOwnersResponse |
false |
|
Count and preview of owners of the deployment. |
| permissions |
[string] |
true |
|
Permissions that the user making the request has on the deployment. |
| predictionEnvironment |
DeploymentPredictionEnvironmentResponse |
false |
|
Information related to the current PredictionEnvironment. |
| predictionUsage |
DeploymentPredictionUsageResponse |
true |
|
Prediction usage of the deployment. |
| scoringCodeInitialDownload |
DeploymentScoringCodeInitialDownloadResponse |
false |
|
If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded. |
| serviceHealth |
DeploymentServiceHealthResponse |
true |
|
Service health of the deployment. |
| settings |
DeploymentSettingsInfo |
true |
|
Settings of the deployment. |
| status |
string |
true |
|
Displays current deployment status. |
| tags |
[DeploymentTagRetrieveResponse] |
true |
|
The list of formatted deployment tags. |
| userProvidedId |
string |
false |
maxLength: 100
|
A user-provided unique ID associated with a deployment definition in a remote git repository. |
Enumerated Values
| Property |
Value |
| approvalStatus |
[PENDING, APPROVED] |
| importance |
[CRITICAL, HIGH, MODERATE, LOW] |
| status |
[active, archived, errored, inactive, launching, replacingModel, stopping] |
DeploymentReviewerResponse
{
"properties": {
"email": {
"description": "The email address of the reviewer.",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full name of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"id": {
"description": "The ID of the reviewer.",
"type": "string"
},
"status": {
"description": "The latest review status.",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
],
"type": [
"string",
"null"
]
},
"userhash": {
"description": "Reviewer's gravatar hash.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"username": {
"description": "The username of the reviewer.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"email",
"id",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| email |
string,null |
true |
|
The email address of the reviewer. |
| fullName |
string,null |
false |
|
The full name of the reviewer. |
| id |
string |
true |
|
The ID of the reviewer. |
| status |
string,null |
true |
|
The latest review status. |
| userhash |
string,null |
false |
|
Reviewer's gravatar hash. |
| username |
string,null |
false |
|
The username of the reviewer. |
Enumerated Values
| Property |
Value |
| status |
[APPROVED, CHANGES_REQUESTED, COMMENTED] |
DeploymentScoringCodeInitialDownloadResponse
{
"description": "If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.",
"properties": {
"timestamp": {
"description": "Timestamp of the first time scoring code was downloaded.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"timestamp"
],
"type": "object"
}
If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| timestamp |
string,null(date-time) |
true |
|
Timestamp of the first time scoring code was downloaded. |
DeploymentServiceHealthResponse
{
"description": "Service health of the deployment.",
"properties": {
"endDate": {
"description": "End date of model service period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "Start date of service health period.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Service health status.",
"enum": [
"failing",
"notStarted",
"passing",
"unavailable",
"unknown",
"warning"
],
"type": "string"
}
},
"required": [
"endDate",
"startDate",
"status"
],
"type": "object"
}
Service health of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| endDate |
string,null(date-time) |
true |
|
End date of model service period. |
| startDate |
string,null(date-time) |
true |
|
Start date of service health period. |
| status |
string |
true |
|
Service health status. |
Enumerated Values
| Property |
Value |
| status |
[failing, notStarted, passing, unavailable, unknown, warning] |
DeploymentSettingsInfo
{
"description": "Settings of the deployment.",
"properties": {
"batchMonitoringEnabled": {
"description": "if batch monitoring is enabled.",
"type": "boolean"
},
"humbleAiEnabled": {
"description": "if humble ai is enabled.",
"type": "boolean"
},
"predictionIntervalsEnabled": {
"description": "If prediction intervals are enabled.",
"type": "boolean"
},
"predictionWarningEnabled": {
"description": "If prediction warning is enabled.",
"type": "boolean"
}
},
"type": "object"
}
Settings of the deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| batchMonitoringEnabled |
boolean |
false |
|
if batch monitoring is enabled. |
| humbleAiEnabled |
boolean |
false |
|
if humble ai is enabled. |
| predictionIntervalsEnabled |
boolean |
false |
|
If prediction intervals are enabled. |
| predictionWarningEnabled |
boolean |
false |
|
If prediction warning is enabled. |
DeploymentStatusUpdate
{
"properties": {
"status": {
"description": "Status that deployment should be transition in.",
"enum": [
"active",
"inactive"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| status |
string |
true |
|
Status that deployment should be transition in. |
Enumerated Values
| Property |
Value |
| status |
[active, inactive] |
DeploymentTagRetrieveResponse
{
"properties": {
"id": {
"description": "The ID of the tag.",
"type": "string"
},
"name": {
"description": "The name of the tag.",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value of the tag.",
"maxLength": 50,
"type": "string"
}
},
"required": [
"id",
"name",
"value"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the tag. |
| name |
string |
true |
maxLength: 50
|
The name of the tag. |
| value |
string |
true |
maxLength: 50
|
The value of the tag. |
DeploymentUpdate
{
"properties": {
"description": {
"description": "A description for the deployment.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"importance": {
"description": "Shows how important this deployment is.",
"enum": [
"CRITICAL",
"HIGH",
"MODERATE",
"LOW"
],
"type": "string",
"x-versionadded": "v2.21"
},
"label": {
"description": "A human-readable name for the deployment.",
"maxLength": 512,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| description |
string,null |
false |
maxLength: 10000
|
A description for the deployment. |
| importance |
string |
false |
|
Shows how important this deployment is. |
| label |
string,null |
false |
maxLength: 512
|
A human-readable name for the deployment. |
Enumerated Values
| Property |
Value |
| importance |
[CRITICAL, HIGH, MODERATE, LOW] |
DeploymentsScoringCodeBuildPayload
{
"properties": {
"includeAgent": {
"description": "Whether the Scoring Code built will include tracking agent",
"type": "boolean"
},
"includePredictionExplanations": {
"description": "Whether the Scoring Code built will include prediction explanations",
"type": "boolean"
},
"includePredictionIntervals": {
"description": "Whether the Scoring Code built will include prediction intervals",
"type": "boolean"
}
},
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| includeAgent |
boolean |
false |
|
Whether the Scoring Code built will include tracking agent |
| includePredictionExplanations |
boolean |
false |
|
Whether the Scoring Code built will include prediction explanations |
| includePredictionIntervals |
boolean |
false |
|
Whether the Scoring Code built will include prediction intervals |
ExecutionEnvironmentShortResponse
{
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
Execution environment associated with this deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the execution environment. |
| name |
string |
true |
|
User-friendly name of the execution environment. |
ExecutionEnvironmentVersionShortResponse
{
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
}
Execution environment version associated with this deployment.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of the execution environment version. |
| label |
string |
true |
|
User-friendly name of the execution environment version. |
Feature
{
"properties": {
"dateFormat": {
"description": "The date format string for how this feature was interpreted.",
"type": [
"string",
"null"
]
},
"featureType": {
"description": "Feature type.",
"type": [
"string",
"null"
]
},
"importance": {
"description": "Numeric measure of the relationship strength between the feature and target (independent of model or other features).",
"type": [
"number",
"null"
]
},
"knownInAdvance": {
"description": "Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.",
"type": "boolean"
},
"name": {
"description": "Feature name.",
"type": "string"
}
},
"required": [
"dateFormat",
"featureType",
"importance",
"knownInAdvance",
"name"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| dateFormat |
string,null |
true |
|
The date format string for how this feature was interpreted. |
| featureType |
string,null |
true |
|
Feature type. |
| importance |
number,null |
true |
|
Numeric measure of the relationship strength between the feature and target (independent of model or other features). |
| knownInAdvance |
boolean |
true |
|
Whether the feature was selected as known in advance in a time-series model, false for non-time-series models. |
| name |
string |
true |
|
Feature name. |
FeatureListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "An array of features.",
"items": {
"properties": {
"dateFormat": {
"description": "The date format string for how this feature was interpreted.",
"type": [
"string",
"null"
]
},
"featureType": {
"description": "Feature type.",
"type": [
"string",
"null"
]
},
"importance": {
"description": "Numeric measure of the relationship strength between the feature and target (independent of model or other features).",
"type": [
"number",
"null"
]
},
"knownInAdvance": {
"description": "Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.",
"type": "boolean"
},
"name": {
"description": "Feature name.",
"type": "string"
}
},
"required": [
"dateFormat",
"featureType",
"importance",
"knownInAdvance",
"name"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.35"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[Feature] |
true |
|
An array of features. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
KeyValuePair
{
"properties": {
"key": {
"description": "The key, a unique identifier for this item of metadata",
"maxLength": 50,
"type": "string"
},
"value": {
"description": "The value, the actual content for this item of metadata",
"maxLength": 256,
"type": "string"
}
},
"required": [
"key",
"value"
],
"type": "object",
"x-versionadded": "v2.37"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| key |
string |
true |
maxLength: 50
|
The key, a unique identifier for this item of metadata |
| value |
string |
true |
maxLength: 256
|
The value, the actual content for this item of metadata |
ModelHistoryListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "History of deployment's champion models, including the current champion model.",
"items": {
"properties": {
"customModelImage": {
"description": "Contains information about the custom model image.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": [
"string",
"null"
]
},
"customModelName": {
"description": "Name of the custom model.",
"type": [
"string",
"null"
]
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": [
"string",
"null"
]
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": [
"string",
"null"
]
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object",
"x-versionadded": "v2.36"
},
"endDate": {
"description": "The timestamp when the model is replaced by another model.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastEndDate": {
"description": "The max timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastStartDate": {
"description": "The min timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"modelPackage": {
"description": "Contains information about the model package.",
"properties": {
"id": {
"description": "ID of the model package.",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "ID of the model.",
"type": "string"
},
"name": {
"description": "Name of the model package.",
"type": [
"string",
"null"
]
},
"predictionThreshold": {
"description": "The threshold value used for binary classification prediction.",
"type": [
"number",
"null"
]
},
"projectId": {
"description": "ID of the project.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the associated registered model.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"modelId",
"name",
"predictionThreshold",
"registeredModelId"
],
"type": "object",
"x-versionadded": "v2.36"
},
"predictionWarningBoundaries": {
"description": "Lower and upper boundaries for outlier detection.",
"properties": {
"lower": {
"description": "Lower boundary for outlier detection.",
"type": "number"
},
"upper": {
"description": "Upper boundary for outlier detection.",
"type": "number"
}
},
"required": [
"lower",
"upper"
],
"type": "object",
"x-versionadded": "v2.36"
},
"replacementReason": {
"description": "Reason for model replacement.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The timestamp when the model becomes champion of the deployment.",
"format": "date-time",
"type": "string"
}
},
"required": [
"endDate",
"forecastEndDate",
"forecastStartDate",
"modelPackage",
"replacementReason",
"startDate"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[ModelHistoryResponse] |
true |
maxItems: 100
|
History of deployment's champion models, including the current champion model. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
ModelHistoryResponse
{
"properties": {
"customModelImage": {
"description": "Contains information about the custom model image.",
"properties": {
"customModelId": {
"description": "ID of the custom model.",
"type": [
"string",
"null"
]
},
"customModelName": {
"description": "Name of the custom model.",
"type": [
"string",
"null"
]
},
"customModelVersionId": {
"description": "ID of the custom model version.",
"type": [
"string",
"null"
]
},
"customModelVersionLabel": {
"description": "Label of the custom model version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentId": {
"description": "ID of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentName": {
"description": "Name of the execution environment.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionId": {
"description": "ID of the execution environment version.",
"type": [
"string",
"null"
]
},
"executionEnvironmentVersionLabel": {
"description": "Label of the execution environment version.",
"type": [
"string",
"null"
]
}
},
"required": [
"customModelId",
"customModelName",
"customModelVersionId",
"customModelVersionLabel",
"executionEnvironmentId",
"executionEnvironmentName",
"executionEnvironmentVersionId",
"executionEnvironmentVersionLabel"
],
"type": "object",
"x-versionadded": "v2.36"
},
"endDate": {
"description": "The timestamp when the model is replaced by another model.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastEndDate": {
"description": "The max timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"forecastStartDate": {
"description": "The min timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"modelPackage": {
"description": "Contains information about the model package.",
"properties": {
"id": {
"description": "ID of the model package.",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "ID of the model.",
"type": "string"
},
"name": {
"description": "Name of the model package.",
"type": [
"string",
"null"
]
},
"predictionThreshold": {
"description": "The threshold value used for binary classification prediction.",
"type": [
"number",
"null"
]
},
"projectId": {
"description": "ID of the project.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the associated registered model.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"modelId",
"name",
"predictionThreshold",
"registeredModelId"
],
"type": "object",
"x-versionadded": "v2.36"
},
"predictionWarningBoundaries": {
"description": "Lower and upper boundaries for outlier detection.",
"properties": {
"lower": {
"description": "Lower boundary for outlier detection.",
"type": "number"
},
"upper": {
"description": "Upper boundary for outlier detection.",
"type": "number"
}
},
"required": [
"lower",
"upper"
],
"type": "object",
"x-versionadded": "v2.36"
},
"replacementReason": {
"description": "Reason for model replacement.",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The timestamp when the model becomes champion of the deployment.",
"format": "date-time",
"type": "string"
}
},
"required": [
"endDate",
"forecastEndDate",
"forecastStartDate",
"modelPackage",
"replacementReason",
"startDate"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| customModelImage |
CustomModelImage |
false |
|
Contains information about the custom model image. |
| endDate |
string,null(date-time) |
true |
|
The timestamp when the model is replaced by another model. |
| forecastEndDate |
string,null(date-time) |
true |
|
The max timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled. |
| forecastStartDate |
string,null(date-time) |
true |
|
The min timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled. |
| modelPackage |
ModelPackageObject |
true |
|
Contains information about the model package. |
| predictionWarningBoundaries |
ModelPackagePredictionThresholdWarning |
false |
|
Lower and upper boundaries for outlier detection. |
| replacementReason |
string,null |
true |
|
Reason for model replacement. |
| startDate |
string(date-time) |
true |
|
The timestamp when the model becomes champion of the deployment. |
ModelPackageObject
{
"description": "Contains information about the model package.",
"properties": {
"id": {
"description": "ID of the model package.",
"type": [
"string",
"null"
]
},
"modelId": {
"description": "ID of the model.",
"type": "string"
},
"name": {
"description": "Name of the model package.",
"type": [
"string",
"null"
]
},
"predictionThreshold": {
"description": "The threshold value used for binary classification prediction.",
"type": [
"number",
"null"
]
},
"projectId": {
"description": "ID of the project.",
"type": "string"
},
"registeredModelId": {
"description": "ID of the associated registered model.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"modelId",
"name",
"predictionThreshold",
"registeredModelId"
],
"type": "object",
"x-versionadded": "v2.36"
}
Contains information about the model package.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string,null |
true |
|
ID of the model package. |
| modelId |
string |
true |
|
ID of the model. |
| name |
string,null |
true |
|
Name of the model package. |
| predictionThreshold |
number,null |
true |
|
The threshold value used for binary classification prediction. |
| projectId |
string |
false |
|
ID of the project. |
| registeredModelId |
string,null |
true |
|
ID of the associated registered model. |
ModelPackagePredictionThresholdWarning
{
"description": "Lower and upper boundaries for outlier detection.",
"properties": {
"lower": {
"description": "Lower boundary for outlier detection.",
"type": "number"
},
"upper": {
"description": "Upper boundary for outlier detection.",
"type": "number"
}
},
"required": [
"lower",
"upper"
],
"type": "object",
"x-versionadded": "v2.36"
}
Lower and upper boundaries for outlier detection.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| lower |
number |
true |
|
Lower boundary for outlier detection. |
| upper |
number |
true |
|
Upper boundary for outlier detection. |
{
"properties": {
"baseImageId": {
"description": "Internal base image entity id for troubleshooting purposes",
"type": "string"
},
"created": {
"description": "ISO formatted image upload date",
"format": "date-time",
"type": "string"
},
"datarobotRuntimeImageTag": {
"description": "For internal use only.",
"type": [
"string",
"null"
]
},
"dockerImageId": {
"description": "A Docker image id (immutable, content-based) hash associated with the given image",
"type": "string"
},
"filename": {
"description": "The name of the file when the download requested",
"type": "string"
},
"hash": {
"description": "Hash of the image content, supposed to be used for verifying content after the download. The algorithm used for hashing is specified in `hashAlgorithm` field. Note that hash is calculated over compressed image data.",
"type": "string"
},
"hashAlgorithm": {
"description": "An algorithm name used for calculating content `hash`",
"enum": [
"SHA256"
],
"type": "string"
},
"imageSize": {
"description": "Size in bytes of the compressed PPS image data",
"type": "integer"
},
"shortDockerImageId": {
"description": "A 12-chars shortened version of the `dockerImageId` as shown in 'docker images' command line command output",
"type": "string"
}
},
"required": [
"baseImageId",
"created",
"dockerImageId",
"filename",
"hash",
"hashAlgorithm",
"imageSize",
"shortDockerImageId"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baseImageId |
string |
true |
|
Internal base image entity id for troubleshooting purposes |
| created |
string(date-time) |
true |
|
ISO formatted image upload date |
| datarobotRuntimeImageTag |
string,null |
false |
|
For internal use only. |
| dockerImageId |
string |
true |
|
A Docker image id (immutable, content-based) hash associated with the given image |
| filename |
string |
true |
|
The name of the file when the download requested |
| hash |
string |
true |
|
Hash of the image content, supposed to be used for verifying content after the download. The algorithm used for hashing is specified in hashAlgorithm field. Note that hash is calculated over compressed image data. |
| hashAlgorithm |
string |
true |
|
An algorithm name used for calculating content hash |
| imageSize |
integer |
true |
|
Size in bytes of the compressed PPS image data |
| shortDockerImageId |
string |
true |
|
A 12-chars shortened version of the dockerImageId as shown in 'docker images' command line command output |
Enumerated Values
| Property |
Value |
| hashAlgorithm |
SHA256 |
ResourceRequestBundleListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.35"
},
"data": {
"description": "List of bundles.",
"items": {
"properties": {
"cpuCount": {
"description": "Max number of CPUs available.",
"type": "number"
},
"description": {
"description": "A short description of CPU, Memory and other resources.",
"type": "string"
},
"gpuCount": {
"description": "Max number of GPUs available.",
"type": [
"number",
"null"
]
},
"gpuMaker": {
"description": "The manufacture of the GPU.",
"enum": [
"nvidia",
"amd",
"intel"
],
"type": [
"string",
"null"
]
},
"gpuMemoryBytes": {
"description": "Max amount of GPU memory available.",
"type": "integer",
"x-versionadded": "v2.36"
},
"hasGpu": {
"description": "If this bundle provides at least one GPU resource.",
"type": "boolean"
},
"id": {
"description": "The id of the bundle.",
"type": "string"
},
"isDefault": {
"description": "If this should be the default resource choice.",
"type": "boolean"
},
"isDeleted": {
"description": "If the bundle has been deleted and should not be used.",
"type": "boolean"
},
"memoryBytes": {
"description": "Max amount of memory available.",
"type": "integer"
},
"name": {
"description": "A short name for the bundle.",
"type": "string"
},
"useCases": {
"description": "List of use cases this bundle supports.",
"items": {
"enum": [
"customApplication",
"customJob",
"customModel",
"modelingMachineWorker",
"predictionAPI",
"sapAICore",
"sparkApplication"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"cpuCount",
"description",
"gpuMemoryBytes",
"hasGpu",
"id",
"memoryBytes",
"name",
"useCases"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.35"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.35"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.35"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
Number of items returned on this page. |
| data |
[ResourceRequestBundleResponse] |
true |
maxItems: 100
|
List of bundles. |
| next |
string,null(uri) |
true |
|
URL pointing to the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
URL pointing to the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
ResourceRequestBundleResponse
{
"properties": {
"cpuCount": {
"description": "Max number of CPUs available.",
"type": "number"
},
"description": {
"description": "A short description of CPU, Memory and other resources.",
"type": "string"
},
"gpuCount": {
"description": "Max number of GPUs available.",
"type": [
"number",
"null"
]
},
"gpuMaker": {
"description": "The manufacture of the GPU.",
"enum": [
"nvidia",
"amd",
"intel"
],
"type": [
"string",
"null"
]
},
"gpuMemoryBytes": {
"description": "Max amount of GPU memory available.",
"type": "integer",
"x-versionadded": "v2.36"
},
"hasGpu": {
"description": "If this bundle provides at least one GPU resource.",
"type": "boolean"
},
"id": {
"description": "The id of the bundle.",
"type": "string"
},
"isDefault": {
"description": "If this should be the default resource choice.",
"type": "boolean"
},
"isDeleted": {
"description": "If the bundle has been deleted and should not be used.",
"type": "boolean"
},
"memoryBytes": {
"description": "Max amount of memory available.",
"type": "integer"
},
"name": {
"description": "A short name for the bundle.",
"type": "string"
},
"useCases": {
"description": "List of use cases this bundle supports.",
"items": {
"enum": [
"customApplication",
"customJob",
"customModel",
"modelingMachineWorker",
"predictionAPI",
"sapAICore",
"sparkApplication"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"cpuCount",
"description",
"gpuMemoryBytes",
"hasGpu",
"id",
"memoryBytes",
"name",
"useCases"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| cpuCount |
number |
true |
|
Max number of CPUs available. |
| description |
string |
true |
|
A short description of CPU, Memory and other resources. |
| gpuCount |
number,null |
false |
|
Max number of GPUs available. |
| gpuMaker |
string,null |
false |
|
The manufacture of the GPU. |
| gpuMemoryBytes |
integer |
true |
|
Max amount of GPU memory available. |
| hasGpu |
boolean |
true |
|
If this bundle provides at least one GPU resource. |
| id |
string |
true |
|
The id of the bundle. |
| isDefault |
boolean |
false |
|
If this should be the default resource choice. |
| isDeleted |
boolean |
false |
|
If the bundle has been deleted and should not be used. |
| memoryBytes |
integer |
true |
|
Max amount of memory available. |
| name |
string |
true |
|
A short name for the bundle. |
| useCases |
[string] |
true |
|
List of use cases this bundle supports. |
Enumerated Values
| Property |
Value |
| gpuMaker |
[nvidia, amd, intel] |
ScheduledReportOnDemmand
{
"properties": {
"id": {
"description": "ID of Scheduled report record.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
ID of Scheduled report record. |
SharingListResponse
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"canShare": {
"description": "Whether the recipient can share the role further.",
"type": "boolean"
},
"role": {
"description": "The role of the user on this entity.",
"type": "string"
},
"userId": {
"description": "The identifier of the user that has access to this entity.",
"type": "string"
},
"username": {
"description": "The username of the user that has access to the entity.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
true |
|
The number of items returned. |
| data |
[AccessControl] |
true |
maxItems: 1000
|
The access control list. |
| next |
string,null |
true |
|
URL pointing to the next page. |
| previous |
string,null |
true |
|
URL pointing to the previous page. |
SharingUpdateOrRemoveWithGrant
{
"properties": {
"data": {
"description": "List of sharing roles to update.",
"items": {
"properties": {
"canShare": {
"default": true,
"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.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| data |
[UserRoleWithGrant] |
true |
maxItems: 100
|
List of sharing roles to update. |
SingleDeploymentSetting
{
"properties": {
"hint": {
"description": "An optional hint for the setting.",
"maxLength": 255,
"type": [
"string",
"null"
]
},
"label": {
"description": "A descriptive label for the setting.",
"maxLength": 80,
"type": "string"
},
"setting": {
"description": "The identifier of the setting.",
"enum": [
"deploymentName",
"DeploymentName",
"DEPLOYMENT_NAME",
"settingsDataDrift",
"SettingsDataDrift",
"SETTINGS_DATA_DRIFT",
"settingsAccuracy",
"SettingsAccuracy",
"SETTINGS_ACCURACY",
"settingsFairness",
"SettingsFairness",
"SETTINGS_FAIRNESS",
"settingsCustomMetrics",
"SettingsCustomMetrics",
"SETTINGS_CUSTOM_METRICS",
"settingsHumility",
"SettingsHumility",
"SETTINGS_HUMILITY",
"settingsChallengers",
"SettingsChallengers",
"SETTINGS_CHALLENGERS",
"settingsPredictions",
"SettingsPredictions",
"SETTINGS_PREDICTIONS",
"settingsRetraining",
"SettingsRetraining",
"SETTINGS_RETRAINING",
"settingsUsage",
"SettingsUsage",
"SETTINGS_USAGE",
"settingsDataExploration",
"SettingsDataExploration",
"SETTINGS_DATA_EXPLORATION",
"settingsNotifications",
"SettingsNotifications",
"SETTINGS_NOTIFICATIONS"
],
"type": "string"
},
"status": {
"description": "Indicates the completion status of the setting.",
"enum": [
"notSet",
"NotSet",
"NOT_SET",
"partial",
"Partial",
"PARTIAL",
"configured",
"Configured",
"CONFIGURED"
],
"type": "string"
}
},
"required": [
"hint",
"label",
"setting",
"status"
],
"type": "object",
"x-versionadded": "v2.38"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| hint |
string,null |
true |
maxLength: 255
|
An optional hint for the setting. |
| label |
string |
true |
maxLength: 80
|
A descriptive label for the setting. |
| setting |
string |
true |
|
The identifier of the setting. |
| status |
string |
true |
|
Indicates the completion status of the setting. |
Enumerated Values
| Property |
Value |
| setting |
[deploymentName, DeploymentName, DEPLOYMENT_NAME, settingsDataDrift, SettingsDataDrift, SETTINGS_DATA_DRIFT, settingsAccuracy, SettingsAccuracy, SETTINGS_ACCURACY, settingsFairness, SettingsFairness, SETTINGS_FAIRNESS, settingsCustomMetrics, SettingsCustomMetrics, SETTINGS_CUSTOM_METRICS, settingsHumility, SettingsHumility, SETTINGS_HUMILITY, settingsChallengers, SettingsChallengers, SETTINGS_CHALLENGERS, settingsPredictions, SettingsPredictions, SETTINGS_PREDICTIONS, settingsRetraining, SettingsRetraining, SETTINGS_RETRAINING, settingsUsage, SettingsUsage, SETTINGS_USAGE, settingsDataExploration, SettingsDataExploration, SETTINGS_DATA_EXPLORATION, settingsNotifications, SettingsNotifications, SETTINGS_NOTIFICATIONS] |
| status |
[notSet, NotSet, NOT_SET, partial, Partial, PARTIAL, configured, Configured, CONFIGURED] |
UserRoleWithGrant
{
"properties": {
"canShare": {
"default": true,
"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.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| canShare |
boolean |
false |
|
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 |
string,null |
true |
|
The role to set on the entity. When it is None, the role of this user will be removedfrom this entity. |
| username |
string |
true |
|
Username of the user to update the access role for. |
Enumerated Values
| Property |
Value |
| role |
[ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |