Update server

PATCH

/system/servers/{ID}

curl --request PATCH \
  --url https://example.com/api/v1/system/servers/1 \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "hostname": "example", "extname": "example" }'

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

ID

required

integer

ID of the object

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

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

{
  "hostname": "example",
  "extname": "example"
}

Responses

200

Server updated

Media typeapplication/json

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

{
  "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"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "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"
}