Key/Value Store

Manages arbitrary data persisted for game clients and game servers.

Read KVStore data

Read KVStore data for the specified keys and from the specified, by the headers passed, store.

Data can be read from either the client or server store by both the user and unreal server or service accounts. Client store data can only be written by the user who's store it is but can be read by the user and an unreal server or service account. The server store can only be written by the unreal server or service account but read by both the user and server.

POSThttps://your-organization-id.m2worlds.io/api/kvstore/read/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

id*string

The ID of the user who's store is being accessed

store*any of

Client or Server KV Store

enumenum

key*string

The key of the value of interest

Response

2004XX

The response for a KV Store read request.

Body

application/json

status*any of

Indicates if the request key was found or not.

enumenum

id*string

The ID of the user who's store is being accessed

store*any of

Client or Server KV Store

enumenum

object*KvstoreShape (object)

Generic shape of a kvstore object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/kvstore/read/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "x-m2-launch-context-id": "text",
      "x-m2-world-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "store": "kvstoreClient",
        "key": "text"
      }
    ]),
});
const data = await response.json();

Response

2004XX

[
  {
    "status": "ok",
    "id": "text",
    "store": "kvstoreClient",
    "object": {
      "key": "text"
    }
  }
]

Upsert KVStore data

Upsert KVStore data for the specified keys and from the specified, by the headers passed, store. Any existing data in the given store, key for a user will be overwritten.

Data can be read from either the client or server store by both the user and unreal server or service accounts. Client store data can only be written by the user who's store it is but can be read by the user and an unreal server or service account. The server store can only be written by the unreal server or service account but read by both the user and server.

POSThttps://your-organization-id.m2worlds.io/api/kvstore/upsert/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

id*string

The ID of the user who's store is being accessed

store*any of

Client or Server KV Store

enumenum

key*string

The key of the value of interest

data*any

The data to upsert against the passed key in the specified store

Response

2004XX

The response for a KV Store upsert request. Object contains the upserted data.

Body

application/json

id*string

The ID of the user who's store is being accessed

store*any of

Client or Server KV Store

enumenum

object*KvstoreShape (object)

Generic shape of a kvstore object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/kvstore/upsert/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "x-m2-launch-context-id": "text",
      "x-m2-world-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "store": "kvstoreClient",
        "key": "text"
      }
    ]),
});
const data = await response.json();

Response

2004XX

[
  {
    "id": "text",
    "store": "kvstoreClient",
    "object": {
      "key": "text"
    }
  }
]

Clear KVStore data

Deletes all the KVStore data except the keys that are specified in the keysToIgnore array.

This will clear both the client and server data.

It will clear data in the store specific to the headers passed, and will not clear data in children stores. i.e. clearing the organization store will not have an impact on the project's, launch context's and worlds store's.

POSThttps://your-organization-id.m2worlds.io/api/kvstore/delete/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

keysToIgnorearray of string

An array of keys to ignore when clearing the store

store*any of

Client or Server KV Store

enumenum

Response

2044XX

Indicates the KV Store was successfully cleared.

Body

application/json

PostKvstoreDeleteResponse (object)

Indicates the KV Store was successfully cleared.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/kvstore/delete/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "x-m2-launch-context-id": "text",
      "x-m2-world-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "store": "kvstoreClient"
    }),
});
const data = await response.json();

Response

2044XX

{}

Service health check

GEThttps://your-organization-id.m2worlds.io/api/kvstore/healthz

Response

200

Provides information about the service status.

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/kvstore/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text