Learn how to take a backup of RDM data and its configuration.

1. Open a REST client such as Postman.
2. Send a request to the API endpoint for the RDM data or configuration you want to back up:

   • Configuration:

     GET https://{{rdm-service}}/configuration/{backup_tenant_name}

     For more information on this RDM, see topic Get Tenant Configuration.

     Note: The response file has tenantId which is the {backup_tenant_name} in the configuration GET API, from where you are taking backup. Modify {backup_tenant_name} if you want to restore the backed up RDM configuration to another tenant.

   • Generators:

     GET https://{{rdm-service}}/generators/{backup_tenant_name}

     For more information on this RDM, see topic Management API.

     Note: If the currentValue field is present in the response, then update its value as rangeStart after you save the response file.

   • RDM lookups:

     POST  https://{{rdm-service}}/lookups/{backup_tenant_name}/_dbscan?limit=100
     Body: {{scrollId}}

     Sample response structure:

     {
     "scrollId": "scrollId",
      	"values": [
            		{<Lookups1>},
             	{<Lookup 2>}
      	]
     }
     

   • For more information on the RDM lookups, see topic DB Scan.

     Note:

     • _dbscan endpoint works on scrollId. Repeat the GET API call with scrollId until the values array is empty.
     • The tenantId parameter in the response contains the backup tenant name. Modify this field if you want to restore in another tenant.
     • RDM can only create 100 lookups in a request. Although you are free to increase the _dbscan endpoint, we recommend that you create a chunk of 100 lookups in a file as the system reads a chunk of 100 lookups at a time to restore the backup.

   • RDM unmapped values:

     POST https://{{rdm-service}}/unmapped/{backup_tenant_name}/_dbscan?limit=100
     Body: {{scrollId}}

     Sample response structure:

     {
     "scrollId": "scrollId",
      	"Values":
      	[
            		{<unmappedValue1>},
             	{<unmappedValue2>}
      	]
     }
     
     

     For details on this RDM, see topic DB Scan.

     Note:

     • The _dbscan endpoint works on scrollId. Repeat the GET API call with scrollId until the values array is empty.
     • The tenantId parameter in the response contains the backup tenant name. Modify this field if you want to restore in another tenant.
     • RDM can only create 100 unmapped values in a request. Although you are free to increase the _dbscan endpoint, we recommend that you create a chunk of 100 unmapped values in a file as the system reads a chunk of 100 unmapped values at a time to restore the backup.

   • Streaming events configuration:

     GET https://{{rdm-service}}/configuration/{backup_tenant_name}/messaging

     For more information on this RDM, see topic Messaging APIs.

3. Save the API response to a JSON file using the naming convention:

   • RDM configuration: configuration.json

   • RDM generators: generators.json

   • RDM Lookups: Save every chunk of response as a separate JSON file, for example, lookups1.json, lookups2.json, and so on.

   • RDM unmapped values: Save every chunk of response as a separate JSON file, for example, unmappedValues1.json, unmappedValues2.json, and so on.

   • Streaming events configuration: messagingProperties.json