The Backup API lets you work with your Gearset data backups programmatically - starting a backup run on demand, checking how a run is getting on, and erasing records to meet your compliance and legal requirements. Instead of doing these things by hand in the Gearset app, you can build them into your own tooling and workflows.
Considerations and requirements
You need any tier of a Gearset Backup license to use the Backup API.
The Backup API is currently only supported for personal access tokens - the Backup scope isn't available on team access tokens.
The Backup API is not currently available for teams in our HIPAA data residency region.
Making your first Backup API requests
To start with, you need an API access token with the Backup scope, which you can generate by following our tutorial Creating a Gearset API access token.
Once you have that, you're ready to start making requests. The Backup API is a REST API that accepts JSON messages over HTTPS, so we'll be using the curl program to demonstrate its use. The curl program is installed by default on Linux, Windows, and macOS command lines. Our full API reference gives a list of the endpoints available, and also lets you run them.
Finding your backup job ID
Requests are made against a specific backup job, so first we need the ID of the job you want to work with. Navigate to the Data backup jobs page in Gearset and find the job you are interested in. You can copy the job ID to the clipboard with the Copy job ID button:
What you can do
Running a backup job with the Backup API - start a run on demand and follow it through to completion
Handling record removal requests with the Backup API - schedule an erasure request and track ithedule an erasure request and track it