v5.1_System

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

RESPONSE

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

RESPONSE

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