DataRobot API resources > API reference documentation > DataRobot REST API > Deployments > Deployment management

Deployment Management¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Deployment Management.

GET /api/v2/customModelDeployments/¶

List of model deployments for user sorted by creation time descending.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/customModelDeployments/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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¶


{
  "count": 0,
  "data": [
    {
      "customModel": {
        "id": "string",
        "name": "string"
      },
      "customModelImageId": "string",
      "customModelVersion": {
        "id": "string",
        "label": "string"
      },
      "deployed": "string",
      "deployedBy": "string",
      "executionEnvironment": {
        "id": "string",
        "name": "string"
      },
      "executionEnvironmentVersion": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "imageType": "customModelImage",
      "label": "string",
      "status": "active",
      "testingStatus": "not_tested"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	OK.	CustomModelDeploymentListResponse
400	Bad Request	Query parameters are invalid.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelDeployments/{deploymentId}/logs/¶

Retrieve the logs generated during deployment of the custom model.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/customModelDeployments/{deploymentId}/logs/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	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

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		Contains an auto generated filename of the log file ("attachment;filename=deployment-.log").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModelDeployments/{deploymentId}/logs/¶

Request logs from a custom deployed model.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/customModelDeployments/{deploymentId}/logs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the custom model deployment.

Example responses¶


{
  "statusId": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Accepted: request placed to a queue for processing.	CustomModelAsyncOperationResponse
404	Not Found	Deployment not found or model is not a Custom Model.	None
422	Unprocessable Entity	Deployed model is not a Custom Model.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL for tracking async job status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelDeployments/{deploymentId}/logs/{logId}/¶

Retrieve the logs generated during predictions on the deployed custom model.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/customModelDeployments/{deploymentId}/logs/{logId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the custom model deployment.
logId	path	string	true	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

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		Contains an auto generated filename of the log file ("attachment;filename=deployment-.log").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deletedDeployments/¶

List deleted deployments.Only available as part of an enterprise (on-prem) installation. Requires a CAN_DELETE_APP_PROJECTS permission to execute.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deletedDeployments/?offset=0&limit=20 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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¶


{
  "count": 0,
  "data": [
    {
      "deletedAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "label": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The deleted deployments	DeletedDeploymentListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/deletedDeployments/¶

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.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/deletedDeployments/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{DeploymentPermanentDelete}'

Body parameter¶


{
  "action": "PermanentlyErase",
  "deploymentIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DeploymentPermanentDelete	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Job submitted. See Location header.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL for tracking deployment permanently erase job status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/¶

List deployments a user can view.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/?offset=0&limit=20 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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¶


{
  "count": 0,
  "data": [
    {
      "accuracyHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "message": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "approvalStatus": "PENDING",
      "createdAt": "2019-08-24T14:15:22Z",
      "defaultPredictionServer": {
        "datarobot-key": "string",
        "id": "string",
        "url": "string"
      },
      "description": "string",
      "governance": {
        "approvalStatus": "PENDING",
        "hasOpenedChangeRequests": true
      },
      "hasError": true,
      "id": "string",
      "importance": "CRITICAL",
      "label": "string",
      "model": {
        "buildEnvironmentType": "string",
        "customModelImage": {
          "customModelId": "string",
          "customModelName": "string",
          "customModelVersionId": "string",
          "customModelVersionLabel": "string",
          "executionEnvironmentId": "string",
          "executionEnvironmentName": "string",
          "executionEnvironmentVersionId": "string",
          "executionEnvironmentVersionLabel": "string"
        },
        "deployedAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "isDeprecated": true,
        "projectId": "string",
        "projectName": "string",
        "targetName": "string",
        "targetType": "string",
        "type": "string",
        "unstructuredModelKind": true,
        "unsupervisedMode": true,
        "unsupervisedType": "anomaly"
      },
      "modelHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "message": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "modelPackage": {
        "id": "string",
        "name": "string",
        "registeredModelId": "string"
      },
      "modelPackageInitialDownload": {
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "openedChangeRequests": [
        "string"
      ],
      "owners": {
        "count": 0,
        "preview": [
          {
            "email": "string",
            "firstName": "string",
            "id": "string",
            "lastName": "string"
          }
        ]
      },
      "permissions": [
        "CAN_ADD_CHALLENGERS"
      ],
      "predictionEnvironment": {
        "id": "string",
        "isManagedByManagementAgent": true,
        "name": "string",
        "platform": "aws",
        "plugin": "string",
        "supportedModelFormats": [
          "datarobot"
        ]
      },
      "predictionUsage": {
        "dailyRates": [
          0
        ],
        "lastTimestamp": "2019-08-24T14:15:22Z"
      },
      "scoringCodeInitialDownload": {
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "serviceHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "settings": {
        "batchMonitoringEnabled": true,
        "humbleAiEnabled": true,
        "predictionIntervalsEnabled": true,
        "predictionWarningEnabled": true
      },
      "status": "active",
      "tags": [
        {
          "id": "string",
          "name": "string",
          "value": "string"
        }
      ],
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The deployments	DeploymentListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/deployments/fromLearningModel/¶

Create a deployment from a DataRobot model.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/deployments/fromLearningModel/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{DeploymentCreateFromLearningModel}'

Body parameter¶


{
  "defaultPredictionServerId": "string",
  "description": null,
  "grantInitialDeploymentRolesFromProject": true,
  "importance": "CRITICAL",
  "label": "string",
  "modelId": "string",
  "predictionThreshold": 1,
  "status": "active"
}

Parameters

Name	In	Type	Required	Description
body	body	DeploymentCreateFromLearningModel	false	none

Example responses¶


{
  "id": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Deployment successfully created.	DeploymentCreateResponse
403	Forbidden	User does not have permission to create a deployment.	None
409	Conflict	User's organization has reached the maximum number of deployments.	None
422	Unprocessable Entity	Unable to process the deployment creation request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/deployments/{deploymentId}/¶

Delete a deployment.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
  -H "Authorization: Bearer {access-token}"

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¶

Status	Meaning	Description	Schema
204	No Content	Deployment successfully deleted.	None
422	Unprocessable Entity	Unable to process the request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/¶

Retrieve a deployment.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶


{
  "accuracyHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "approvalStatus": "PENDING",
  "createdAt": "2019-08-24T14:15:22Z",
  "defaultPredictionServer": {
    "datarobot-key": "string",
    "id": "string",
    "url": "string"
  },
  "description": "string",
  "governance": {
    "approvalStatus": "PENDING",
    "hasOpenedChangeRequests": true
  },
  "hasError": true,
  "id": "string",
  "importance": "CRITICAL",
  "label": "string",
  "model": {
    "buildEnvironmentType": "string",
    "customModelImage": {
      "customModelId": "string",
      "customModelName": "string",
      "customModelVersionId": "string",
      "customModelVersionLabel": "string",
      "executionEnvironmentId": "string",
      "executionEnvironmentName": "string",
      "executionEnvironmentVersionId": "string",
      "executionEnvironmentVersionLabel": "string"
    },
    "deployedAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "isDeprecated": true,
    "projectId": "string",
    "projectName": "string",
    "targetName": "string",
    "targetType": "string",
    "type": "string",
    "unstructuredModelKind": true,
    "unsupervisedMode": true,
    "unsupervisedType": "anomaly"
  },
  "modelHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "modelPackage": {
    "id": "string",
    "name": "string",
    "registeredModelId": "string"
  },
  "modelPackageInitialDownload": {
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "openedChangeRequests": [
    "string"
  ],
  "owners": {
    "count": 0,
    "preview": [
      {
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string"
      }
    ]
  },
  "permissions": [
    "CAN_ADD_CHALLENGERS"
  ],
  "predictionEnvironment": {
    "id": "string",
    "isManagedByManagementAgent": true,
    "name": "string",
    "platform": "aws",
    "plugin": "string",
    "supportedModelFormats": [
      "datarobot"
    ]
  },
  "predictionUsage": {
    "dailyRates": [
      0
    ],
    "lastTimestamp": "2019-08-24T14:15:22Z"
  },
  "scoringCodeInitialDownload": {
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "serviceHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "settings": {
    "batchMonitoringEnabled": true,
    "humbleAiEnabled": true,
    "predictionIntervalsEnabled": true,
    "predictionWarningEnabled": true
  },
  "status": "active",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "userProvidedId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The deployment	DeploymentRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/¶

Update a deployment's label and description.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "description": "string",
  "importance": "CRITICAL",
  "label": "string"
}

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

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/capabilities/¶

Retrieve the capabilities for the deployment.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/capabilities/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶


{
  "data": [
    {
      "messages": [
        "string"
      ],
      "name": "string",
      "supported": true
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	DeploymentCapabilitiesRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/features/¶

Retrieve features contained within the universe dataset associated with a specific deployment. By default, this returns all raw features required for predictions.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/features/?offset=0&limit=50 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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¶


{
  "count": 0,
  "data": [
    {
      "dateFormat": "string",
      "featureType": "string",
      "importance": 0,
      "knownInAdvance": true,
      "name": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The deployment's features	FeatureListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/modelHistory/¶

Retrieve champion model history of deployment.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/modelHistory/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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¶


{
  "count": 0,
  "data": [
    {
      "customModelImage": {
        "customModelId": "string",
        "customModelName": "string",
        "customModelVersionId": "string",
        "customModelVersionLabel": "string",
        "executionEnvironmentId": "string",
        "executionEnvironmentName": "string",
        "executionEnvironmentVersionId": "string",
        "executionEnvironmentVersionLabel": "string"
      },
      "endDate": "2019-08-24T14:15:22Z",
      "forecastEndDate": "2019-08-24T14:15:22Z",
      "forecastStartDate": "2019-08-24T14:15:22Z",
      "modelPackage": {
        "id": "string",
        "modelId": "string",
        "name": "string",
        "predictionThreshold": 0,
        "projectId": "string",
        "registeredModelId": "string"
      },
      "predictionWarningBoundaries": {
        "lower": 0,
        "upper": 0
      },
      "replacementReason": "string",
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of deployment model history.	ModelHistoryListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/deployments/{deploymentId}/onDemandReports/¶

Add report to execution queue.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/onDemandReports/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "id": "string"
}

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

Response Headers¶

Status	Header	Type	Format	Description
200	Location	string		URL to poll to track report generation has finished.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/scoringCode/¶

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.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/scoringCode/ \
  -H "Authorization: Bearer {access-token}"

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

Response Headers¶

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

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/deployments/{deploymentId}/scoringCodeBuilds/¶

Build Java package containing Scoring Code with agent integration.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/scoringCodeBuilds/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "includeAgent": true,
  "includePredictionExplanations": true,
  "includePredictionIntervals": true
}

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	Unique identifier of the deployment.
body	body	DeploymentsScoringCodeBuildPayload	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/status/¶

Change deployment status.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/status/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "status": "active"
}

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

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL for tracking async job status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/mlops/compute/bundles/¶

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.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/mlops/compute/bundles/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
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
useCases	[`customApplication`, `customJob`, `customModel`, `sapAICore`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "cpuCount": 0,
      "description": "string",
      "gpuCount": 0,
      "gpuMaker": "nvidia",
      "gpuMemoryBytes": 0,
      "hasGpu": true,
      "id": "string",
      "isDefault": true,
      "isDeleted": true,
      "memoryBytes": 0,
      "name": "string",
      "useCases": [
        "customApplication"
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of resource bundle metadata.	ResourceRequestBundleListResponse
403	Forbidden	Resource bundles are not enabled.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/mlops/compute/bundles/{resourceRequestBundleId}/¶

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.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/mlops/compute/bundles/{resourceRequestBundleId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
resourceRequestBundleId	path	string	true	ID of the bundle.

Example responses¶


{
  "cpuCount": 0,
  "description": "string",
  "gpuCount": 0,
  "gpuMaker": "nvidia",
  "gpuMemoryBytes": 0,
  "hasGpu": true,
  "id": "string",
  "isDefault": true,
  "isDeleted": true,
  "memoryBytes": 0,
  "name": "string",
  "useCases": [
    "customApplication"
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Resource bundle	ResourceRequestBundleResponse
403	Forbidden	Resource bundles are not enabled or the user does not have access to specified bundle.	None
404	Not Found	Resource bundle does not exist.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/mlops/portablePredictionServerImage/¶

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.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/mlops/portablePredictionServerImage/ \
  -H "Authorization: Bearer {access-token}"

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

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/mlops/portablePredictionServerImage/metadata/¶

Fetches currently active PPS Docker image metadata

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/mlops/portablePredictionServerImage/metadata/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses¶


{
  "baseImageId": "string",
  "created": "2019-08-24T14:15:22Z",
  "datarobotRuntimeImageTag": "string",
  "dockerImageId": "string",
  "filename": "string",
  "hash": "string",
  "hashAlgorithm": "SHA256",
  "imageSize": 0,
  "shortDockerImageId": "string"
}

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

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

CustomModelAsyncOperationResponse


{
  "statusId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
statusId	string	true		ID that can be used with GET /api/v2/status/{statusId}/ to poll for the testing job's status

CustomModelDeploymentListResponse


{
  "count": 0,
  "data": [
    {
      "customModel": {
        "id": "string",
        "name": "string"
      },
      "customModelImageId": "string",
      "customModelVersion": {
        "id": "string",
        "label": "string"
      },
      "deployed": "string",
      "deployedBy": "string",
      "executionEnvironment": {
        "id": "string",
        "name": "string"
      },
      "executionEnvironmentVersion": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "imageType": "customModelImage",
      "label": "string",
      "status": "active",
      "testingStatus": "not_tested"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

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


{
  "customModel": {
    "id": "string",
    "name": "string"
  },
  "customModelImageId": "string",
  "customModelVersion": {
    "id": "string",
    "label": "string"
  },
  "deployed": "string",
  "deployedBy": "string",
  "executionEnvironment": {
    "id": "string",
    "name": "string"
  },
  "executionEnvironmentVersion": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "imageType": "customModelImage",
  "label": "string",
  "status": "active",
  "testingStatus": "not_tested"
}

Properties¶

Name	Type	Required	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


{
  "customModelId": "string",
  "customModelName": "string",
  "customModelVersionId": "string",
  "customModelVersionLabel": "string",
  "executionEnvironmentId": "string",
  "executionEnvironmentName": "string",
  "executionEnvironmentVersionId": "string",
  "executionEnvironmentVersionLabel": "string"
}

Contains information about the custom model image.

Properties¶

Name	Type	Required	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


{
  "id": "string",
  "name": "string"
}

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


{
  "id": "string",
  "label": "string"
}

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


{
  "count": 0,
  "data": [
    {
      "deletedAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "label": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties¶

Name	Type	Required	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


{
  "deletedAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "label": "string"
}

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


{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "failing"
}

Accuracy health of the deployment.

Properties¶

Name	Type	Required	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


{
  "data": [
    {
      "messages": [
        "string"
      ],
      "name": "string",
      "supported": true
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[DeploymentCapability]	true		List of all capabilities.

DeploymentCapability


{
  "messages": [
    "string"
  ],
  "name": "string",
  "supported": true
}

Properties¶

Name	Type	Required	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.

DeploymentCreateFromLearningModel


{
  "defaultPredictionServerId": "string",
  "description": null,
  "grantInitialDeploymentRolesFromProject": true,
  "importance": "CRITICAL",
  "label": "string",
  "modelId": "string",
  "predictionThreshold": 1,
  "status": "active"
}

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`]

DeploymentCreateResponse


{
  "id": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		The ID of the created deployment.

DeploymentDefaultPredictionServerResponse


{
  "datarobot-key": "string",
  "id": "string",
  "url": "string"
}

The prediction server associated with the deployment.

Properties¶

Name	Type	Required	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


{
  "approvalStatus": "PENDING",
  "hasOpenedChangeRequests": true
}

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.

Enumerated Values¶

Property	Value
approvalStatus	[`PENDING`, `APPROVED`]

DeploymentListResponse


{
  "count": 0,
  "data": [
    {
      "accuracyHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "message": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "approvalStatus": "PENDING",
      "createdAt": "2019-08-24T14:15:22Z",
      "defaultPredictionServer": {
        "datarobot-key": "string",
        "id": "string",
        "url": "string"
      },
      "description": "string",
      "governance": {
        "approvalStatus": "PENDING",
        "hasOpenedChangeRequests": true
      },
      "hasError": true,
      "id": "string",
      "importance": "CRITICAL",
      "label": "string",
      "model": {
        "buildEnvironmentType": "string",
        "customModelImage": {
          "customModelId": "string",
          "customModelName": "string",
          "customModelVersionId": "string",
          "customModelVersionLabel": "string",
          "executionEnvironmentId": "string",
          "executionEnvironmentName": "string",
          "executionEnvironmentVersionId": "string",
          "executionEnvironmentVersionLabel": "string"
        },
        "deployedAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "isDeprecated": true,
        "projectId": "string",
        "projectName": "string",
        "targetName": "string",
        "targetType": "string",
        "type": "string",
        "unstructuredModelKind": true,
        "unsupervisedMode": true,
        "unsupervisedType": "anomaly"
      },
      "modelHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "message": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "modelPackage": {
        "id": "string",
        "name": "string",
        "registeredModelId": "string"
      },
      "modelPackageInitialDownload": {
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "openedChangeRequests": [
        "string"
      ],
      "owners": {
        "count": 0,
        "preview": [
          {
            "email": "string",
            "firstName": "string",
            "id": "string",
            "lastName": "string"
          }
        ]
      },
      "permissions": [
        "CAN_ADD_CHALLENGERS"
      ],
      "predictionEnvironment": {
        "id": "string",
        "isManagedByManagementAgent": true,
        "name": "string",
        "platform": "aws",
        "plugin": "string",
        "supportedModelFormats": [
          "datarobot"
        ]
      },
      "predictionUsage": {
        "dailyRates": [
          0
        ],
        "lastTimestamp": "2019-08-24T14:15:22Z"
      },
      "scoringCodeInitialDownload": {
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "serviceHealth": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z",
        "status": "failing"
      },
      "settings": {
        "batchMonitoringEnabled": true,
        "humbleAiEnabled": true,
        "predictionIntervalsEnabled": true,
        "predictionWarningEnabled": true
      },
      "status": "active",
      "tags": [
        {
          "id": "string",
          "name": "string",
          "value": "string"
        }
      ],
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	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


{
  "customModelId": "string",
  "customModelName": "string",
  "customModelVersionId": "string",
  "customModelVersionLabel": "string",
  "executionEnvironmentId": "string",
  "executionEnvironmentName": "string",
  "executionEnvironmentVersionId": "string",
  "executionEnvironmentVersionLabel": "string"
}

Information related to the custom model image of the deployment.

Properties¶

Name	Type	Required	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


{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "failing"
}

Model health of the deployment.

Properties¶

Name	Type	Required	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


{
  "timestamp": "2019-08-24T14:15:22Z"
}

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


{
  "id": "string",
  "name": "string",
  "registeredModelId": "string"
}

Information related to the current ModelPackage.

Properties¶

Name	Type	Required	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


{
  "buildEnvironmentType": "string",
  "customModelImage": {
    "customModelId": "string",
    "customModelName": "string",
    "customModelVersionId": "string",
    "customModelVersionLabel": "string",
    "executionEnvironmentId": "string",
    "executionEnvironmentName": "string",
    "executionEnvironmentVersionId": "string",
    "executionEnvironmentVersionLabel": "string"
  },
  "deployedAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "isDeprecated": true,
  "projectId": "string",
  "projectName": "string",
  "targetName": "string",
  "targetType": "string",
  "type": "string",
  "unstructuredModelKind": true,
  "unsupervisedMode": true,
  "unsupervisedType": "anomaly"
}

Information related to the current model of the deployment.

Properties¶

Name	Type	Required	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


{
  "email": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string"
}

Properties¶

Name	Type	Required	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


{
  "count": 0,
  "preview": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string"
    }
  ]
}

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


{
  "action": "PermanentlyErase",
  "deploymentIds": [
    "string"
  ]
}

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


{
  "id": "string",
  "isManagedByManagementAgent": true,
  "name": "string",
  "platform": "aws",
  "plugin": "string",
  "supportedModelFormats": [
    "datarobot"
  ]
}

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`]

DeploymentPredictionUsageResponse


{
  "dailyRates": [
    0
  ],
  "lastTimestamp": "2019-08-24T14:15:22Z"
}

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.

DeploymentRetrieveResponse


{
  "accuracyHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "approvalStatus": "PENDING",
  "createdAt": "2019-08-24T14:15:22Z",
  "defaultPredictionServer": {
    "datarobot-key": "string",
    "id": "string",
    "url": "string"
  },
  "description": "string",
  "governance": {
    "approvalStatus": "PENDING",
    "hasOpenedChangeRequests": true
  },
  "hasError": true,
  "id": "string",
  "importance": "CRITICAL",
  "label": "string",
  "model": {
    "buildEnvironmentType": "string",
    "customModelImage": {
      "customModelId": "string",
      "customModelName": "string",
      "customModelVersionId": "string",
      "customModelVersionLabel": "string",
      "executionEnvironmentId": "string",
      "executionEnvironmentName": "string",
      "executionEnvironmentVersionId": "string",
      "executionEnvironmentVersionLabel": "string"
    },
    "deployedAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "isDeprecated": true,
    "projectId": "string",
    "projectName": "string",
    "targetName": "string",
    "targetType": "string",
    "type": "string",
    "unstructuredModelKind": true,
    "unsupervisedMode": true,
    "unsupervisedType": "anomaly"
  },
  "modelHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "modelPackage": {
    "id": "string",
    "name": "string",
    "registeredModelId": "string"
  },
  "modelPackageInitialDownload": {
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "openedChangeRequests": [
    "string"
  ],
  "owners": {
    "count": 0,
    "preview": [
      {
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string"
      }
    ]
  },
  "permissions": [
    "CAN_ADD_CHALLENGERS"
  ],
  "predictionEnvironment": {
    "id": "string",
    "isManagedByManagementAgent": true,
    "name": "string",
    "platform": "aws",
    "plugin": "string",
    "supportedModelFormats": [
      "datarobot"
    ]
  },
  "predictionUsage": {
    "dailyRates": [
      0
    ],
    "lastTimestamp": "2019-08-24T14:15:22Z"
  },
  "scoringCodeInitialDownload": {
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "serviceHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "failing"
  },
  "settings": {
    "batchMonitoringEnabled": true,
    "humbleAiEnabled": true,
    "predictionIntervalsEnabled": true,
    "predictionWarningEnabled": true
  },
  "status": "active",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "userProvidedId": "string"
}

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

DeploymentScoringCodeInitialDownloadResponse


{
  "timestamp": "2019-08-24T14:15:22Z"
}

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


{
  "endDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "failing"
}

Service health of the deployment.

Properties¶

Name	Type	Required	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


{
  "batchMonitoringEnabled": true,
  "humbleAiEnabled": true,
  "predictionIntervalsEnabled": true,
  "predictionWarningEnabled": true
}

Settings of the deployment.

Properties¶

Name	Type	Required	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


{
  "status": "active"
}

Properties¶

Name	Type	Required	Restrictions	Description
status	string	true		Status that deployment should be transition in.

Enumerated Values¶

Property	Value
status	[`active`, `inactive`]

DeploymentTagRetrieveResponse


{
  "id": "string",
  "name": "string",
  "value": "string"
}

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


{
  "description": "string",
  "importance": "CRITICAL",
  "label": "string"
}

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


{
  "includeAgent": true,
  "includePredictionExplanations": true,
  "includePredictionIntervals": true
}

Properties¶

Name	Type	Required	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


{
  "id": "string",
  "name": "string"
}

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


{
  "id": "string",
  "label": "string"
}

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


{
  "dateFormat": "string",
  "featureType": "string",
  "importance": 0,
  "knownInAdvance": true,
  "name": "string"
}

Properties¶

Name	Type	Required	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


{
  "count": 0,
  "data": [
    {
      "dateFormat": "string",
      "featureType": "string",
      "importance": 0,
      "knownInAdvance": true,
      "name": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	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.

ModelHistoryListResponse


{
  "count": 0,
  "data": [
    {
      "customModelImage": {
        "customModelId": "string",
        "customModelName": "string",
        "customModelVersionId": "string",
        "customModelVersionLabel": "string",
        "executionEnvironmentId": "string",
        "executionEnvironmentName": "string",
        "executionEnvironmentVersionId": "string",
        "executionEnvironmentVersionLabel": "string"
      },
      "endDate": "2019-08-24T14:15:22Z",
      "forecastEndDate": "2019-08-24T14:15:22Z",
      "forecastStartDate": "2019-08-24T14:15:22Z",
      "modelPackage": {
        "id": "string",
        "modelId": "string",
        "name": "string",
        "predictionThreshold": 0,
        "projectId": "string",
        "registeredModelId": "string"
      },
      "predictionWarningBoundaries": {
        "lower": 0,
        "upper": 0
      },
      "replacementReason": "string",
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

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


{
  "customModelImage": {
    "customModelId": "string",
    "customModelName": "string",
    "customModelVersionId": "string",
    "customModelVersionLabel": "string",
    "executionEnvironmentId": "string",
    "executionEnvironmentName": "string",
    "executionEnvironmentVersionId": "string",
    "executionEnvironmentVersionLabel": "string"
  },
  "endDate": "2019-08-24T14:15:22Z",
  "forecastEndDate": "2019-08-24T14:15:22Z",
  "forecastStartDate": "2019-08-24T14:15:22Z",
  "modelPackage": {
    "id": "string",
    "modelId": "string",
    "name": "string",
    "predictionThreshold": 0,
    "projectId": "string",
    "registeredModelId": "string"
  },
  "predictionWarningBoundaries": {
    "lower": 0,
    "upper": 0
  },
  "replacementReason": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	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


{
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionThreshold": 0,
  "projectId": "string",
  "registeredModelId": "string"
}

Contains information about the model package.

Properties¶

Name	Type	Required	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


{
  "lower": 0,
  "upper": 0
}

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.

PPSImageMetadataResponse


{
  "baseImageId": "string",
  "created": "2019-08-24T14:15:22Z",
  "datarobotRuntimeImageTag": "string",
  "dockerImageId": "string",
  "filename": "string",
  "hash": "string",
  "hashAlgorithm": "SHA256",
  "imageSize": 0,
  "shortDockerImageId": "string"
}

Properties¶

Name	Type	Required	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


{
  "count": 0,
  "data": [
    {
      "cpuCount": 0,
      "description": "string",
      "gpuCount": 0,
      "gpuMaker": "nvidia",
      "gpuMemoryBytes": 0,
      "hasGpu": true,
      "id": "string",
      "isDefault": true,
      "isDeleted": true,
      "memoryBytes": 0,
      "name": "string",
      "useCases": [
        "customApplication"
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

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


{
  "cpuCount": 0,
  "description": "string",
  "gpuCount": 0,
  "gpuMaker": "nvidia",
  "gpuMemoryBytes": 0,
  "hasGpu": true,
  "id": "string",
  "isDefault": true,
  "isDeleted": true,
  "memoryBytes": 0,
  "name": "string",
  "useCases": [
    "customApplication"
  ]
}

Properties¶

Name	Type	Required	Description
cpuCount	integer	true	Max number of CPUs available.
description	string	true	A short description of CPU, Memory and other resources.
gpuCount	integer,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


{
  "id": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		ID of Scheduled report record.