Servers

Get all servers

Request

Definition

GET /api/v1/servers

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Query string parameters

Parameter	Type	Required	Description
paginate	boolean	No	If the result must be formatted in a page.
page	integer	Yes if paginate is true	Page index.
page_size	integer	Yes if paginate is true	Number of items displayed per page.

Response

Status codes

Status code	Message
200	"List of servers"
403	"Forbidden"

Corpo

Attributes

• data.servers.address string

  Server IP address.

• data.servers.port integer

  Port on which the server is listening.

• data.servers.description string

  Server description.

Example

{
"data": {
    "servers": [
    {
        "address": "10.1.2.3",
        "description": "Server web 1",
        "port": 433
    },
    {
        "address": "10.2.3.4",
        "description": "Server web 2",
        "port": 433
    }
    ]
},
"message": "List of servers",
"status": "ok"
}