Change a server

PATCH

/v1/servers/{id}

curl --request PATCH \
  --url https://api.gampeon.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "website": "example", "project": "" }'

• Production

Only the owner. Fields you leave out stay unchanged.

Not available with access tokens.

Rate limit: 120 edits per hour per account.

Authorizations

• session

Parameters

Path Parameters

id

required

string format: uuid

Server ID

Request Body^required

Media typeapplication/json

object

name

string

>= 3 characters <= 64 characters

description

string

<= 2000 characters

website

Website. Only https:// URLs, empty string removes it.

string

<= 200 characters /^$|^https://[^\s<>"]+$/

project

One of:

string

string

/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/

null

null

unknown

Slug of a project you work on (owner, studio member). null or an empty string removes the link.

Responses

200

Updated

Media typeapplication/json

object

id

required

string

name

required

string

description

required

string

website

required

One of:

string

string

null

null

project

required

One of:

object

object

slug

required

string

title

required

string

null

null

Example ^generated

{
  "id": "example",
  "name": "example",
  "description": "example",
  "website": "example",
  "project": {
    "slug": "example",
    "title": "example"
  }
}

400

Error codes: invalid_field

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: token_not_allowed, forbidden

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found, project_not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 120 edits per hour per account. Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}