PayNow

Game Server

Game Servers represent individual servers that you host. When a product is assigned to a customer's inventory, the commands you configure can run on one or more game servers. Game servers can be associated in the product's configuration.

Game servers have their own type of authentication used for accessing store data from a plugin.

Endpoints

POST
/stores/{store.id}/gameservers
GET
/stores/{store.id}/gameservers
GET
/stores/{store.id}/gameservers/{gameserver.id}
PATCH
/stores/{store.id}/gameservers/{gameserver.id}
POST
/stores/{store.id}/gameservers/{gameserver.id}/reset-token
DELETE
/stores/{store.id}/gameservers/{gameserver.id}

The Game Server object

  • Fields

  • Name
    id
    Type
    flake
    Tags
    Description

    id of the game server

  • Name
    store_id
    Type
    flake
    Tags
    Description

    id of the store the game server belongs to

  • Name
    name
    Type
    string
    Tags
    Description

    name of the game server

  • Name
    enabled
    Type
    boolean
    Tags
    Description

    boolean indicating if the game server is enabled

  • Name
    token
    Type
    string
    Tags
    NULLABLE
    Description

    token for the game server

  • Name
    token_reset_at
    Type
    time
    Tags
    NULLABLE
    Description

    time when the token was reset

  • Name
    created_by
    Type
    user
    Tags
    Description

    the user that created the game server

  • Name
    created_at
    Type
    time
    Tags
    Description

    time when the game server was created

  • Name
    updated_by
    Type
    user
    Tags
    NULLABLE
    Description

    the user that most recently updated the game server

  • Name
    updated_at
    Type
    time
    Tags
    NULLABLE
    Description

    time when the game server was last updated

The Game Server object

{
    "id": "124249183568797696",
    "store_id": "12345",
    "name": "GameServer1",
    "enabled": true,
    "token": "exampletoken12345",
    "token_reset_at": "2023-10-25T14:12:00Z",
    "created_by": {
		"id": "11084680073842688",
		"email": "[email protected]",
		"first_name": "Example",
		"last_name": "Exampleson",
		"created_at": "2023-04-13T01:26:04Z"
	},
    "created_at": "2023-10-23T14:12:00Z",
    "updated_by": {
    "id": "11084680073842688",
    "email": "[email protected]",
    "first_name": "Example",
    "last_name": "Exampleson",
    "created_at": "2023-04-13T01:26:04Z"
},
    "updated_at": "2023-10-25T14:12:00Z"
}

Create Game Server

This endpoint creates a new game server with the provided details for the specified store ID, and returns the created game server object.

  • Fields

  • Name
    name
    Type
    string
    Tags
    Description

    name of the game server

  • Name
    enabled
    Type
    boolean
    Tags
    Description

    boolean indicating if the game server should be enabled

Returns

Returns a Game Server object.

Request

POST
/stores/{store.id}/gameservers

Create Game Server Request

{
	"id": "124249183568797696",
	"store_id": "12345",
	"name": "GameServer1",
	"enabled": true,
	"token": "exampletoken12345",
	"token_reset_at": "2023-10-25T14:12:00Z",
	"created_by": {
		"id": "11084680073842688",
		"email": "[email protected]",
		"first_name": "Example",
		"last_name": "Exampleson",
		"created_at": "2023-04-13T01:26:04Z"
	},
	"created_at": "2023-10-23T14:12:00Z",
	"updated_by": {
		"id": "11084680073842688",
		"email": "[email protected]",
		"first_name": "Example",
		"last_name": "Exampleson",
		"created_at": "2023-04-13T01:26:04Z"
	},
	"updated_at": "2023-10-25T14:12:00Z"
}

Get Game Servers

This endpoint fetches a list of all game servers associated with the specified store ID.

Returns

Returns an array of Game Server objects.

Request

GET
/stores/{store.id}/gameservers

Get Game Servers Response

