Update a pool

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

• Operation ID: updateRuntimePool
• Tags: Runtime pools and nodes
• Base URL: http://localhost:8787

Partial update; an empty patch is rejected with 400. Audited as runtime.pool_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
region	string | null	no	Max length: 100
enabled	boolean	no	-
locked	boolean	no	-
strategy	string	no	One of: "spread", "pack"
maxQueue	integer	no	Min: 0
timeouts	object	no	-
driverId	string | null	no	Max length: 200
scaling	object | null	no	-

Responses

200

Updated pool.

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

Schema: object (RuntimePool)

Field	Type	Required	Description
id	string	yes	-
slug	string	yes	-
name	string	yes	-
region	string | null	yes	-
enabled	boolean	yes	-
locked	boolean	yes	-
strategy	string	yes	One of: "spread", "pack"
maxQueue	integer	yes	-
timeouts	object	yes	-
driverId	string | null	yes	-
scaling	object | null	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/pools/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"slug":"example-game","name":"example","region":"example","enabled":false,"locked":false,"strategy":"spread","maxQueue":1,"timeouts":{},"driverId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","scaling":{}}'

TypeScript

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

const response = await fetch("http://localhost:8787/v1/admin/runtime/pools/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "example-game",
    "name": "example",
    "region": "example",
    "enabled": false,
    "locked": false,
    "strategy": "spread",
    "maxQueue": 1,
    "timeouts": {},
    "driverId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "scaling": {}
  }),
});
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();