Predictions Info¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the Predictions Info.
GET /api/v2/predictionServers/¶
List prediction servers available for a user.
Code samples¶
curl -X GET https://app.datarobot.com/api/v2/predictionServers/ \
-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. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"batchPredictions": {
"processing": 0,
"queued": 0
},
"datarobot-key": "string",
"id": "string",
"url": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PredictionServerListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
BatchPredictionStatus
{
"processing": 0,
"queued": 0
}
Batch Prediction status for this instance
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| processing | integer | true | minimum: 0 |
Number of jobs processing |
| queued | integer | true | minimum: 0 |
Number of jobs queued |
PredictionServerListResponse
{
"count": 0,
"data": [
{
"batchPredictions": {
"processing": 0,
"queued": 0
},
"datarobot-key": "string",
"id": "string",
"url": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [PredictionServerResponse] | true | List of prediction servers. | |
| 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). |
PredictionServerResponse
{
"batchPredictions": {
"processing": 0,
"queued": 0
},
"datarobot-key": "string",
"id": "string",
"url": "string"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchPredictions | BatchPredictionStatus | true | Batch Prediction status for this instance | |
| datarobot-key | string,null | true | The datarobot-key header used in requests to this prediction server. |
|
| id | string,null | true | ID of the prediction server. | |
| url | string | true | URL of the prediction server. |