[
	{
		"id": "124249183568797696",
		"store_id": "12345",
		"name": "GameServer1",
		"enabled": true,
		"token": "exampletoken12345",
		"token_reset_at": null,
		"created_by": {
			"id": "11084680073842688",
			"email": "[email protected]",
			"first_name": "Example",
			"last_name": "Exampleson",
			"created_at": "2023-04-13T01:26:04Z"
		},
		"created_at": "2023-10-25T14:12:00Z",
		"updated_by": null,
		"updated_at": null
	},
	{
		"id": "124249183568797697",
		"store_id": "12345",
		"name": "GameServer2",
		"enabled": false,
		"token": "exampletoken67890",
		"token_reset_at": null,
		"created_by": {
			"id": "11084680073842688",
			"email": "[email protected]",
			"first_name": "Example",
			"last_name": "Exampleson",
			"created_at": "2023-04-13T01:26:04Z"
		},
		"created_at": "2023-10-25T14:15:00Z",
		"updated_by": null,
		"updated_at": null
	}
]

Get Game Server

This endpoint fetches a single game server based on the provided game server ID.

Returns

Returns a Game Server object.

Request

GET
/stores/{store.id}/gameservers/{gameserver.id}

Get Game Server Response

{
    "id": "124249183568797696",
    "store_id": "12345",
    "name": "GameServer1",
    "enabled": true,
    "token": "exampletoken12345",
    "token_reset_at": null,
    "created_by": {
        "id": "11084680073842688",
        "email": "[email protected]",
        "first_name": "Example",
        "last_name": "Exampleson",
        "created_at": "2023-04-13T01:26:04Z"
    },
    "created_at": "2023-10-25T14:12:00Z",
    "updated_by": null,
    "updated_at": null
}

Update Game Server

This endpoint updates the details of a game server based on the provided game server id.

  • Fields

  • Name
    name
    Type
    string?
    Tags
    OPTIONAL
    Description

    new name of the game server

  • Name
    enabled
    Type
    boolean?
    Tags
    OPTIONAL
    Description

    boolean indicating if the game server should be enabled

Returns

Returns a Game Server object.

Request

PATCH
/stores/{store.id}/gameservers/{gameserver.id}

Update Game Server Request

{
    "name": "UpdatedGameServer",
    "enabled": false
}

Update Game Server Response

{
    "id": "124249183568797696",
    "store_id": "12345",
    "name": "UpdatedGameServer",
    "enabled": false,
    "token": "exampletoken12345",
    "token_reset_at": "2023-10-25T14:12:00Z",
    "created_by": {
        "id": "11084680073842688",
        "email": "[email protected]",
        "first_name": "Example",
        "last_name": "Exampleson",
        "created_at": "2023-04-13T01:26:04Z"
    },
    "created_at": "2023-10-25T14:12:00Z",
    "updated_by": {
        "id": "11084680073842688",
        "email": "[email protected]",
        "first_name": "Example",
        "last_name": "Exampleson",
        "created_at": "2023-04-13T01:26:04Z"
    },
    "updated_at": "2023-10-25T14:12:00Z"
}

Reset Game Server Token

This endpoint resets the token of a specified game server and returns the updated game server object with a new token.

Returns

Returns a Game Server object.

Request

POST
/stores/{store.id}/gameservers/{gameserver.id}/reset-token

Reset Game Server Token Response

{
    "id": "124249183568797696",
    "store_id": "12345",
    "name": "GameServerName",
    "enabled": true,
    "token": "newexampletoken12345",
    "token_reset_at": "2023-10-25T14:12:00Z",
    "created_by": {
        "id": "11084680073842688",
        "email": "[email protected]",
        "first_name": "Example",
        "last_name": "Exampleson",
        "created_at": "2023-04-13T01:26:04Z"
    },
    "created_at": "2023-10-25T14:12:00Z",
    "updated_by": null,
    "updated_at": null
}

Delete Game Server

Deletes a specified game server based on the provided game server ID.

Returns

Returns HTTP 204 indicating that the game server has been successfully deleted.

Request

DELETE
/stores/{store.id}/gameservers/{gameserver.id}

Response

HTTP 204