Skip to content

Add or update one runtime app mapping โ€‹

POST /v1/admin/store/games/{gameId}/runtime-apps

  • Operation ID: saveStoreGameRuntimeApp
  • Tags: Store runtime apps
  • Base URL: http://localhost:8787

Upserts the mapping for runtime_app_id (both create and update return 201). is_default: true promotes it (and demotes the previous default) when enabled; a disabled mapping cannot be default. Emits a dashboard event.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission store.write.

Authentication โ€‹

  • Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
  • Required permissions: store.write

Parameters โ€‹

NameInTypeRequiredDescription
gameIdpathintegeryesGreater than: 0

Request body โ€‹

Required: yes.

Content type: application/json

Schema: object

FieldTypeRequiredDescription
runtime_app_idstringyesMin length: 1. Max length: 200
labelstringnoMax length: 200
is_enabledbooleanno-
is_defaultbooleanno-
sort_orderintegernoMin: 0. Max: 100000

Responses โ€‹

201 โ€‹

Saved mapping.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (StoreGameRuntimeApp)

FieldTypeRequiredDescription
idstring<uuid>yes-
game_idintegeryes-
runtime_app_idstringyesOpaque app id in the runtime.
labelstringyes-
is_defaultbooleanyes-
is_enabledbooleanyes-
sort_orderintegeryes-
created_atstringyesISO 8601 timestamp.
updated_atstringyesISO 8601 timestamp.

Errors โ€‹

400 โ€‹

Request validation failed.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

FieldTypeRequiredDescription
successbooleanyesOne of: false
errorobjectyes-
error.namestringyesOne of: "ZodError"
error.issuesobject[]yes-
error.issues[].codestringyes-
error.issues[].path(string | number)[]yes-
error.issues[].messagestringyes-

Request validation

json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401 โ€‹

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "missing_token"
}

403 โ€‹

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "forbidden",
  "details": {
    "perm": "store.write"
  }
}

404 โ€‹

game_not_found.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "game_not_found"
}

500 โ€‹

Unexpected server error (internal). No details are returned.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "internal"
}

Examples โ€‹

curl โ€‹

bash
curl -X POST 'http://localhost:8787/v1/admin/store/games/1/runtime-apps' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"runtime_app_id":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","label":"example","is_enabled":false,"is_default":false,"sort_order":1}'

TypeScript โ€‹

ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/store/games/1/runtime-apps", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "runtime_app_id": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "label": "example",
    "is_enabled": false,
    "is_default": false,
    "sort_order": 1
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

POST/v1/admin/store/games/{gameId}/runtime-apps

Your token stays in this tab's memory and is sent only when you press Send request.

Parameters
Request body (required)

Built for developers. Ready for agents.