Backup

API for Backup object

Method & Permission

API

GET

POST

PUT

PATCH

DELETE

Backup List

Admin

Admin

-

-

-

Backup Detail

Admin

-

-

Admin*

Admin

*Only the name and description can be updated.

get
Backup List

{{ base_url }} /organizations/backup/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Response
200: OK
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Test Backup"
}
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Test Backup",
"status": "In Progress",
"versions": xxx,
"files": xxx,
"file_size": "xxx bytes",
"date_created": "2020-02-10T07:32:03.157779Z",
"change_permission": true
}
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Test Backup",
"description": "",
"status": "In Progress",
"versions": 382,
"files": 21,
"price": "$xxx",
"file_size": "xxx bytes",
"file_path": "xxx",
"date_created": "2020-02-10T07:32:03.157779Z",
"change_permission": true
}
]
}

post
Backup List

{{ base_url }} /organizations/backup/list/{level}/{sid}/{serializer}/
Each POST creates one backup. No form data required.
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
Headers
token
required
string
Response
200: OK
{
"sid": "xxx",
"name": "Test Backup",
"description": "",
"status": "In Progress",
"versions": 382,
"files": 21,
"price": "$xxx",
"file_size": "xxx bytes",
"file_path": "xxx",
"date_created": "2020-02-10T07:32:03.157779Z",
"change_permission": true
}

get
Backup Detail

{{ base_url }} /organizations/backup/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Response
200: OK
{
"sid": "xxx",
"name": "Test Backup",
"description": "",
"status": "In Progress",
"versions": 382,
"files": 21,
"price": "$xxx",
"file_size": "xxx bytes",
"file_path": "xxx",
"date_created": "2020-02-10T07:32:03.157779Z",
"change_permission": true
}

delete
Backup Detail

/organizations/backup/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
Headers
token
required
string
Response
204: No Content
{}