Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
GET

POST system/files/

download

command/

{uuid}

backup

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an

POST

Back’s up system files, creating an asynchronous task.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/system/files/download/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired file to download.

command/backup

Example Request

GETPOST 

  1. https://192.168.10.53/api/5.0/system/files/download/dcb2267b-0595-5bab-a9af-37d81f85f0d8command/backup

Response

Code Block
languagejson

DELETE users/config/{uuid}

{
    "data": {
        "uuid": "f3341f06-6238-4cc6-9f02-eceb2b478a80",
        "created": 1644427178999,
        "type": "Db Backup",
        "state": "Running",
        "progress": 0,
        "attributes": {},
        "result": null
    },
    "metadata": {}
}

GET system/files

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific users configuration

GET

Returns all the available system files after successful backup.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/users/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the users config to be deleted.

system/files

Example Request

DELETE GET

  1. https://192.168.10.53/api/5.0/users/config/fe5e61a7-ead6-4bd1-983e-8322073995b1system/files

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "2e95e36a-3976-55ab-be6f-ac83e977564a",
            "label": "220323_123131_22031701_backup",
            "ext": ".db",
            "type": "DB Backup",
            "size": 222953,
            "created": "2022-03-23T12:31:31.822Z",
            "modified": "2022-03-23T12:31:32.109Z",
            "version": "22.03.17.01",
            "success": truepostgres_client": 14.2,
            "postgres_server": 14.1
        }
    ],
    "metadata": {
        "total_items": 1,
        "items_per_page": 1,
        "total_pages": 1,
        "current_page": 1,
        "item_count": 1
    }
}
 
POST system/files/command/restore/
backup
{uuid}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
POST
Back’s up system files, configured according to the attached data requestRestores system files that are backed up. Please use the uuid of the system files obtained from GET system/files.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/command/backup/restore/{uuid}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired system file.
Example Request
POST 
  1. https://192.168.10.53/api/5.0/system/files/command/backuprestore/4141158b-b46a-5898-b125-d97f283ca8bf
Response
 Code Block
languagejson
{
    "data": {
        "uuid": "f3341f06bbf7811d-6238ffd9-4cc642bc-9f02b3e6-eceb2b478a80f776259498de",
        "created": 16444271789991647265209073,
        "type": "Db BackupRestore",
        "state": "Running",
        "progress": 0,
        "attributes": {
            "file": "827ff48c-c242-5cb4-aa56-94ff66026be6"
        },
        "result": null
    },
    "metadata": {}
}
GET system/files/download/{uuid}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Downloads the system file in binary format. 
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/download/{uuid}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired system file.
Example Request
GET
  1. https://192.168.10.53/api/5.0/system/files/download/4141158b-b46a-5898-b125-d97f283ca8bf
Response
System file in a binary format. 
DELETE system/files/{uuid}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
DELETE
Deletes the specific system file. 
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/{uuid}
Parameters
Parameter
Data Type
Description
uuid
(required)
string
The UUID of the desired system file.
Example Request
DELETE
  1. https://192.168.10.53/api/5.0/system/files/dcb2267b-0595-5bab-a9af-37d81f85f0d8
Response
 Code Block
languagejson
{
    "data": {
        "success": true
    },
    "metadata": {}
}