🥥

Highlights

The April 2024 release of the Data Bridge API introduces updates for managing the archival of managed databases.

Moody's publishes preliminary information to inform stakeholders ahead of the targeted Intelligent Risk Platform update. Note that these described features are not guaranteed for the next update or any subsequent updates and may be changed without notice. The definitive list of features will be provided in the Changelogs at the time of the official release.>

Learn More

Archives

Archive Database

The [Archive Database] operation (POST /databridge/v1/sql-instances/{instanceName}/Databases/{databaseName}/archive) creates an archive of the specified database.

An archive is a copy of a database that is stored in the Data Vault.

This operation takes takes two required path parameters (instanceName and databaseName) that identify a database on a managed server instance on Data Bridge. An optional expirationDate can be specified in the body of the request.

{
  "expirationDate": "2030-12-31"
}

If no expirationDate is specified, the archive is marked as a permanent archive record. Intelligent Risk Platform supports three archive source types (Deleted Database, Snapshot Database, and Archive Database) and two archive storage types (temporary and permanent). The source type identifies the method used to create the archive. The storage type determines whether the archive is deleted on its expiration date.

If successful, this operation retuns a 201 Created HTTP response code and initiates an ARCHIVE_DATABASE job. The job copies MDF files of the specified database to the Data Vault and then deletes the database from the specified managed server.

This operation requires the RI-DATAVAULT entitlement. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases. To perform this operation the client must be assigned the Data Bridge Admin role.

Jobs

Get Job Status

The Get Job Status operation (GET /databridge/v1/jobs/{jobId}) returns information about the specified import or export job. The jobId path parameter is required.

This operation now returns information about ARCHIVE_DATABASE jobs:

[
 {
    "id": "d0148af2-7e8f-41a4-bf64-b79c44149d55",
    "type": "Archive Database",
    "owner": "[email protected]",
    "status": "Done",
    "resourceType": "Database",
    "resourceName": "_UW_EMD1_dml_PreserveID2_xPnq",
    "createTime": "2025-02-06T22:29:20.5112807",
    "endTime": "2025-02-06T22:29:49.1638998"
 }
]

Databases

The List Databases operation (GET /databridge/v1/sql-instances/{instanceName}/Databases) returns a list of databases. This request returns information about all EDMs, RDMs, and custom databases on the specified server instance.

The sort query parameter enables the client to sort returned records in ascending or descending order. In prior releases, this operation supported sorting based on the following property values: createdAt, name, and sizeInMb. This operation now supports sorting by databases.

Data Vault

The Data Bridge API and Admin Data API introduces support for Intelligent Risk Platform Data Vault. Data Vault is a separately licensed feature that allows data administrators to manage and restore archived databases.

An archive is a copy of a database that is stored in the Data Vault. When an exposure database is archived using this operation, the exposure database to be marked as permanent archive record.

Intelligent Risk Platform supports three archive source types (Deleted Database, Snapshot Database, and Archive Database) and two archive storage types (temporary and permanent). The source type identifies the method used to create the archive. The storage type determines whether the archive is deleted on its expiration date.

SML API

The SML API is not a public API and not documented in the Moody's Insurance Solutions Developer Portal. The Intelligent Risk Platform uses this API to report Data Vault usage.

The sml/usage/v1/applications/databridge/data/Resources/ArchiveSizeInGb/MetricSeries endpoint has been deprecated and replaced by the sml/usage/v1/applications/databridge/data/Resources/RecycleBinSizeInGb/MetricSeries endpoint.

This change does not affect the operation of clients using the Data Bridge API.