Skip to content
GAMPEONCreate
New project

Register a server

POST
/v1/servers
curl --request POST \
--url https://api.gampeon.com/v1/servers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'

Returns the server key once. The game server sends it as x-server-key with every heartbeat. At most 10 servers per account.

Not available with access tokens.

Rate limit: 10 per hour per account.

Media typeapplication/json
object
name
required
string
>= 3 characters <= 64 characters

Example generated

{
"name": "example"
}

Server registered

Media typeapplication/json
object
id
required
string
name
required
string
serverKey
required

Secret key. Shown once; store it on the game server only.

string

Example generated

{
"id": "example",
"name": "example",
"serverKey": "example"
}

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

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

Error codes: token_not_allowed

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

Error codes: server_limit_reached

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

Limit: 10 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"
}

Report a problem with this pageOther ways to give feedback