What's New

Learn about new and changed endpoints for the Oracle Analytics Cloud REST API.

Note:

APIs marked as Preview are design, specification, and implementation complete but might change before general release. Preview APIs are intended for evaluation and training purposes. Preview APIs aren't recommended for production use or business-critical scenarios.

May 2025

REST API Category	Changes in REST API
Authenticate	Added note to Authenticate topic regarding obtaining OAuth 2.0 tokens with a user context.
Catalog	Additional information added to type descriptions in Catalog APIs.
Mail	Added OAuth 2.0 authentication for mail servers. See Configure a mail server.
Workbooks	New endpoints: Download workbook export Export workbook canvas

March 2025

REST API Category	Changes in REST API
Authenticate	Oracle Cloud Infrastructure allows you to obtain OAuth 2.0 access token using various grant types. Revised Authenticate topic to provide links to the latest documentation that provides the authorization options available to you.
Analysis	New endpoint: Get analysis details
Connections	New endpoint: Get connection details
Workbooks	New endpoint: Get workbook details
Snapshots	Change to password requirements when creating a snapshot and two new parameters. Passwords require a length between 14 and 50 characters and must contain at least one numeric character, one uppercase letter, one lowercase letter, and one special character. For example, snapshotPassword123!. New parameter bucketOciRegion. This parameter specifies the region where the storage bucket exists. Only required when the bucket is located in a different region. New parameter bucketOciNamespace. This parameter specifies the namespace where the storage bucket exists. Only required when the bucket is located in a different tenancy. See Create a snapshot.
Mail	Updated password parameter to require between 8 to 255 characters. See Configure a mail server and Get mail server settings.

January 2025

REST API Category	Changes in REST API
Mail	New endpoints: Configure a mail server Delete mail server settings Get mail server settings

November 2024

REST API Category	Changes in REST API
Authenticate	Authentication example shows how you can use a file to store your access tokens. See Authenticate.
Catalog	Additional information on how to use search parameters in Get catalog items endpoint and Get catalog item details endpoint. New endpoint: Get canvases: POST /api/20210901/catalog/workbooks/{id}/actions/getCanvases
Snapshots	Change to the auth parameter in the Create a snapshot endpoint. New object type OCI_RESOURCE_PRINCIPAL This new auth type enables you to use OCI resource principal authentication to access snapshot storage. Deprecated object type OSS_AUTH_OCI_USER_ID OSS_AUTH_OCI_USER_ID deprecated from November 2024. If you currently use OCI user principal (an API signing key), Oracle recommends that you switch to using a resource principal (OCI_RESOURCE_PRINCIPAL) to authenticate access to snapshot storage.

September 2024

REST API Category	Changes in REST API
Snapshots	New query parameter for the Delete a snapshot endpoint, deleteStorage. When set to true, the snapshot is deregistered and the snapshot BAR file is deleted from storage. When set to false, the BAR file is deregistered but the BAR file remains in storage. The default is true.

July 2024

REST API Category	Changes in REST API
Data Flows	New endpoints: Get run history for a data flow: GET /api/20210901/catalog/dataflows/{dataflowId}/history Get latest run for a data flow: GET /api/20210901/catalog/dataflows/{dataflowId}/history/latest Get run history for a data flow job: GET /api/20210901/catalog/dataflows/{dataflowId}/history/{jobId}
Datasets	New endpoints: Get reload history for a dataset: GET /api/20210901/catalog/datasets/{datasetId}/history Get latest reload history for a dataset: GET /api/20210901/catalog/datasets/{datasetId}/history/latest Get reload history for a dataset job: GET /api/20210901/catalog/datasets/{datasetId}/history/{jobId}
Sequences	New endpoint: Get run history for a sequence: GET /api/20210901/catalog/sequences/{sequenceId}/history Get latest run history for a sequence: GET /api/20210901/catalog/sequences/{sequenceId}/history/latest Get run history for a sequence job: GET /api/20210901/catalog/sequences/{sequenceId}/history/{jobId}
System Settings	New type parameter for the Get system settings endpoint. Valid values: type=default or type=updated Use the type parameter to return system settings that haven't been modified ( type=default ) or system settings with custom values ( type=updated) . Get system settings: GET /api/20210901/system/settings
Snapshots	Update to the password parameter in the Create a snapshot endpoint. Minimum password length increased to 14 characters (previously 8).

March 2024

REST API Category	Changes in REST API
Data Flows	New endpoint: Run data flow: POST /api/20210901/catalog/dataflows/{dataflowId}/actions/run
Sequences	New endpoint: Run sequence: POST /api/20210901/catalog/sequences/{sequenceId}/actions/run

January 2024

REST API Category	Changes in REST API
Catalog	New endpoints: Get catalog items: GET /api/20210901/catalog Get catalog item details: GET /api/20210901/catalog/{type}/{id} Get catalog items by type: GET /api/20210901/catalog/{type} Copy a catalog item: POST /api/20210901/catalog/{type}/{id}/actions/copy Move a catalog item: POST /api/20210901/catalog/{type}/{id}/actions/move Get a catalog item ACL: POST /api/20210901/catalog/{type}/{id}/actions/getACL Update a catalog item ACL: POST /api/20210901/catalog/{type}/{id}/actions/updateACL Create a folder: POST /api/20210901/catalog/folders Delete a folder: DELETE /api/20210901/catalog/folders{id}
Connections	Endpoints now available for general use: Create a connection: POST /api/20210901/catalog/connections Delete a connection: DELETE /api/20210901/catalog/connections/{connectionId} Update a connection: PUT /api/20210901/catalog/connections/{connectionId}
Datasets	Endpoint now available for general use: Reload data for a dataset: POST /api/20210901/catalog/datasets/{datasetId}/actions/reload
Safe Domains	Endpoints now available for general use: Get all safe domains: GET /api/20210901/system/safeDomains Delete a safe domain: DELETE /api/20210901/system/safeDomains/{urlBase64DomainId} Create or update a safe domain: PUT /api/20210901/system/safeDomains/{urlBase64DomainId}
System Settings	Endpoints now available for general use: Get system settings: GET /api/20210901/system/settings Update system settings: PUT /api/20210901/system/settings

September 2023

REST API Category	Changes in REST API
Connections (Preview)	New endpoints for preview use: Create a connection: POST /api/20210901/catalog/connections Delete a connection: DELETE /api/20210901/catalog/connections/{connectionId} Update a connection: PUT /api/20210901/catalog/connections/{connectionId}
Safe Domains (Preview)	New endpoints for preview use: Get all safe domains: GET /api/20210901/system/safeDomains Delete a safe domain: DELETE /api/20210901/system/safeDomains/{urlBase64DomainId} Create or update a safe domain: PUT /api/20210901/system/safeDomains/{urlBase64DomainId}
System Settings (Preview)	New endpoints for preview use: Get system settings: GET /api/20210901/system/settings Update system settings: PUT /api/20210901/system/settings

July 2022

REST API Category	Changes in REST API
Datasets (Preview)	New endpoints for preview use: Reload data for a dataset: POST /api/20210901/catalog/datasets/{datasetId}/actions/reload

May 2022

REST API Category	Changes in REST API
System	New endpoints: Get details of an Analytics instance : GET /api/20210901/system Restore a snapshot in an Analytics instance: POST /api/20210901/system/actions/restoreSnapshot
Analytics Instance	Deprecated endpoints: Get details of an Analytics instance: GET /api/20210901/analyticsInstance Restore a snapshot in an Analytics instance: POST /api/20210901/analyticsInstance/actions/restoreSnapshot