🥥

Highlights

The 2025.09.d release introduces updates to the Admin Data API.

• Data Vault now supports two types of archives: databases and exposure sets.
• The Restore Archive operation nows supports restoring archived data (databases or exposure sets) to new and existing securables.
• The Update Archive operation now updates the storageType of an archive. One of temporary or permanent.
• The Delete Securable operation supports "soft deletes" of exposure set securables.

Learn More

Admin Data API

Data Vault now supports the archival of exposure sets. The Admin Data API operations now enable client applications to create archives from exposure sets in addition to databases. Exposure sets can be restored from archives and recovered within 14 days of deletion.

An exposure set is a securable that controls access rights to a collection of exposure, hazard, and financial information and analysis based on that data. The creator of the exposure set is the owner of that exposure set and may share access to child data (exposures, exposure variations, and exposure analysis) to user groups.

Search Archives

The Search Archives operation (GET /platform/admindata/v1/archives) returns a list of securables that are marked as deleted in the platform.

An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases.

Data Vault now supports two types of archives: exposure sets and databases. Exposure sets can be further identified by archiveSubType: EDM, RDM, UNKNOWN.

[
  {
  "archiveId" : 920101,
  "archiveName" : "_001_EDM_xyz",
  "archiveType" : "database",
  "archiveSubType" : "edm",
  "serverType" : "databridge",
  "serverName" : "databridge-1",
  "securableId" : 1949951,
  "securableName" : "001_ExposureSetName",
  "securableType": "exposureSet",
  "sourceTypeId" : 1,
  "sourceType" : "Archive",
  "storageTypeId" : 1,
  "storageType" : "Permanent",
  "sizeInMb" : 16.0,
  "owner" : "[email protected]",
  "createdBy" : "[email protected]",
  "createdAt" : "2021-04-17T23:01:10.000Z",
  "archivedBy" : "[email protected]",
  "archivedAt" : "2025-04-17T23:01:10.000Z",
  "expirationDate" : "9999-12-31T23:59:59.000Z",
  "tagIds" : [1,2],
  "groupIds" : [
                      "f3426c9e-ad04-46f3-9bbc-52af40adf46a"
                     ,"7ac9780d-a6b0-47b1-994d-3508ee115473"
                     ,"bd40473e-e4ab-4093-8008-ddf85a005046"
                    ],
  "archiveDetails":
    {
      "exposureNameName" : "001_EDM",
      "databaseSchemaVersion": "25",
      "dataVersion": "21.0.0",
      "appRegisteredFrom": "RM",
      "thumbPrint": "EUW1.20250520.50",
      "any_other_field_looking_for_inputs" : "value"
    }
  },

This operation now returns new properties: archiveType, archiveSubType, createdBy, exposureSetName:

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Returned data can be sorted by the following properties: archiveId, archiveName, archiveSubType, archiveType, archivedAt, archivedBy, createdAt, createdBy, expirationDate, groupIds, owner, securableId, securableName, securableType, serverName, serverType, sizeInMb, sourceTypeId, storageTypeId, and tagIds.

Get Archive

The Get Archive operation (GET /platform/admindata/v1/archives/{archiveId}) returns the specified archive.

This operation now returns four new properties: archiveSubType, archiveType, createdBy, and exposureNameName.

This data returned in the request include deleted resources including the name, ID, type and date of deletion:

{
  "archiveId": 920101,
  "archiveName": "_001_EDM_xyz",
  "archiveType": "database",
  "archiveSubType": "edm",
  "serverType": "databridge",
  "serverName": "databridge-1",
  "securableId": 1949951,
  "securableName": "001_ExposureSetName",
  "securableType": "exposureSet",
  "sourceTypeId": 1,
  "sourceType": "Archive",
  "storageTypeId": 1,
  "storageType": "Permanent",
  "sizeInMb": 16.0,
  "owner": "[email protected]",
  "createdBy": "[email protected]",
  "createdAt": "2021-04-17T23:01:10.000Z",
  "archivedBy": "[email protected]",
  "archivedAt": "2025-04-17T23:01:10.000Z",
  "expirationDate": "9999-12-31T23:59:59.000Z",
  "tagIds": [1, 2],
  "groupIds": [
    "f3426c9e-ad04-46f3-9bbc-52af40adf46a",
    "7ac9780d-a6b0-47b1-994d-3508ee115473",
    "bd40473e-e4ab-4093-8008-ddf85a005046"
  ],
  "archiveDetails": {
    "files": [
      {
        "url": "https://XXXXXXXXXXXXX.XXXXXXXXXXXXXX/XXXXXXXXXXXXXXX",
        "type": "MDF"
      },
      {
        "url": "https://XXXXXXXXXXXXX.XXXXXXXXXXXXXX/XXXXXXXXXXXXXXX",
        "type": "LDF"
      }
    ],
    "exposureNameName": "001_EDM",
    "databaseSchemaVersion": "25",
    "dataVersion": "21.0.0",
    "appRegisteredFrom": "RM",
    "thumbPrint": "EUW1.20250520.50",
    "any_other_field_looking_for_inputs": "value"
  }
}

Restore Archive

The Restore Archive operation (POST /platform/admindata/v1/archives/{archiveId}/restore) restores archived data (databases or exposure sets).

Depending on the parameters specified in the request, this operation supports updating the name and owner of restored databases.

To perform this operation, the client must be assigned the Data Admin role. This operation requires the RI-DATAVAULT entitlement.

Update Archive

The Update Archive operation (PATCH /platform/admindata/v1/archives/{archiveId}) updates the specified archive.

Update options depend on the archive's storageType property:

• If temporary, the archive can be reset as a permanent with a specific expiration date. If no expirationDate is specified, the expirationDate is automatically set to Dec-31-9999.
• If permanent, the expirationDate can be updated to a future date.

This operation requires the RI-DATAVAULT entitlement.

Get Securable

The Get Securable operation (POST /platform/admindata/v1/securables/{securableId}/archive) returns the specified securable.

A securable is a logical container of data that is owned by a group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

Delete Securable

The Delete Securable operation (DELETE /platform/admindata/v1/securables/{securableId}) supports "soft deletes" of exposure set securables.

A securable is a logical container of data that is owned by a group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

This operation performs a "soft delete" of the exposure set and all of its child objects. The deleted exposure sets can be recovered within 14 days using the Restore Archive operation. All temporary exposure sets expire in 14 days.

The client must be assigned the Data Admin role.

Archive Securable

Archives the specified securable.

A securable is a logical container of data that is owned by a user group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

The archiveType of the archived securable is one of database or exposureset depending on the securable.

If the request is successful, this operation returns a 202 Accepted HTTP status code and adds a ARCHIVE_SECURABLE job. Use the Get Admin Data Job to poll the status of the job.

Delete Securable

Deletes the specified securable.

A securable is a logical container of data that is owned by a user group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

If the request is successful, this operation returns a 202 Accepted HTTP status code and adds a DELETE_SECURABLE job. Use the Get Admin Data Job to poll the status of the job.