v5.1_System

Owned by Ramya Raman (Unlicensed)
Last updated: Jun 20, 2024
9 min read

GET system/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns the system configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/system/config

Example Request

GET 

https://192.168.10.53/api/5.1/system/config

 

{ "data": [ { "uuid": "a09f51ba-e9d4-4fea-b411-bd5e20e7177e", "label": "Local", "created": "2022-06-01T08:52:54.562Z", "modified": "2022-06-06T17:00:13.708Z", "attributes": { "priority": "Main", "hosts": [], "local": true } }, { "uuid": "378b0ce7-85be-476d-b7b9-ba0d1a3b02e6", "label": "Remote", "created": "2022-06-01T08:52:54.562Z", "modified": "2022-06-09T13:25:05.300Z", "attributes": { "priority": "Secondary", "hosts": [], "local": false } } ], "metadata": { "item_count": 2, "total_items": 2, "current_page": 1, "sort_by": [ { "label": "ASC" } ], "links": { "current": "http://192.168.10.53/api/5.1/system/config" } } }

 

 

GET system/status

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns the status of system configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/system/status

Example Request

GET 

https://192.168.10.53/api/5.1/system/status

 

{ "data": [ { "uuid": "378b0ce7-85be-476d-b7b9-ba0d1a3b02e6", "status": "N/A", "local": false, "version": "N/A", "applications": [ { "type": "PostgreSQL", "status": "N/A" }, { "type": "External Redis", "status": "N/A" }, { "type": "Internal Redis", "status": "N/A" }, { "type": "Redundancy", "status": "N/A" }, { "type": "Elasticsearch", "status": "N/A" } ] }, { "uuid": "a09f51ba-e9d4-4fea-b411-bd5e20e7177e", "status": "Up", "local": true, "version": "1.2.0-24.06.04.01", "applications": [ { "type": "PostgreSQL", "status": "Up", "version": "14.1 (Debian 14.1-1.pgdg110+1)" }, { "type": "Internal Redis", "status": "Up", "version": "6.2.6" }, { "type": "External Redis", "status": "Up", "version": "6.2.6" }, { "type": "Redundancy", "status": "N/A" }, { "type": "Elasticsearch", "status": "Up", "version": "8.4.0" } ] } ], "metadata": { "item_count": 2, "total_items": 2, "total_pages": 1, "current_page": 1 } }

 

 

GET system/files

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns the system files.

Resource URL

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

Example Request

GET 

https://192.168.10.53/api/5.1/system/files

 

{ "data": [ { "uuid": "c4f461df-0647-5bc4-b9ea-77fa8e8664c8", "label": "240613_020000_120-24060401_backup", "ext": "db", "size": 366619, "created": "2024-06-13T02:00:00.528Z", "modified": "2024-06-13T02:00:02.372Z", "note": null, "attributes": { "file_type": "DB Backup", "timestamp": "2024-06-13T02:00:00.077Z", "postgres_client": 14.12, "postgres_server": 14.1, "version": "120-24060401", "keep": false } }, { "uuid": "6a46e996-ef02-5ca4-b16d-74e9c389745c", "label": "240601_020000_120-rc16-Version-120_41-24052001_backup", "ext": "db", "size": 366160, "created": "2024-06-01T02:00:00.563Z", "modified": "2024-06-01T02:00:02.067Z", "note": null, "attributes": { "file_type": "DB Backup", "timestamp": "2024-06-01T02:00:00.100Z", "postgres_client": 14.12, "postgres_server": 14.12, "version": "120-rc16-Version-120_41-24052001", "keep": false } }, { "uuid": "a4f4139c-5804-5180-a902-a742dd30d2e8", "label": "240607_020000_120-rc16-Version-120_41-24052001_backup", "ext": "db", "size": 366234, "created": "2024-06-07T02:00:00.494Z", "modified": "2024-06-07T02:00:02.410Z", "note": null, "attributes": { "file_type": "DB Backup", "timestamp": "2024-06-07T02:00:00.013Z", "postgres_client": 14.12, "postgres_server": 14.12, "version": "120-rc16-Version-120_41-24052001", "keep": false } } ], "metadata": { "item_count": 3, "total_items": 3, "total_pages": 1, "current_page": 1 } }