admin.backupSiteConfig Method
Admin APIs are extremely complex and should only be used after consulting Bunchball Support.
Creates a backup of your Nitro site. This method is used in the Nitro Studio Backup and Restore process.
admin.backupSiteConfig supports OAuth security. To run this method you must:
- Create an OAuth Client with a backup scope and record the Client Id and Secret Key values.
- Use the Client Id and Secret Key to generate an OAuth token.
- Use the OAuth access token to call the API gateway endpoint at https://api.bunchball.com/backup.
Arguments
Name |
Required |
Type |
Default Value |
Range |
Comments |
---|---|---|---|---|---|
asyncToken |
No |
String |
None |
0 - 255 chars |
Returns any value passed in the response. Often used to identify which request this is the response for. Typically a single request and response. |
created |
YES |
Integer |
0 |
N/A |
The date for the backup. If 0, uses the current date. If non-zero, will try to use a backup with this name/date. |
name |
YES |
String |
System Backup |
0 - 255 chars |
The name for the backup. |
Examples
The following example creates a backup.
curl -X POST \
https://api.bunchball.com/backup \
-H 'authorization: Bearer 6bb666bbbb6b66b666d66666b66b6b66bb6666' \
-H 'cache-control: no-cache' \
-H 'content-type: application/x-www-form-urlencoded' \
-H 'postman-token: 6bbbb66b-b6bb-b6b6-b6b6-b666b6bb666b' \
-d name=1222
The following example gets a backup list.
curl -X GET \
https://api.bunchball.com/backup \
-H 'authorization: Bearer 6bb666bbbb6b66b666d66666b66b6b66bb6666' \
-H 'cache-control: no-cache' \
-H 'postman-token: 6bbbb66b-b6bb-b6b6-b6b6-b666b6bb666b'
See also