Skip to content
For Self-Managed AI Platform users running v11.1, see the on-premise platform documentation
Developer documentation > API reference > API changelogs > REST API changelogs

REST API changelogs

Changelogs contain curated, ordered lists of notable changes for each versioned release for DataRobot's REST API client. Reference the changelog below to view changes for DataRobot's newest version, and view previous versions in the table of contents.

v2.39 changelog

Reference the changes introduced to version 2.39 of DataRobot's REST API.

New features

  • Added an endpoint for custom metrics bulk upload: POST /api/v2/deployments/{deploymentId}/customMetrics/bulkUpload/

  • Added new endpoints for prompt template management to manage LLMs and prompt templates for generative AI workflows. This functionality enables users to retrieve LLM information, create and manage prompt templates with versioning support, and organize prompts for consistent use across generative AI applications. Prompt templates can be versioned to track changes over time and maintain reproducibility. The endpoints support the full lifecycle of prompt management from creation to version tracking, enabling you to develop, test, and deploy prompts systematically.

    • GET /api/v2/genai/llms/{llmId}/
    • GET /api/v2/genai/promptTemplates/
    • POST /api/v2/genai/promptTemplates/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/
    • POST /api/v2/genai/promptTemplates/{promptTemplateId}/versions/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/{promptTemplateVersionId}/
    • GET /api/v2/otel/{entityType}/{entityId}/metrics/autocollectedValues/

  • Added new endpoints for OpenTelemetry metrics observability. Retrieve OpenTelemetry metrics data to monitor and observe DataRobot entities. This functionality provides access to automatically collected metrics, pod and container information, and metric values over time grouped by attributes. The endpoints enable users to monitor system performance, resource utilization, and application health through standardized OpenTelemetry metrics. They also help troubleshoot performance issues and understand resource consumption patterns across deployments and other entities.

    • GET /api/v2/otel/{entityType}/{entityId}/metrics/podInfo/
    • POST /api/v2/otel/{entityType}/{entityId}/metrics/valuesOverTime/segments/
    • GET /api/v2/tenantUsageResources/

  • Added new endpoints for Tenant Usage and Resource Management. Use the endpoints to monitor and export tenant resource usage and active user information for administrative oversight and capacity planning. This functionality enables system and organization administrators to track resource consumption across tenants, identify active users, retrieve available resource categories, and export usage data for reporting and analysis. The endpoints support both tenant-specific and cluster-wide usage reporting, helping administrators understand platform utilization, plan capacity, and ensure efficient resource allocation.

    • GET /api/v2/tenantUsageResources/activeUsers/
    • GET /api/v2/tenantUsageResources/categories/
    • GET /api/v2/tenantUsageResources/export/

API changes

  • Parameter entityType schema updated for GET /api/v2/comments/{entityType}/{entityId}/.

  • Parameter eventGroup schema updated for GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/.

  • Parameter eventGroup schema updated for GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/.

  • Parameter eventGroup schema updated for GET /api/v2/notificationPolicies/.

  • The new optional parameter skip_consent has been added to POST /api/v2/externalOAuth/providers/{providerId}/authorize/.

  • Parameter limit schema updated for GET /api/v2/genai/llms/.

  • The new optional parameter spanId has been added to GET /api/v2/otel/{entityType}/{entityId}/logs/.

  • Description updated for GET /api/v2/tenants/{tenantId}/activeUsers/.

  • Removed parameter tenantId (path) for GET /api/v2/tenants/{tenantId}/resourceCategories/.

  • Description updated for GET /api/v2/tenants/{tenantId}/usage/.

  • Description updated for GET /api/v2/tenants/{tenantId}/usageExport/.

v2.38 changelog

Deprecation summary

  • Deprecated the customJobId field within the trigger property from POST /api/v2/deployments/(deploymentId)/retrainingPolicies/ and PATCH /api/v2/deployments/(deploymentId)/retrainingPolicies/(retrainingPolicyId)/. This field will be removed in v2.40.

  • The custom_job trigger type is no longer supported for POST /api/v2/deployments/(deploymentId)/retrainingPolicies/ and PATCH /api/v2/deployments/(deploymentId)/retrainingPolicies/(retrainingPolicyId)/. To create a custom job retraining policy, use model_selection: custom_job instead. The option is no longer documented and will be removed in v2.40.

v2.37 changelog

v2.37 of the DataRobot REST API introduced no reported changes.

v2.36 changelog

New features

  • Added new endpoints for role based access management. Uses the following endpoints:

  • GET /api/v2/accessRoles/

  • GET /api/v2/accessRoles/{role_id}/
  • POST /api/v2/accessRoles/
  • PUT /api/v2/accessRoles/{role_id}/
  • DELETE /api/v2/accessRoles/{role_id}/

  • GET /api/v2/accessRoles/users/

  • Added an endpoint that initializes the incremental learning model and begins training using the chunking service POST /api/v2/projects/(projectId)/incrementalLearningModels/fromSampleModel/. To use it, enable the feature flag "Sample Data to Start Project."

  • Added an endpoint for retrieving the model_history of a deployment GET /api/v2/deployments/(deploymentId)/modelHistory/.

  • Added new APIs for secure configuration management. Uses the following endpoints:

  • POST /api/v2/secureConfigs/

  • GET /api/v2/secureConfigSchemas/
  • GET /api/v2/secureConfigSchemas/(secureConfigSchemaId)/
  • PATCH /api/v2/secureConfigs/(secureConfigId)/
  • GET /api/v2/secureConfigs/(secureConfigId)/values/
  • GET /api/v2/secureConfigs/(secureConfigId)/sharedRoles/
  • PATCH /api/v2/secureConfigs/(secureConfigId)/sharedRoles/
  • The start and end query parameters are no longer required for GET /api/v2/deployments/(deploymentId)/dataQualityView/. Defaults will be provided for a one week span when not specified.
  • The start and end body parameters are no longer required for POST /api/v2/deployments/{deploymentId}/predictionDataExports/. Defaults will be provided for a one week span when not specified.

