Game Servers

Get the associated console for a game server.

GEThttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console

Retrieves the console associated with a game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the game server belongs to.

gameServerIdFlakeIdRequired

The ID of the game server.

Response

200OKGameServerConsoleDto

Represents the remote console connection PayNow keeps open to a game server, used to run delivery commands in game and to read the server's console output.

Show fields

assigned_runner_idstringRequired

The identifier of the PayNow runner currently holding the connection, or empty when none has been assigned.

connection_statusenumRequired

Specifies the state of PayNow's connection to a game server's console.

Possible enum values

unknown
The connection state is not known. This value is typically used as a default or uninitialized state.
disconnected
No connection is open to the console.
connecting
A runner is in the middle of establishing the connection.
connected
The connection is open and commands can be run.
backoff
The last connection attempt failed and the runner is waiting before trying again.

created_atstringRequired

The date and time the console was created.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether PayNow keeps the connection to the console open.

game_server_idFlakeIdRequired

hoststringRequired

The hostname or IP address the game server's console listens on.

portintegerRequired

The port the game server's console listens on.

securebooleanRequired

Indicates whether the connection is made over TLS.

store_idFlakeIdRequired

typeenumRequired

Specifies the console protocol a game server speaks.

Possible enum values

unknown
No console type specified. This value is typically used as a default or uninitialized state.
rust
The WebSocket RCON console of a Rust server.

last_heartbeat_atstringOptional

The date and time the runner last reported the connection alive, or null when it has never connected.

passwordstringOptional

The password used to authenticate with the console, or null when it requires none.

updated_atstringOptional

The date and time the console was last updated, or null when it has never been updated.

updated_byActorDtoOptional

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.getGameServerConsole("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console", headers=headers)

Response200

