Update a runtime app

PATCH /v1/admin/runtime/apps/{id}

• Operation ID: updateRuntimeApp
• Tags: Runtime apps
• Base URL: http://localhost:8787

Partial update; an empty patch is rejected with 400. Audited as runtime.app_update. Authenticates with a Platform staff JWT and permission, like every admin route; the backend calls the separate Runtime service on the caller's behalf (no Runtime API key is ever exposed or accepted).

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission runtime.write.

Authentication

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

Parameters

Name	In	Type	Required	Description
id	path	string	yes	Min length: 1. Max length: 200

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
slug	string	no	Min length: 1. Max length: 100
name	string	no	Min length: 1. Max length: 200
enabled	boolean	no	-
runner	object	no	-
stream	object	no	-
requires	object	no	-
resources	object	no	-
resources.cpus	number	no	Greater than: 0
resources.memoryMb	integer	no	Min: 1
resources.gpu	object	no	-
resources.gpu.share	number	no	Min: 1. Max: 100
resources.gpu.vramMb	integer	no	Min: 1
resources.gpu.visual	boolean	no	-
resources.runnerCreate	object	no	-
asset	object | null	no	-
maxDurationS	integer	no	Greater than: 0

Responses

200

Updated app.

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

Schema: object (RuntimeApp)

Field	Type	Required	Description
id	string	yes	-
slug	string	yes	-
name	string	yes	-
enabled	boolean	yes	-
runner	object	yes	-
stream	object	yes	-
requires	object	yes	-
resources	object	yes	Per-session resource cost overrides.
resources.cpus	number	no	-
resources.memoryMb	integer	no	-
resources.gpu	object	no	-
resources.gpu.share	number	no	-
resources.gpu.vramMb	integer	no	-
resources.gpu.visual	boolean	no	-
resources.runnerCreate	object	no	-
asset	object | null	yes	-
maxDurationS	integer	yes	-
version	integer	yes	-
createdAt	integer	yes	Created (Unix epoch milliseconds).
updatedAt	integer	yes	Updated (Unix epoch milliseconds).

Errors

400

Request validation failed.

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

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "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)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "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

{
  "error": "forbidden",
  "details": {
    "perm": "runtime.write"
  }
}

404

not_found: the runtime does not know this resource.

• 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

{
  "error": "not_found"
}

409

conflict: the runtime rejected the change (details carry its message).

• 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

{
  "error": "conflict"
}

422

invalid_request: the runtime rejected the payload (details carry its message).

• 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

{
  "error": "invalid_request"
}

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

{
  "error": "internal"
}

503

unavailable: the runtime could not be reached; retry.

• 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

{
  "error": "unavailable"
}

Examples

curl

curl -X PATCH 'http://localhost:8787/v1/admin/runtime/apps/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"slug":"example-game","name":"example","enabled":false,"runner":{},"stream":{},"requires":{},"resources":{"cpus":1,"memoryMb":1,"gpu":{"share":1,"vramMb":1,"visual":false},"runnerCreate":{}},"asset":{},"maxDurationS":1}'

TypeScript

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

const response = await fetch("http://localhost:8787/v1/admin/runtime/apps/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "example-game",
    "name": "example",
    "enabled": false,
    "runner": {},
    "stream": {},
    "requires": {},
    "resources": {
      "cpus": 1,
      "memoryMb": 1,
      "gpu": {
        "share": 1,
        "vramMb": 1,
        "visual": false
      },
      "runnerCreate": {}
    },
    "asset": {},
    "maxDurationS": 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();