Deprecation summary

  • Removed the field capabilities from GET /api/v2/deployments/ and GET /api/v2/deployments/(deploymentId)/, after being deprecated in 2.29. Instead, use GET /api/v2/deployments/(deploymentId)/capabilities/.
  • Removed the query param targetClasses from GET /api/v2/deployments/(deploymentId)/accuracy/ and GET /api/v2/deployments/(deploymentId)/accuracyOverTime/, after being deprecated in 2.31. Instead, use targetClass query param.
  • Deprecated metrics and modelId fields from GET /api/v2/deployments/(deploymentId)/accuracy/, use data field in the same endpoint instead. The deprecated fields will be removed in 2.40.

v2.35 changelog

Reference the changes introduced to version 2.35 of DataRobot's REST API.

New features

  • Added new endpoints for OCR Jobs. This is a feature for processing datasets with PDFs. It runs OCR on the PDFs in the dataset and replaces all images in those PDFs with text. The feature is comprised of the following endpoints:

    • POST /api/v2/ocrJobResources/
    • GET /api/v2/ocrJobResources/(jobResourceId)/
    • GET /api/v2/ocrJobResources/(jobResourceId)/errorReport/
    • GET /api/v2/ocrJobResources/(jobResourceId)/jobStatus/
    • POST /api/v2/ocrJobResources/(jobResourceId)/start/

API changes

  • The new optional parameter numberOfIncrementalLearningIterationsBeforeBestModelSelection for projects with the auto-incremental learning option has been added to PATCH /api/v2/projects/(projectId)/aim/. It is used in automated incremental learning Autopilot mode.

  • Added endpoints to calculate and retrieve the SHAP distributions data:

  • POST /api/v2/insights/shapDistributions/
  • GET /api/v2/insights/shapDistributions/models/(entityId)/

Deprecation summary

  • The API endpoint GET /api/v2/projects/(projectId)/models/(modelId)/primeInfo/ is deprecated, as creating Prime models is no longer supported.
  • The query params projectId and applicationId have been deprecated for GET /api/v2/useCases/.

Documentation changes

  • The correct expected HTTP response code has been documented for POST /api/v2/notifications/. It should return a 201, but 200 was previously documented.
  • The correct expected HTTP response code has been documented for PATCH /api/v2/ssoConfigurations/(configurationId)/. It should return a 204, but 200 was previously documented. in June 2025.

v2.34 changelog

Reference the changes introduced to version 2.34 of DataRobot's REST API.

New features

  • Added an endpoint to create a hosted custom metric from a custom job: POST /api/v2/deployments/(deploymentId)/customMetrics/fromCustomJob/.
  • Added an endpoint to list hosted custom metrics: GET /api/v2/customJobs/(customJobId)/customMetrics/.
  • Added an endpoint to update the hosted custom metric PATCH /api/v2/deployments/(deploymentId)/customMetrics/(customMetricId)/.
  • Added an endpoint to delete the hosted custom metric DELETE /api/v2/deployments/(deploymentId)/customMetrics/(customMetricId)/.
  • Added an endpoint to create custom job from hosted custom metrics gallery template POST /api/v2/customJobs/fromHostedCustomMetricGalleryTemplate/.
  • Added an endpoint to create a blueprint for the hosted custom metric POST /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/.
  • Added an endpoint to retrieve a blueprint for the hosted custom metric GET /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/.
  • Added an endpoint to update a blueprint for the hosted custom metric GET /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/.

Enhancements

  • Requests for insights at the /api/v2/insights/* group of endpoints now accept the entityType parameter, which enables insight computation for customModel entities as well as native datarobotModel entities. To compute insights on a custom model, you must first initialize insights with a call to POST /api/v2/modelComplianceDocsInitializations/(entityId)/.

  • The response from the Get SHAP impact API endpoint GET /api/v2/insights/shapImpact/models/(entityId)/ has been changed. Now the shapImpacts parameter is a list of key-pair values. The capping parameter has been removed from the response.

Deprecation summary

  • The API endpoint GET /api/v2/projects/(projectId)/models/ is deprecated. Instead, use GET /api/v2/projects/(projectId)/modelRecords/.
  • The API endpoint /projects/(projectId)/featureAssocationFeaturelists/ is removed, after being deprecated in release 2.19. Users should continue to use GET /api/v2/projects/(projectId)/featureAssociationFeaturelists/.
  • The field modelsCount in GET /api/v2/useCases/ and GET /api/v2/useCases/(useCaseId)/ is deprecated and will be removed in June 2025.