Backup

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

Endpoint: /organizations/backup/list/{level}/{sid}/{serializer}/

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Response: 200

# 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

Endpoint: /organizations/backup/list/{level}/{sid}/{serializer}/

Each POST creates one backup. No form data required.

Parameter: level (path, string)

organization

Parameter: sid (path, string)

organization sid

Parameter: serializer (path, string)

Parameter: token (header, string)

Response: 200

{
    "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

Endpoint: /organizations/backup/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 200

{
    "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

Endpoint: /organizations/backup/detail/{sid}/

Parameter: sid (path, string)

Parameter: token (header, string)

Response: 204

{}