🥥

Highlights

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

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-31T00:00:00.000Z"
}

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.

🍐

Entitlements

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.

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

Consumer	Contributor	Data Bridge Admin
NO	NO	YES

To learn more about role-based permissions in Data Bridge, see Access Controls.

Update Archive

The Update Archive operation (PATCH /databridge/v1/sql-instances/{instanceName}/Databases /{databaseName}/archives/{archiveId}) updates the type of the specified archive.

An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Every archive is defined by its storageType, which determines whether the archive is permanent or temporary. Temporary archives are defined by an expirationDate that specifies the date that the archive is deleted from Data Vault.

The required instanceName and archiveId path parameters identified the database archive to update. The request body accepts two optional parameters: storageType and expirationDate. The expirationDate is required if the storageType is temporary:

{
  "storageType": "permanent",
  "expirationDate": "2030-12-31T00:00:00.000Z"
}

🍐

Entitlements

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.

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

Consumer	Contributor	Data Bridge Admin
NO	NO	YES

To learn more about role-based permissions in Data Bridge, see Access Controls.

Jobs

Get Job Status

The List Jobs by Server Instance (GET /databridge/v1/sql-instances/{instanceName}/jobs ) and Get Job by Server Instance operation (GET /databridge/v1/sql-instances/{instanceName}/jobs/{jobId} ) returns information about the specified 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.

System Usage API

The System Usage API (SML) is a back-end, non-public API that Intelligent Risk Platform uses to report storage and ata Vault usage. This API is unsupported and not documented in the Moody's Insurance Solutions Developer Portal.

We have scheduled a change to this endpoint in the April release and are reporting change here.

The System Usage screen in Admin Center currently uses the /sml/usage/v1/applications/platform/data/Resources/ArchiveSizeInGb/MetricSeries endpoint to report information about storage consume by deleted databases on Data Bridge server instances. With this release, the endpoint will be changed to sml/usage/v1/applications/databridge/data/Resources/RecycleBinStorageInGbs/MetricSeries.

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