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.

post

/read/

Authorizations

BearerAuthApiKeyAuth

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

x-m2-launch-context-idstringrequired

The ID of a launch context

x-m2-world-idstringrequired

The ID of a world

Body

idstringrequired

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

keystringrequired

The key of the value of interest

storeany ofrequired

Client or Server KV Store

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/kvstore/read/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'x-m2-launch-context-id: text' \
  --header 'x-m2-world-id: text' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","key":"text","store":"kvstoreClient"}]'

200

4XX

200

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

The response for a KV Store read request.

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.

post

/upsert/

Authorizations

BearerAuthApiKeyAuth

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

x-m2-launch-context-idstringrequired

The ID of a launch context

x-m2-world-idstringrequired

The ID of a world

Body

idstringrequired

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

keystringrequired

The key of the value of interest

dataanyrequired

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

storeany ofrequired

Client or Server KV Store

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/kvstore/upsert/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'x-m2-launch-context-id: text' \
  --header 'x-m2-world-id: text' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","key":"text","data":null,"store":"kvstoreClient"}]'

200

4XX

200

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

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

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.

post

/delete/

Authorizations

BearerAuthApiKeyAuth

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

x-m2-launch-context-idstringrequired

The ID of a launch context

x-m2-world-idstringrequired

The ID of a world

Body

keysToIgnorestring[]

An array of keys to ignore when clearing the store

storeany ofrequired

Client or Server KV Store

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/kvstore/delete/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'x-m2-launch-context-id: text' \
  --header 'x-m2-world-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"keysToIgnore":[null],"store":"kvstoreClient"}'

204

4XX

204

{}

Indicates the KV Store was successfully cleared.

Service health check

get

/healthz

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/kvstore/healthz'

200

200

text

Provides information about the service status.