Deployment Info¶

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

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

Example responses¶

200 Response

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

Responses¶

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

Enumerated Values¶

Example responses¶

200 Response

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

Responses¶

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

Responses¶

Response Headers¶

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

Enumerated Values¶

Responses¶

Response Headers¶

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

Responses¶

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

Responses¶

Response Headers¶

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

BearerAuth

Schemas¶

DeploymentCapabilitiesRetrieveResponse

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

Properties¶

DeploymentCapability

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

Properties¶

DeploymentStatusUpdate

{
  "status": "active"
}

Properties¶

Enumerated Values¶

DeploymentsScoringCodeBuildPayload

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

Properties¶

Feature

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

Properties¶

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¶

ScheduledReportOnDemmand

{
  "id": "string"
}

Properties¶