---
title: REST API changelog
description: Reference the changes introduced to new versions of DataRobot's REST API.

---

# REST API changelog {: #rest-api-changelog }

Reference the changes introduced to new versions of DataRobot's REST API.

## DataRobot REST API v2.32 {: #datarobot-rest-api-v232 }

### New features {: #new-features }

- New routes to retrieve document thumbnail insights:
    - `GET /api/v2/projects/(projectId)/documentThumbnails/`
    - `GET /api/v2/projects/(projectId)/documentPages/(documentPageId)/file/`
    - `GET /api/v2/projects/(projectId)/documentThumbnailSamples/`
    - `GET /api/v2/projects/(projectId)/documentThumbnailBins/`
- New routes to compute and retrieve document text extraction sample insights:
    - `POST /api/v2/models/(modelId)/documentTextExtractionSamples/`
    - `GET /api/v2/projects/(projectId)/documentTextExtractionSamples/`
    - `GET /api/v2/models/(modelId)/documentTextExtractionSampleDocuments/`
    - `GET /api/v2/models/(modelId)/documentTextExtractionSamplePages/`
- New routes to retrieve document data quality information:
    - `GET /api/v2/projects/(projectId)/documentsDataQualityLog/`
    - `GET /api/v2/datasets/(datasetId)/documentsDataQualityLog/`
    - `GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/documentsDataQualityLog/`
- New routes to retrieve document data quality information as log files:
    - `GET /api/v2/projects/(projectId)/documentsDataQualityLog/file/`
    - `GET /api/v2/datasets/(datasetId)/documentsDataQualityLog/file/`,
    - `GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/documentsDataQualityLog/file/`
- New route to retrieve deployment predictions vs actuals over time:
    - `GET /api/v2/deployments/(deploymentId)/predictionsVsActualsOverTime/`
- New routes to managed registered models and registered model versions(previously known as Model Packages):
    - `GET /api/v2/registeredModels/`
    - `GET /api/v2/registeredModels/(registeredModelId)/`
    - `PATCH /api/v2/registeredModels/(registeredModelId)/`
    - `DELETE /api/v2/registeredModels/(registeredModelId)/`
    - `GET /api/v2/registeredModels/(registeredModelId)/versions/`
    - `GET /api/v2/registeredModels/(registeredModelId)/versions/(versionId)/`
    - `PATCH /api/v2/registeredModels/(registeredModelId)/sharedRoles/`
    - `GET /api/v2/registeredModels/(registeredModelId)/sharedRoles/`
    - `GET /api/v2/registeredModels/(registeredModelId)/deployments/`
    - `GET /api/v2/registeredModels/(registeredModelId)/versions/(versionId)/deployments/`
- Added new routes for Use Cases, listed below:
    - `GET /api/v2/useCases/`
    - `POST /api/v2/useCases/`
    - `GET /api/v2/useCases/(useCaseId)/`
    - `PATCH /api/v2/useCases/(useCaseId)/`
    - `DELETE /api/v2/useCases/(useCaseId)/`
    - `GET /api/v2/useCases/(useCaseId)/projects/`
    - `GET /api/v2/useCases/(useCaseId)/applications/`
    - `GET /api/v2/useCases/(useCaseId)/datasets/`
    - `GET /api/v2/useCases/(useCaseId)/notebooks/`
    - `GET /api/v2/useCases/(useCaseId)/playgrounds/`
    - `GET /api/v2/useCases/(useCaseId)/vectorDatabases/`
    - `GET /api/v2/useCases/(useCaseId)/modelsForComparison/`
    - `GET /api/v2/useCases/(useCaseId)/filterMetadata/`
    - `GET /api/v2/useCases/(useCaseId)/resources/`
    - `GET /api/v2/useCases/(useCaseId)/sharedRoles/`
    - `PATCH /api/v2/useCases/(useCaseId)/sharedRoles/`
    - `POST /api/v2/useCases/(useCaseId)/(referenceCollectionType)/(entityId)/`
    - `DELETE /api/v2/useCases/(useCaseId)/(referenceCollectionType)/(entityId)/`

### API changes {: #api-changes }

- The following endpoints for managing Use Cases have been removed in favor of new `GET /api/v2/valueTrackers/` endpoints:
    - `POST /api/v2/useCases/`
    - `GET /api/v2/useCases/`
    - `GET /api/v2/useCases/(useCaseId)/`
    - `PATCH /api/v2/useCases/(useCaseId)/`
    - `DELETE /api/v2/useCases/(useCaseId)/`
    - `GET /api/v2/useCases/(useCaseId)/activities/`
    - `GET /api/v2/useCases/(useCaseId)/attachments/`
    - `POST /api/v2/useCases/(useCaseId)/attachments/`
    - `DELETE /api/v2/useCases/(useCaseId)/attachments/(attachmentId)/`
    - `GET /api/v2/useCases/(useCaseId)/attachments/(attachmentId)/`
    - `GET /api/v2/useCases/(useCaseId)/realizedValueOverTime/`
    - `GET /api/v2/useCases/(useCaseId)/sharedRoles`
    - `PATCH /api/v2/useCases/(useCaseId)/sharedRoles/`

- The following Scheduled Jobs API endpoints have been removed:

    - `GET /api/v2/scheduledJobs/(jobId)/`
    - `PATCH /api/v2/scheduledJobs/(jobId)/`
    - `DELETE /api/v2/scheduledJobs/(jobId)/`

- AWS Credentials, Google Service account, and Snowflake key pair credentials can be shared by admins through shared secure configurations. The following routes accept a param, `configId`, as the ID of secure configurations shared by admins.

    - `POST /api/v2/credentials/`
    - `PATCH /api/v2/credentials/(credentialId)/`

- The new optional parameters `limit` and `offset` were added to `GET /api/v2/projects/`. This now has a default limit of 1000 projects.

### Deprecations {: #deprecations }

- `was_acted_on` and `timestamp` are deprecated from `POST /api/v2/deployments/(deploymentId)/actuals/fromJSON/` and will be removed in version 2.34.
- `was_acted_on_column` and `timestamp_column` are deprecated from `POST /api/v2/deployments/(deploymentId)/actuals/fromDataset/` and will be removed in version 2.34.
- The route `POST/api/v2/modelPackages/<modelPackageId>/sharedRoles/` is deprecated and will be removed in version 2.34. Use `POST /api/v2/registeredModels/(registeredModelId)/sharedRoles/` instead.
- The route `GET /api/v2/modelPackages/<modelPackageId>/sharedRoles/` is deprecated and will be removed in version 2.34. Use `GET /api/v2/registeredModels/(registeredModelId)/sharedRoles/` instead.
- The route `POST /api/v2/modelPackages/<modelPackageId>/archive/` is deprecated and will be removed in version 2.34. Use `POST /api/v2/registeredModels/(registeredModelId)/` instead.

### Enhancements {: #enhancements }

- The following routes now return detected languages of text features:
    - `GET /api/v2/datasets/(datasetId)/allFeaturesDetails/`
    - `GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/allFeaturesDetails/`
    - `GET /api/v2/projects/(projectId)/features/`
    - `GET /api/v2/projects/(projectId)/features/(featurename:featureName)/`
    - `GET /api/v2/projects/(projectId)/modelingFeatures/`
    - `GET /api/v2/projects/(projectId)/modelingFeatures/(featurename:featureName)/`
