Backends¶

GET /api/v1/config/backends/¶

Gets the list of deployed backends for this instance

Example request:

GET /api/v1/config/backends/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "type": "Phone Vendors",
}

Request JSON Object:

type (string) – (Optional) the type of backend searched for. If not given, all backend tpes will be searched for

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "backends": [
      {
         "type": "Phone Vendors",
         "name": "Yealink",
         "canDoAuth": false
      }
  ]
}

Response JSON Object:

backends (array) – a list of objects as defined as Backend Object

Status Codes:

200 OK – no error
404 Not Found – no backend could be found.

Backend Object¶

Name	Type	Description
type	String	The type of the backend (Accordingly to APIO settings).
name	String	The name of the backend.
canDoAuth	Boolean	Can this backend be used to perform authentication.