Organization API: Customer Portal: Backups
The 6 Organization API operations for backups.
Part of Customer Portal.
GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
application/json
| Field |
Type |
Required |
name |
string |
yes |
ignored_files |
array of string or null |
no |
is_locked |
boolean |
no |
| Status |
Meaning |
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups/{backup_uuid}
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
backup_uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups/{backup_uuid}/download
A short-lived signed URL the browser fetches the archive from directly.
The permission has existed since subusers shipped; this is the route it
was waiting for. The archive streams from the node, never through here.
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
backup_uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups/{backup_uuid}/lock
Keep a backup, or release it. A locked backup cannot be deleted.
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
backup_uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/backups/{backup_uuid}/restore
| Name |
In |
Type |
Required |
uuid |
path |
string |
yes |
backup_uuid |
path |
string |
yes |
org_slug |
path |
string |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
