PayNow

GameServerConsoleDto

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.

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