Skip to content
No result to preview.

Click in-app to access the full platform documentation for your version of DataRobot.

DataRobot API resources > API reference documentation > DataRobot REST API > Infrastructure

Infrastructure

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

GET /api/v2/clusterLicense/

Retrieve the information about the currently deployed cluster license.

Code samples

# You can also use wget
curl -X GET http://10.97.88.31/api/v2/clusterLicense/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "licenseInfo": {
    "concurrentWorkersCount": 0,
    "expirationTimestamp": "string",
    "expired": true,
    "featureFlags": {
      "property1": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      },
      "property2": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      }
    },
    "maxDeploymentLimit": 0,
    "maximumActiveUsers": 0,
    "prepaidDeploymentLimit": 0
  },
  "uploadInfo": {
    "uploadTimestamp": "string",
    "uploaderUserId": "string",
    "uploaderUsername": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none ClusterLicenseRetrieveResponse

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

BearerAuth

PUT /api/v2/clusterLicense/

Create or replace the cluster license.

Code samples

# You can also use wget
curl -X PUT http://10.97.88.31/api/v2/clusterLicense/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "licenseKey": "string"
}

Parameters

Name In Type Required Description
body body ClusterLicenseUpdate false none

Responses

Status Meaning Description Schema
200 OK none None
422 Unprocessable Entity License is invalid or has expired. None

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

BearerAuth

POST /api/v2/clusterLicenseValidation/

Check if a cluster license is valid.

Code samples

# You can also use wget
curl -X POST http://10.97.88.31/api/v2/clusterLicenseValidation/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "licenseKey": "string"
}

Parameters

Name In Type Required Description
body body ClusterLicenseUpdate false none

Example responses

200 Response

{
  "licenseInfo": {
    "concurrentWorkersCount": 0,
    "expirationTimestamp": "string",
    "expired": true,
    "featureFlags": {
      "property1": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      },
      "property2": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      }
    },
    "maxDeploymentLimit": 0,
    "maximumActiveUsers": 0,
    "prepaidDeploymentLimit": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none ClusterLicenseValidationResponse
422 Unprocessable Entity License is invalid or has expired. None

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

BearerAuth

GET /api/v2/version/

Provides the version information for the current version of the API.

Code samples

# You can also use wget
curl -X GET http://10.97.88.31/api/v2/version/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "major": 0,
  "minor": 0,
  "versionString": "string"
}

Responses

Status Meaning Description Schema
200 OK none VersionRetrieveResponse

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

BearerAuth

Schemas

ClusterLicenseRetrieveResponse

{
  "licenseInfo": {
    "concurrentWorkersCount": 0,
    "expirationTimestamp": "string",
    "expired": true,
    "featureFlags": {
      "property1": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      },
      "property2": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      }
    },
    "maxDeploymentLimit": 0,
    "maximumActiveUsers": 0,
    "prepaidDeploymentLimit": 0
  },
  "uploadInfo": {
    "uploadTimestamp": "string",
    "uploaderUserId": "string",
    "uploaderUsername": "string"
  }
}

Properties

Name Type Required Restrictions Description
licenseInfo ClusterLicenseRetrieveResponseLicense true The license info object will describe detailed information about the deployed license
uploadInfo ClusterLicenseRetrieveResponseUploadInfo true The upload info object will describe detailed information about the user who uploaded the current license

ClusterLicenseRetrieveResponseLicense

{
  "concurrentWorkersCount": 0,
  "expirationTimestamp": "string",
  "expired": true,
  "featureFlags": {
    "property1": {
      "uiLabel": "string",
      "uiTooltip": "string",
      "value": true
    },
    "property2": {
      "uiLabel": "string",
      "uiTooltip": "string",
      "value": true
    }
  },
  "maxDeploymentLimit": 0,
  "maximumActiveUsers": 0,
  "prepaidDeploymentLimit": 0
}

Properties

Name Type Required Restrictions Description
concurrentWorkersCount integer true minimum: 0
 The number of allowed simultaneously running jobs(concurrent workers)
expirationTimestamp string true The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z
expired boolean true A value indicating whether the license has already expired
featureFlags object true An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.
» additionalProperties FeatureFlagObject false none
maxDeploymentLimit integer true minimum: 0
 The number of maximum deployments limit (0: unlimited)
maximumActiveUsers integer true minimum: 0
 The number of maximum active users allowed in the system(0: unlimited
prepaidDeploymentLimit integer true minimum: 0
 The number of prepaid deployments limit (0: unlimited)

ClusterLicenseRetrieveResponseUploadInfo

{
  "uploadTimestamp": "string",
  "uploaderUserId": "string",
  "uploaderUsername": "string"
}

Properties

Name Type Required Restrictions Description
uploadTimestamp string true the time when the current license was uploaded in UTC ISO format, ex. '2020-12-21T23:59:59.000000Z'
uploaderUserId string true Id of the user who uploaded the current license
uploaderUsername string true The username of the user who uploaded the current license

ClusterLicenseUpdate

{
  "licenseKey": "string"
}

Properties

Name Type Required Restrictions Description
licenseKey string true The license key provided by customer support

ClusterLicenseValidationResponse

{
  "licenseInfo": {
    "concurrentWorkersCount": 0,
    "expirationTimestamp": "string",
    "expired": true,
    "featureFlags": {
      "property1": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      },
      "property2": {
        "uiLabel": "string",
        "uiTooltip": "string",
        "value": true
      }
    },
    "maxDeploymentLimit": 0,
    "maximumActiveUsers": 0,
    "prepaidDeploymentLimit": 0
  }
}

Properties

Name Type Required Restrictions Description
licenseInfo ClusterLicenseRetrieveResponseLicense true The license info object will describe detailed information about the deployed license

FeatureFlagObject

{
  "uiLabel": "string",
  "uiTooltip": "string",
  "value": true
}

Properties

Name Type Required Restrictions Description
uiLabel string false String representation of the feature flag
uiTooltip string false Detailed description of the feature flag
value boolean true Value of the feature flag

VersionRetrieveResponse

{
  "major": 0,
  "minor": 0,
  "versionString": "string"
}

Properties

Name Type Required Restrictions Description
major integer true The major version number.
minor integer true The minor version number.
versionString string true The full version string.
Updated September 19, 2023
Back to top