Delivery

Update the link information for a Gameserver

post

Body

ipstringRequired

hostnamestringRequired

platformstringRequired

versionstringRequired

Responses

200

application/json

update_availablebooleanRequired

latest_versionstring · nullableOptional

default

Error response

application/json

post/v1/delivery/gameserver/link

POST /v1/delivery/gameserver/link HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ip": "text",
  "hostname": "text",
  "platform": "text",
  "version": "text"
}

{
  "update_available": true,
  "latest_version": null,
  "previously_linked": {
    "ip": "text",
    "host_name": "text",
    "last_linked_at": "2026-08-09T13:21:23.943Z"
  },
  "gameserver": {
    "id": "411486491630370816",
    "name": "text",
    "enabled": true
  }
}

Retrieve the queue of commands to execute for a Gameserver

get

Responses

200

application/json

Represents a command to be executed on a Gameserver

attempt_idstring · flake-idRequiredExample: 411486491630370816

steam_idstring · steam-idOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

Example: 76561197960287930

minecraft_uuidstring · nullableOptional

The Minecraft UUID of the customer, if applicable.

customer_namestring · nullableOptional

The name of the customer, if applicable.

commandstringRequired

The command to be executed.

online_onlybooleanRequired

Indicates if the command should be executed only if the customer is online (Connected to the gameserver)

queued_atstring · date-timeRequired

Represents when the command was queued.

default

Error response

application/json

get/v1/delivery/command-queue

GET /v1/delivery/command-queue HTTP/1.1
Accept: */*

[
  {
    "attempt_id": "411486491630370816",
    "steam_id": "76561197960287930",
    "minecraft_uuid": null,
    "customer_name": null,
    "command": "text",
    "online_only": true,
    "queued_at": "2026-08-09T13:21:23.943Z"
  }
]

Retrieve the queued commands, while supplying the online players for a gameserver

post

Body

steam_idsstring · steam-id[] · nullableOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

Example: 76561197960287930

minecraft_uuidsstring[] · nullableOptional

customer_namesstring[] · nullableOptional

Responses

200

application/json

Represents a command to be executed on a Gameserver

attempt_idstring · flake-idRequiredExample: 411486491630370816

steam_idstring · steam-idOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

Example: 76561197960287930

minecraft_uuidstring · nullableOptional

The Minecraft UUID of the customer, if applicable.

customer_namestring · nullableOptional

The name of the customer, if applicable.

commandstringRequired

The command to be executed.

online_onlybooleanRequired

Indicates if the command should be executed only if the customer is online (Connected to the gameserver)

queued_atstring · date-timeRequired

Represents when the command was queued.

default

Error response

application/json

post/v1/delivery/command-queue

POST /v1/delivery/command-queue HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "steam_ids": [
    "76561197960287930"
  ],
  "minecraft_uuids": [
    "text"
  ],
  "customer_names": [
    "text"
  ]
}

[
  {
    "attempt_id": "411486491630370816",
    "steam_id": "76561197960287930",
    "minecraft_uuid": null,
    "customer_name": null,
    "command": "text",
    "online_only": true,
    "queued_at": "2026-08-09T13:21:23.943Z"
  }
]

Mark commands as executed in bulk

delete

Bodyobject · MarkQueuedCommandAsExecutedDto[]

attempt_idstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/delivery/command-queue

DELETE /v1/delivery/command-queue HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

[
  {
    "attempt_id": "411486491630370816"
  }
]

No content

Mark a queued command as executed

delete

Path parameters

attemptIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/delivery/command-queue/{attemptId}

DELETE /v1/delivery/command-queue/{attemptId} HTTP/1.1
Accept: */*

No content

Mark commands as executed in bulk via a POST request

post

Mark commands as executed in bulk via a POST request. Some HTTP clients don't support bodies in DELETE requests, so for compatibility we have a POST route. Please use the DELETE route if your HTTP client supports it.

Bodyobject · MarkQueuedCommandAsExecutedDto[]

attempt_idstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

post/v1/delivery/command-queue/acknowledge

POST /v1/delivery/command-queue/acknowledge HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

[
  {
    "attempt_id": "411486491630370816"
  }
]

No content

post

Bodyobject · ReportGameServerEventsEntryDto[]

Represents a single game server event entry in a report.

eventstring · enumRequired

Represents the types of events that can occur on a game server.

Possible values:

timestampstring · date-timeRequired

When did this event occur.

Responses

204

No Content

No content

default

Error response

application/json

post/v1/delivery/events

POST /v1/delivery/events HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 176

[
  {
    "event": "invalid",
    "player_join": {
      "ip_address": "127.0.0.1",
      "steam_id": "76561197960287930",
      "minecraft_uuid": null,
      "minecraft_name": null
    },
    "timestamp": "2026-08-09T13:21:23.943Z"
  }
]

No content

PreviousGameserver API NextModels

Last updated 1 month ago

Was this helpful?