- API >
- Public API Tutorials >
- Automate Backup Restoration through the API
Automate Backup Restoration through the API¶
On this page
To restore a snapshot using the API, find the snapshot ID for the snapshot you want to restore, then
Prerequisites¶
You must have API access. To learn how to get access, see Configure Public API Access.
To find and download the snapshot, your API Key needs read access to
snapshots in the desired Project. Grant the API Key the
Project Read Only
role on the Project that relates to that
snapshot.
Procedure¶
1
Retrieve the snapshot ID.¶
Call the Get All Snapshots resource to find the ID for the desired snapshot. Issue the following command, replacing:
Name | Type | Description |
---|---|---|
PUBLIC-KEY |
string | Your public API Key for your API credentials. |
PRIVATE-KEY |
string | Your private API Key for your API credentials. |
<OpsManagerHost>:<Port> |
string | URL of your Ops Manager instance. |
GROUP-ID |
string | Unique identifier of your Project from your Project Settings. |
CLUSTER-ID |
string | Unique identifier of your cluster. |
2
Create a restore job for the snapshot.¶
Call the Get One Restore Job resource to request a snapshot restore.
Issue the following command, replacing:
Name | Type | Description |
---|---|---|
PUBLIC-KEY |
string | Your public API Key for your API credentials. |
PRIVATE-KEY |
string | Your private API Key for your API credentials. |
<OpsManagerHost>:<Port> |
string | URL of your Ops Manager instance. |
GROUP-ID |
string | Unique identifier of your project that contains the source cluster for the restore job. You can find this value in the Project Settings of that project. |
CLUSTER-ID |
string | Unique identifier of your source cluster for the restore job. |
TARGET-GROUP-ID |
string | Unique identifier of your project that contains the target cluster for the restore job. |
TARGET-CLUSTER-ID |
string | Unique identifier of your target cluster for the restore job. |
SNAPSHOT-ID |
string | Unique identifier of the snapshot you want to restore. |
Note
To learn more about restoring snapshots with additional examples, see the Create One Restore Job for One Cluster API resource page.