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.
Backup List
GET
{{ base_url }} /organizations/backup/list/{level}/{sid}/{serializer}/
Path Parameters
Name
Type
Description
level
string
organization
sid
string
organization sid
serializer
string
Headers
Name
Type
Description
token
string
# 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
}
]
}
Backup List
POST
{{ base_url }} /organizations/backup/list/{level}/{sid}/{serializer}/
Each POST creates one backup. No form data required.
Path Parameters
Name
Type
Description
level
string
organization
sid
string
organization sid
serializer
string
Headers
Name
Type
Description
token
string
{
"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
}
Backup Detail
GET
{{ base_url }} /organizations/backup/detail/{sid}/
Path Parameters
Name
Type
Description
sid
string
Headers
Name
Type
Description
token
string
{
"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
}
Backup Detail
DELETE
/organizations/backup/detail/{sid}/
Path Parameters
Name
Type
Description
sid
string
Headers
Name
Type
Description
token
string
{}
Last updated