Configuring the external API key and secret
The external API key and secret are used by the Spanning backup process to access Salesforce data. The key and secret were configured during Spanning Backup for Salesforce installation. Use this procedure as needed to view or modify the API secret. You also need the secret to make calls to the Spanning Backup for Salesforce public API.
To view or modify the external API secret
- Log into Spanning Backup for Salesforce.
- Click Settings > Backup & Security.

- Scroll down to the External API Key & Secret section. Do any of the following:
- To view the secret, click Reveal Secret.
- To delete the secret, click Delete Secret, then click Confirm.
- To generate a new secret, click Generate New Secret, then click Confirm.
Using the Spanning Backup for Salesforce public API
Spanning Backup for Salesforce provides a public API. You can use the API to do the following:
- Schedule on-demand backups.
- Get a list of backups and their statuses. For example, you can build a status report that covers multiple orgs.
- Check currently running jobs.
- Run a metadata comparison.
Every API call requires the external API secret. To get the secret, a Spanning administrator clicks Generate New Secret and then Reveal Secret as described in the previous procedure. Copy the secret and store it in a secure location.
Send API calls to the endpoint for the data center region you selected when you installed Spanning Backup for Salesforce:
- US data center:
https://sf-us.spanningbackup.com/api/v1 - EU data center:
https://sf-eu.spanningbackup.com/api/v1
For details about the available API calls, see the Spanning Backup for Salesforce API Swagger documentation. If you have questions about the API, contact KaseyaOne support.
