Skip to main content
API docs by Redocly

Payload Local API (0.0.1)

Download OpenAPI specification:Download

The Payload Local API available in your running payloads. It provides an interface between your game server and the IMS zeuz orchestration service.

Getting started with IMS zeuz

Warning

The Payload Local API is starting up at the same time as your game server, and may not be initially available. Use a retry mechanism to ensure the request is successful.

OpenAPI Best practices

The Payload local API is using the OpenAPI standard, it is advised to use an OpenAPI client generator for the language your game server uses. See a list of OpenAPI client generators.

Address

The Payload Local API address can be obtained using an environment variable: http://${ORCHESTRATION_PAYLOAD_API}.

Authentication

As the Payload Local API is only accessible from within the payload, it does not require authentication.

PayloadLocal

Get Payload details

Retrieve details of the current payload, including metadata and status

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Payload is Ready

Call when the GameServer is ready to accept connections

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Add Payload Annotation

Add an Annotation to the current Payload

Request Body schema: application/json
key
required
string

A valid annotation key:

  • must be 59 characters or less (cannot be empty),
  • must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.
value
required
string

Annotation value. Can have arbitrary data. Can be used to e.g. pass custom data to a matchmaker.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

Add Payload Label

Add a Label to the current Payload

Request Body schema: application/json
key
required
string

A valid label key:

  • must be 59 characters or less (cannot be empty),
  • must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.
value
required
string

A valid label value:

  • must be 63 characters or less (can be empty),
  • unless empty, must begin and end with an alphanumeric character ([a-z0-9A-Z]),
  • could contain dashes (-), underscores (_), dots (.), and alphanumerics between.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "request_id": "string"
}

SessionManagerLocal

Retrieve Session Config

Retrieves the Session Config that was set by the Game Client when creating the session

Responses

Response samples

Content type
application/json
{
  • "config": "string"
}

Retrieve Session Status

Responses

Response samples

Content type
application/json
{
  • "player_count": "8",
  • "game_mode": "free-for-all"
}

Set Session Status

Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "player_count": "8",
  • "game_mode": "free-for-all"
}