kvstore

Manages arbitrary data persisted for game clients and game servers

Read KVStore data

POSThttp://admin.m2worlds.io/api/kvstore/read/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

id*string

store*any of

enumenum

key*string

Response

2004XX

Default Response

Body

application/json

status*any of

enumenum

id*string

store*any of

enumenum

object*any

Request

JavaScriptCurl

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

Response

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

Upsert KVStore data

POSThttp://admin.m2worlds.io/api/kvstore/upsert/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

id*string

store*any of

enumenum

key*string

data*any

Response

2004XX

Default Response

Body

application/json

id*string

store*any of

enumenum

object*any

Request

JavaScriptCurl

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

Response

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

Deletes all KVStore data except ignored keys

POSThttp://admin.m2worlds.io/api/kvstore/delete/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

keysToIgnorearray of string

store*any of

enumenum

Response

4XX

Default Response

Body

application/json

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/kvstore/delete/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "store": "kvstoreClient"
    }),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Service health check

GEThttp://admin.m2worlds.io/api/kvstore/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/kvstore/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"