{
  "assigned_runner_id": "string",
  "connection_status": "unknown",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "game_server_id": "411486491630370816",
  "host": "string",
  "port": 0,
  "secure": true,
  "store_id": "411486491630370816",
  "type": "unknown",
  "last_heartbeat_at": "2024-01-01T00:00:00Z",
  "password": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Create a console for a game server.

POSThttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console

Creates a new console for a game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the game server belongs to.

gameServerIdFlakeIdRequired

The ID of the game server.

Request body

enabledbooleanRequired

Indicates whether PayNow keeps the connection to the console open.

hoststringRequired

The hostname or IP address the game server's console listens on.

portintegerRequired

The port the game server's console listens on.

securebooleanRequired

Indicates whether the connection is made over TLS.

typeenumRequired

Specifies the console protocol a game server speaks.

Possible enum values

unknown
No console type specified. This value is typically used as a default or uninitialized state.
rust
The WebSocket RCON console of a Rust server.

passwordstringOptional

The password used to authenticate with the console, or null when it requires none.

Response

200OKGameServerConsoleDto

Represents the remote console connection PayNow keeps open to a game server, used to run delivery commands in game and to read the server's console output.

Show fields

assigned_runner_idstringRequired

The identifier of the PayNow runner currently holding the connection, or empty when none has been assigned.

connection_statusenumRequired

Specifies the state of PayNow's connection to a game server's console.

Possible enum values

unknown
The connection state is not known. This value is typically used as a default or uninitialized state.
disconnected
No connection is open to the console.
connecting
A runner is in the middle of establishing the connection.
connected
The connection is open and commands can be run.
backoff
The last connection attempt failed and the runner is waiting before trying again.

created_atstringRequired

The date and time the console was created.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether PayNow keeps the connection to the console open.

game_server_idFlakeIdRequired

hoststringRequired

The hostname or IP address the game server's console listens on.

portintegerRequired

The port the game server's console listens on.

securebooleanRequired

Indicates whether the connection is made over TLS.

store_idFlakeIdRequired

typeenumRequired

Specifies the console protocol a game server speaks.

Possible enum values

unknown
No console type specified. This value is typically used as a default or uninitialized state.
rust
The WebSocket RCON console of a Rust server.

last_heartbeat_atstringOptional

The date and time the runner last reported the connection alive, or null when it has never connected.

passwordstringOptional

The password used to authenticate with the console, or null when it requires none.

updated_atstringOptional

The date and time the console was last updated, or null when it has never been updated.

updated_byActorDtoOptional

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "host": "string",
  "port": 0,
  "secure": true,
  "type": "unknown",
  "password": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.createGameServerConsole("411486491630370816", {
  enabled: true,
  host: "string",
  port: 0,
  secure: true,
  type: "unknown",
  password: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "enabled": True,
    "host": "string",
    "port": 0,
    "secure": True,
    "type": "unknown",
    "password": "string",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console", headers=headers, json=payload)

Response200

{
  "assigned_runner_id": "string",
  "connection_status": "unknown",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "game_server_id": "411486491630370816",
  "host": "string",
  "port": 0,
  "secure": true,
  "store_id": "411486491630370816",
  "type": "unknown",
  "last_heartbeat_at": "2024-01-01T00:00:00Z",
  "password": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Update a console for a game server.

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console

Performs a delta update of the console for a game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the game server belongs to.

gameServerIdFlakeIdRequired

The ID of the game server.

Request body

enabledbooleanOptional

Indicates whether PayNow keeps the connection to the console open.

hoststringOptional

The hostname or IP address the game server's console listens on.

passwordstringOptional

The password used to authenticate with the console, or null when it requires none.

portintegerOptional

The port the game server's console listens on.

securebooleanOptional

Indicates whether the connection is made over TLS.

Response

200OKGameServerConsoleDto

Represents the remote console connection PayNow keeps open to a game server, used to run delivery commands in game and to read the server's console output.

Show fields

assigned_runner_idstringRequired

The identifier of the PayNow runner currently holding the connection, or empty when none has been assigned.

connection_statusenumRequired

Specifies the state of PayNow's connection to a game server's console.

Possible enum values

unknown
The connection state is not known. This value is typically used as a default or uninitialized state.
disconnected
No connection is open to the console.
connecting
A runner is in the middle of establishing the connection.
connected
The connection is open and commands can be run.
backoff
The last connection attempt failed and the runner is waiting before trying again.

created_atstringRequired

The date and time the console was created.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether PayNow keeps the connection to the console open.

game_server_idFlakeIdRequired

hoststringRequired

The hostname or IP address the game server's console listens on.

portintegerRequired

The port the game server's console listens on.

securebooleanRequired

Indicates whether the connection is made over TLS.

store_idFlakeIdRequired

typeenumRequired

Specifies the console protocol a game server speaks.

Possible enum values

unknown
No console type specified. This value is typically used as a default or uninitialized state.
rust
The WebSocket RCON console of a Rust server.

last_heartbeat_atstringOptional

The date and time the runner last reported the connection alive, or null when it has never connected.

passwordstringOptional

The password used to authenticate with the console, or null when it requires none.

updated_atstringOptional

The date and time the console was last updated, or null when it has never been updated.

updated_byActorDtoOptional

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "host": "string",
  "password": "string",
  "port": 0,
  "secure": true
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.updateGameServerConsole("411486491630370816", {
  enabled: true,
  host: "string",
  password: "string",
  port: 0,
  secure: true,
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "enabled": True,
    "host": "string",
    "password": "string",
    "port": 0,
    "secure": True,
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console", headers=headers, json=payload)

Response200

{
  "assigned_runner_id": "string",
  "connection_status": "unknown",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "game_server_id": "411486491630370816",
  "host": "string",
  "port": 0,
  "secure": true,
  "store_id": "411486491630370816",
  "type": "unknown",
  "last_heartbeat_at": "2024-01-01T00:00:00Z",
  "password": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Delete an associated game server console.

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console

Deletes the console associated with a game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the game server belongs to.

gameServerIdFlakeIdRequired

The ID of the game server.

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.gameServers.deleteGameServerConsole("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console", headers=headers)

Get console messages for a game server.

GEThttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages

Retrieves recent console messages for a game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the game server belongs to.

gameServerIdFlakeIdRequired

The ID of the game server.

Response

200OKGameServerConsoleMessageDto[]

Show fields

messagestringRequired

timestringRequired

typeenumRequired

Possible enum values

unknown
output
command
response
system

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.getGameServerConsoleMessages("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages", headers=headers)

Response200

[
  {
    "message": "string",
    "time": "2024-01-01T00:00:00Z",
    "type": "unknown"
  }
]

Get Game Servers for a store

GEThttps://api.paynow.gg/v1/stores/{storeId}/gameservers

Retrieves all game servers for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to retrieve game servers for.

Response

200OKGameServerDto[]

Represents a game server in the PayNow system with authentication tokens and linking information.

Show fields

idFlakeIdRequired

created_atstringRequired

The date and time when the game server was created in the system.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether the game server is currently enabled.

linked_toGameServerLinkDtoRequired

hostnamestringRequired

ipstringRequired

platformstringRequired

saved_atstringRequired

versionstringRequired

last_fetched_commands_atstringOptional

last_fetched_commands_from_ipstringOptional

namestringRequired

The display name of the game server.

store_idFlakeIdRequired

updated_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

tokenstringOptional

The authentication token used by the game server to access the PayNow API.

token_reset_atstringOptional

The date and time when the authentication token was last reset, if applicable.

updated_atstringOptional

The date and time when the game server was last updated, if applicable.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/gameservers" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.getGameServers();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/gameservers", headers=headers)

Response200

[
  {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "enabled": true,
    "linked_to": {
      "hostname": "string",
      "ip": "string",
      "platform": "string",
      "saved_at": "2024-01-01T00:00:00Z",
      "version": "string",
      "last_fetched_commands_at": "2024-01-01T00:00:00Z",
      "last_fetched_commands_from_ip": "string"
    },
    "name": "string",
    "store_id": "411486491630370816",
    "updated_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "token": "string",
    "token_reset_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]

Create a new Game Server for a store

POSThttps://api.paynow.gg/v1/stores/{storeId}/gameservers

Creates a new game server in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to create the game server in.

Request body

enabledbooleanRequired

Indicates whether the game server is currently enabled.

namestringRequired

The display name of the game server.

Response

200OKGameServerDto

Represents a game server in the PayNow system with authentication tokens and linking information.

Show fields

idFlakeIdRequired

created_atstringRequired

The date and time when the game server was created in the system.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether the game server is currently enabled.

linked_toGameServerLinkDtoRequired

hostnamestringRequired

ipstringRequired

platformstringRequired

saved_atstringRequired

versionstringRequired

last_fetched_commands_atstringOptional

last_fetched_commands_from_ipstringOptional

namestringRequired

The display name of the game server.

store_idFlakeIdRequired

updated_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

tokenstringOptional

The authentication token used by the game server to access the PayNow API.

token_reset_atstringOptional

The date and time when the authentication token was last reset, if applicable.

updated_atstringOptional

The date and time when the game server was last updated, if applicable.

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/gameservers" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "name": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.createGameServer({
  enabled: true,
  name: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "enabled": True,
    "name": "string",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/gameservers", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "linked_to": {
    "hostname": "string",
    "ip": "string",
    "platform": "string",
    "saved_at": "2024-01-01T00:00:00Z",
    "version": "string",
    "last_fetched_commands_at": "2024-01-01T00:00:00Z",
    "last_fetched_commands_from_ip": "string"
  },
  "name": "string",
  "store_id": "411486491630370816",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "token": "string",
  "token_reset_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Get a Game Server by ID for a store

GEThttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}

Retrieves a game server by the ID for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to retrieve the game server for.

gameServerIdFlakeIdRequired

The ID of the game server.

Response

200OKGameServerDto

Represents a game server in the PayNow system with authentication tokens and linking information.

Show fields

idFlakeIdRequired

created_atstringRequired

The date and time when the game server was created in the system.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether the game server is currently enabled.

linked_toGameServerLinkDtoRequired

hostnamestringRequired

ipstringRequired

platformstringRequired

saved_atstringRequired

versionstringRequired

last_fetched_commands_atstringOptional

last_fetched_commands_from_ipstringOptional

namestringRequired

The display name of the game server.

store_idFlakeIdRequired

updated_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

tokenstringOptional

The authentication token used by the game server to access the PayNow API.

token_reset_atstringOptional

The date and time when the authentication token was last reset, if applicable.

updated_atstringOptional

The date and time when the game server was last updated, if applicable.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.getGameServer("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}", headers=headers)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "linked_to": {
    "hostname": "string",
    "ip": "string",
    "platform": "string",
    "saved_at": "2024-01-01T00:00:00Z",
    "version": "string",
    "last_fetched_commands_at": "2024-01-01T00:00:00Z",
    "last_fetched_commands_from_ip": "string"
  },
  "name": "string",
  "store_id": "411486491630370816",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "token": "string",
  "token_reset_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Update a Game Server By ID for a store

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}

Performs a delta update of a game server by the ID for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to update the game server for.

gameServerIdFlakeIdRequired

The ID of the game server.

Request body

enabledbooleanOptional

Indicates whether the game server is currently enabled.

namestringOptional

The display name of the game server.

Response

200OKGameServerDto

Represents a game server in the PayNow system with authentication tokens and linking information.

Show fields

idFlakeIdRequired

created_atstringRequired

The date and time when the game server was created in the system.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether the game server is currently enabled.

linked_toGameServerLinkDtoRequired

hostnamestringRequired

ipstringRequired

platformstringRequired

saved_atstringRequired

versionstringRequired

last_fetched_commands_atstringOptional

last_fetched_commands_from_ipstringOptional

namestringRequired

The display name of the game server.

store_idFlakeIdRequired

updated_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

tokenstringOptional

The authentication token used by the game server to access the PayNow API.

token_reset_atstringOptional

The date and time when the authentication token was last reset, if applicable.

updated_atstringOptional

The date and time when the game server was last updated, if applicable.

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "name": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.updateGameServer("411486491630370816", {
  enabled: true,
  name: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "enabled": True,
    "name": "string",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "linked_to": {
    "hostname": "string",
    "ip": "string",
    "platform": "string",
    "saved_at": "2024-01-01T00:00:00Z",
    "version": "string",
    "last_fetched_commands_at": "2024-01-01T00:00:00Z",
    "last_fetched_commands_from_ip": "string"
  },
  "name": "string",
  "store_id": "411486491630370816",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "token": "string",
  "token_reset_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Delete a Game Server by ID for a store

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

gameServerIdFlakeIdRequired

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.gameServers.deleteGameServer("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}", headers=headers)

Reset the API Key Token for a Game Server for a store

POSThttps://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/reset-token

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

gameServerIdFlakeIdRequired

Response

200OKGameServerDto

Represents a game server in the PayNow system with authentication tokens and linking information.

Show fields

idFlakeIdRequired

created_atstringRequired

The date and time when the game server was created in the system.

created_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

enabledbooleanRequired

Indicates whether the game server is currently enabled.

linked_toGameServerLinkDtoRequired

hostnamestringRequired

ipstringRequired

platformstringRequired

saved_atstringRequired

versionstringRequired

last_fetched_commands_atstringOptional

last_fetched_commands_from_ipstringOptional

namestringRequired

The display name of the game server.

store_idFlakeIdRequired

updated_byActorDtoRequired

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

tokenstringOptional

The authentication token used by the game server to access the PayNow API.

token_reset_atstringOptional

The date and time when the authentication token was last reset, if applicable.

updated_atstringOptional

The date and time when the game server was last updated, if applicable.

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/reset-token" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.gameServers.resetGameServerToken("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/gameservers/{gameServerId}/reset-token", headers=headers)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "enabled": true,
  "linked_to": {
    "hostname": "string",
    "ip": "string",
    "platform": "string",
    "saved_at": "2024-01-01T00:00:00Z",
    "version": "string",
    "last_fetched_commands_at": "2024-01-01T00:00:00Z",
    "last_fetched_commands_from_ip": "string"
  },
  "name": "string",
  "store_id": "411486491630370816",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "token": "string",
  "token_reset_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}