4.3.12. AppList

Description

The method returns the list of running and inactive probes of a project

Request

{
  "user_id":(number),
  "methods":[
    {
      "method":"AppList",
      "params":{
        "project_id":(number),
        "app_status":(string),
      }
    }
  ]
}

where:

• user_id — an integer value, a user identifier;

• project_id — an integer value, a user project identifier;

• app_status (optional field) — a string, an information request about:

  • active — running probes;

  • stopped — inactive probes;

  • all — default value, all probes.

Reply

{
  "reply":[
    {
      "method":"AppList",
      "result":[
        {
          "app_id":(number),
          "name":(string),
          "alive":(boolean)
        }
      ]
    }
  ]
}

where:

• app_id — an integer value, a probe identifier;

• name — a string, a probe name;

• alive — a logical type, probe status:

  • true — a probe is running;

  • false — a probe is stopped.

Example

Request by the cURL utility

curl http://172.16.1.41/ctrl_api/v1/json \
   -H "Content-Type: application/json" \
   --data '{"user_id":1,"methods":[{"method":"AppList","params":{"project_id":2}}]}'

Reply

 {
   "reply": [
     {
       "method": "AppList",
       "result": [
         {
           "app_id": 1,
           "name": "Probe Ubuntu 20",
           "alive": true
         },
         {
           "app_id": 2,
           "name": "Probe Ubuntu 22",
           "alive": true
         }
       ]
     }
   ]
 }