Get a list of servers

GET

/system/servers

curl --request GET \
  --url 'https://example.com/api/v1/system/servers?limit=50&offset=0' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Query Parameters

level

integer

Set detail level of return value. Usually ranges from 0 to 2.

limit

integer

default: 50

Maximum number of results to return

offset

integer

0

Index of the first element to return

match

string

Match by substring

matchFields

string

Comma separated list of attributes to restrict matching to.

sort

string

/^(ID|hostname|extname|users)(,(a|de)sc)?$/

Sort by attribute. Can be given multiple times.

hostname

string

Filter by hostname

description

string

Filter by extname

users

Array<integer>

<= 2 items

Filter by users

Responses

200

List of servers returned

Media typeapplication/json

object

data

Array<object>

object

ID

Unique ID of the object

integer

hostname

Internal hostname of the server

string

extname

External address of the server

string

users

Number of users on the server

integer

domains

Number of domains on the server

integer

Example^generated

{
  "data": [
    {
      "hostname": "example",
      "extname": "example"
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}