API keys and tools¶
DataRobot provides multiple developer tools for you to use when making prediction requests or engaging with the DataRobot API. The currently available tools are:
Click on your user icon and navigate to API keys and tools to access these features:
API key management¶
API keys are the preferred method for authenticating web requests to the DataRobot API and Prediction API; they replace the legacy API token method. You can simply post the API key into the request header, and the application requests you as a user. All DataRobot API endpoints use API keys as a mode of authentication.
Generating multiple API keys allows you to create a new key, update your existing integrations, and then revoke the old key all without disruption of service of your API calls. This also allows you to generate distinct keys for different integrations (script A using key A, script B using key B).
Note that if you were previously using an API token, that token has been upgraded to an API key. All existing integrations will continue to function as expected, both for the DataRobot API and the Prediction API.
Access API key management¶
You can register and manage—name, create, and delete—multiple API keys. To access this page, click on your user icon and navigate to the API keys and tools page.
The API Keys section lists your API keys with a variety of options available to you:
| Element | Description | |
|---|---|---|
| 1 | Search | Search the list of API keys by name or date created. |
| 2 | Key type | Toggle between tabs for the two kinds of API keys: API keys for personal use of the API and application API keys for use with custom applications. |
| 3 | Open documentation | Access multiple code-first resources: REST API documentation, Python client documentation, R documentation, and AI accelerators. |
| 4 | Copy | Copy a key to your clipboard (contents blurred out in this image) to paste elsewhere. |
| 5 | Create new key | Create a new API key. |
| 6 | Actions menu | Expand the actions menu to rename or delete an API key. |
Each individual key details the key name, the key value, the date it was created, and the time it was last used.
Application API keys¶
In addition to sharing custom applications, you may want to grant the ability for users to access and use data from within an application. An application API key grants an application the necessary access to the DataRobot Public API. Sharing roles grant control over the application as an entity within DataRobot, while application API keys grant control over the requests the app can make when a user accesses it. An application key is automatically created when you build a custom application. You can read more about configuring application API keys for custom applications.
Application API keys are listed in their own tab on the API keys and tools page.
| Field | Description |
|---|---|
| Name | The name of the application API key. |
| Key | The value of the API key. |
| Role | The scope of access the application has to the public API granted by the API key. |
| Connected application | The name of the custom application that the application API key belongs to. Click the link to access the application. |
| Data created | The date when the application API key was created. |
| Last used | The time elapsed since the last use of the application API key. |
| Expiration | The time remaining until the application API key expires. |
Allowed endpoints
The application is not granted complete access to the public API; the key grants access to a limited number of API endpoints for application usage. The list below shows all endpoints (and their child endpoints, e.g., /api/v2/projects/<project_id>/) the application can access.
- /api/v2/projects/
- /api/v2/calendars/
- /api/v2/status/
- /api/v2/credentials/associations/
/ - /api/v2/credentials/
/associations/ / - /api/v2/remoteRepositories/
- /api/v2/datasets/
- /api/v2/calendarCountryCodes/
- /api/v2/applications/
- /api/v2/automatedDocumentOptions/
- /api/v2/automatedDocuments/
- /api/v2/batchJobs/
- /api/v2/batchMonitoring/
- /api/v2/batchMonitoringJobDefinitions/
- /api/v2/batchPredictionJobDefinitions/
- /api/v2/batchPredictions/
- /api/v2/catalogItems/
- /api/v2/changeRequests/
- /api/v2/comments/
- /api/v2/customApplicationSources/
- /api/v2/customJobLimits/
- /api/v2/customJobs/
- /api/v2/customModelDeployments/
- /api/v2/customModelLimits/
- /api/v2/customModelTests/
- /api/v2/customTasks/
- /api/v2/customTrainingBlueprints/
- /api/v2/dataEngineQueryGenerators/
- /api/v2/dataEngineWorkspaceStates/
- /api/v2/dataSlices/
- /api/v2/deployments/
- /api/v2/executionEnvironments/
- /api/v2/externalDataSources/
- /api/v2/externalDataStores/
- /api/v2/guardConfigurations/
- /api/v2/guardTemplates/
- /api/v2/imageAugmentationLists/
- /api/v2/imageAugmentationOptions/
- /api/v2/insights/
- /api/v2/modelComplianceDocsInitializations/
- /api/v2/modelPackages/
- /api/v2/models/
- /api/v2/moderationSupportedLlms/
- /api/v2/multilabelInsights/
- /api/v2/ocrJobResources/
- /api/v2/overallModerationConfiguration/
- /api/v2/predictionServers/
- /api/v2/projectClones/
- /api/v2/recipes/
- /api/v2/registeredModels/
- /api/v2/relationshipsConfigurations/
- /api/v2/remoteEvents/
- /api/v2/scheduledJobs/
- /api/v2/stringEncryptions/
- /api/v2/useCases/
- /api/v2/useCasesWithShortenedInfo/
- /api/v2/userBlueprints/
- /api/v2/userBlueprintsBulkValidations/
- /api/v2/userBlueprintsInputTypes/
- /api/v2/userBlueprintsProjectBlueprints/
- /api/v2/userBlueprintsTaskParameters/
- /api/v2/userBlueprintsTasks/
- /api/v2/userBlueprintsValidations/
- /api/v2/version/
Create a new personal API key¶
Use the following instructions to create a personal API key.
-
Click your user icon in the top right corner and navigate to the API keys and tools page.
-
To generate a new key, click Create new key.
-
Name the new key, and click Create. This activates your new key, making it ready for use.
Delete an existing key¶
To delete an existing key, expand the actions menu for the key you wish to delete, then click Delete. This prompts a dialog box warning you about the impacts of deletion. Click Delete again to remove your key.
Monitoring agent tarball¶
DataRobot offers the monitoring agent as a solution for monitoring external models outside of DataRobot and reporting back statistics. To monitor a deployment of this kind, you must first implement the following software components, provided by DataRobot:
- MLOps library (available in Python, Java, and R)
- The monitoring agent
These components are part of an installer package available as a tarball in the DataRobot application.
Download the monitoring agent tarball¶
The monitoring agent tarball can be accessed from two locations: the API keys and tools section, and the Predictions > Monitoring tab for a deployment.
Click on your user icon and navigate to API keys and tools. Under the Management and monitoring agents header, click the download icon. Additional documentation for setting up the Agent is included in the tarball.
Note
You can also download the MLOps Python libraries from the public Python Package Index site. Download and install the DataRobot MLOps metrics reporting library and the DataRobot MLOps Connected Client. These pages include instructions for installing the libraries.
Portable Prediction Server Docker image¶
Availability information
The Portable Prediction Server image may not be available in some installations. Review the availability guidelines for more information.
Download the Portable Prediction Server Docker image from the API keys and tools page:
You can see some important information about the image:
| Element | Description | |
|---|---|---|
| 1 | Image name | The name of the image archive file that will be downloaded. |
| 2 | Image creation date | The date that the image was built. |
| 3 | File size | The size of the compressed image to be downloaded. Be aware that the uncompressed image size can exceed 12GB. |
| 4 | Docker Image ID |
A shortened version of the Docker Image ID, as displayed by the docker images command. It is content-based so that regardless of the image tag, this value will remain the same. Use it to compare versions with the image you are currently running. |
| 5 | Hash | Hash algorithm and content hash sum. Use to check file integrity after download (see example below). Currently SHA256 is used as a hash algorithm. |
Click the download icon and wait for the file to download. Due to image size, download times may take minutes (or even hours) depending on your network speed. Once the download completes, check the file integrity using its hash sum. For example, on Linux:
sha256sum datarobot-portable-prediction-api-7.0.0-r1736.tar.gz
5bafef491c3575180894855164b08efaffdec845491678131a45f1646db5a99d datarobot-portable-prediction-api-7.0.0-r1736.tar.gz
If the checksum matches the value displayed in the image information (Hash value (5), above), the image was downloaded successfully and can be safely loaded to Docker.