Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

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

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

Expand
titleRESPONSE
Code Block
languagejson
{ "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"

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

Expand
titleRESPONSE
Code Block
languagejson
{
    "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

Expand
titleRESPONSE
Code Block
languagejson
{
    "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,
            "labelversion": "Remote1.2.0-24.06.04.01",
            "created": "2022-06-01T08:52:54.562Z",applications": [
                {
                    "modifiedtype": "2022-06-09T13:25:05.300ZPostgreSQL",
            "attributes": {       "status": "Up",
        "priority": "Secondary",           "version": "14.1 (Debian 14.1-1.pgdg110+1)"
  "hosts": [],              },
    "local": false           {
 }         }     ],     "metadatatype": { "Internal Redis",
          "item_count": 2,         "total_itemsstatus": 2,"Up",
            "current_page": 1,        "version": "sort_by": [6.2.6"
             {   },
             "label": "ASC"  {
          }         ], "type": "External Redis",
      "links": {             "currentstatus": "http://192.168.10.53/api/5.1/system/config": "Up",
        }     }
}

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

Expand
titleRESPONSE
Code Block
languagejson
{
    "data": [       "version": "6.2.6"
                },
                {
                    "uuidtype": "378b0ce7-85be-476d-b7b9-ba0d1a3b02e6",Redundancy",
                    "status": "N/A",
               "local": false},
                "version": "N/A",{
                    "applicationstype": ["Elasticsearch",
                     {"status": "Up",
                    "typeversion": "PostgreSQL8.4.0",
                }
   "status": "N/A"        ]
        },
    ],
    "metadata": {
     {   "item_count": 2,
        "total_items": 2,
        "typetotal_pages": "External Redis", 1,
        "current_page": 1
               "status": "N/A"
    }
}

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

Expand
titleRESPONSE
Code Block
languagejson
{
    "data": [
     },   {
             {
     "uuid": "c4f461df-0647-5bc4-b9ea-77fa8e8664c8",
              "typelabel": "Internal Redis",
       240613_020000_120-24060401_backup",
            "statusext": "N/Adb",
                }"size": 366619,
                {
       "created": "2024-06-13T02:00:00.528Z",
            "typemodified": "Redundancy",
       2024-06-13T02:00:02.372Z",
            "statusnote": "N/A"null,
            "attributes": {
  },              "file_type":   {"DB Backup",
                    "typetimestamp": "Elasticsearch",
   2024-06-13T02:00:00.077Z",
                "statuspostgres_client": "N/A"14.12,
                }
"postgres_server": 14.1,
           ]     "version": "120-24060401",
  },         {     "keep":  false
     "uuid": "a09f51ba-e9d4-4fea-b411-bd5e20e7177e",       }
       "status": "Up", },
        {
            "localuuid": true"6a46e996-ef02-5ca4-b16d-74e9c389745c",
            "versionlabel": "1.2.0-24.06.04.01240601_020000_120-rc16-Version-120_41-24052001_backup",
            "applicationsext": ["db",
            "size": 366160,
  {          "created": "2024-06-01T02:00:00.563Z",
            "typemodified": "PostgreSQL",
       2024-06-01T02:00:02.067Z",
            "statusnote": "Up",
       null,
            "versionattributes": "14.1 (Debian 14.1-1.pgdg110+1)"{
                "file_type": "DB }Backup",
                {
   "timestamp": "2024-06-01T02:00:00.100Z",
                "typepostgres_client": "Internal Redis",
   14.12,
                "statuspostgres_server": "Up",
   14.12,
                "version": "6.2.6""120-rc16-Version-120_41-24052001",
                "keep": false
     },       }
        },
{        {
            "typeuuid": "External Redisa4f4139c-5804-5180-a902-a742dd30d2e8",
                    "status"label": "Up",
       240607_020000_120-rc16-Version-120_41-24052001_backup",
            "versionext": "6.2.6db",
            "size": 366234,
  },          "created": "2024-06-07T02:00:00.494Z",
      {           "modified": "2024-06-07T02:00:02.410Z",
            "typenote": "Redundancy"null,
 
                  "status"attributes": "N/A"{
                }"file_type": "DB Backup",
                {
   "timestamp": "2024-06-07T02:00:00.013Z",
                "typepostgres_client": "Elasticsearch",
 14.12,
                  "statuspostgres_server": "Up"14.12,
                    "version": "8.4.0"120-rc16-Version-120_41-24052001",
                "keep": }false
            ]}
        }
    ],
    "metadata": {
        "item_count": 23,
        "total_items": 23,
        "total_pages": 1,
        "current_page": 1
    }
}