Skip to content

Working with Backups

Working with backups in Configuration Hub allows you to manually set up backups or have them automatically be backed up to your tenant.

Creating a Backup

You can manually initiate a backup of your configuration objects, retaining up to 10 manual backups at a time per tenant. When you reach this limit, you must delete one or more manual backups before you can create a new one.

Note

Configuration Hub does not back up secrets or credential information.

  1. On the Configuration Backups page of the Configuration Hub, select Create Backup.

  2. Provide a name for your backup.

  3. Select the checkbox beside the types of objects you want to include in this backup, or select All Objects.

    You can further limit the objects included in this backup by entering the exact names of the specific objects to back up in the Objects by Name field beside a selected object type and select Enter. The names you enter in this field are case-sensitive.

    If the Objects by Name field is left blank, and the checkbox beside the object type is selected, all objects of that type will be included in the backup.

  4. Select Create Backup.

    When your backup is complete, it will appear in the list of backups, marked as the Latest.

    Select Actions on the backup row and select View Summary to view a summary of the object types and counts included in it.

    From the summary page, you can also select View Details to see various objects.

    If you added specific objects to your backup by name, those objects are listed within this summary. The Objects by Name column displays all names you entered for that type, regardless of whether or not an object was found matching that name and type. However, the number in the Count column only reflects only the names you entered that correspond with objects.

Note

There could be more than one tenant listed in the backups list. The list of tenants in your Backups list represents additional tenants connected to your current environment. Go to Using Tenant Connections for more information.

Important

To easily identify which tenant is the current live one (i.e. the target tenant you are about to deploy configuration to), a green dot will be next to the tenant name under Backups.

Automated Backups

In addition to your manual backups, SailPoint also automatically backs up your production tenant's configurations. Automated backups are listed as Created By: SYSTEM in the backups list, and their retention and deletion are managed by SailPoint.

  • An automated backup occurs weekly. The process deletes the oldest weekly backup as necessary to retain up to 5 weekly backups at a time.
  • The draft creation process also creates an automated backup to compare with the selected backup, and the most recent one of these appears in the backup list.

Deleting a Backup

Only manual backups (meaning backups not created by the SYSTEM) can be deleted. To delete a backup:

  1. Go to the Configuration Backups page of the Configuration Hub, select Actions on the backup row, and select Delete.
  2. Select Delete to confirm.

Viewing Detailed Backup Objects

You can view the details of your backup configuration in JSON format.

  1. Select Actions on the backup row and select View Summary to view a summary of the object types and counts included in it.

  2. Select View Details on the backup summary page.

    When the details load, all of the various object types within this backup display in a list on the left of the screen. By clicking an object type, a list of all the related configurations for that type display.

    You can click Previous Object or Next Object to see the other object types.

    On the object type summary page, you can filter and sort through the objects that are a part of that object type. You can also search for keywords of an object name if it is known.

  3. From the object names provided, click View to see the details of that object.

    JSON details are provided. These details cannot be altered.

Restoring from a Backup

You can use an automated or manual backup from your tenant to restore configurations as they existed when that backup was generated.

To restore from a backup:

  1. Create a draft to identify which objects are different between the selected backup and your live tenant.

  2. (Optional) Edit the draft to choose which objects to restore or to adjust the object details.

  3. Deploy the draft to update your live tenant.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.