Rensei docs

Update an organization execution pool.

Updates supported pool fields under the authenticated organization fence. receiptForwarding is an explicit pool-scoped opt-in; omission preserves the prior value and absent legacy metadata is false.

PATCH
/api/capacity/pools/{poolId}

Authorization

headerAuthorizationBearer <rsk_live_*>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

Path Parameters

poolId*string
Length1 <= length

Request Body

application/json
  1. body
providerId?string
displayName?string
substrateClass?string
credentialId?string|null
config?
servesPersistent?boolean
servesOnDemand?boolean
defaultMode?string
status?string
costWeight?number
priority?number
allowedProjectIds?array<string>|null
receiptForwarding?boolean

Explicit pool-scoped opt-in for forwarding immutable placement receipts to the daemon. Omission preserves the stored value; missing legacy metadata reads as false.

[key: string]?unknown

Response Body

The updated pool, including its effective receipt-forwarding state.

application/json
  1. response
pool*
Example Request
curl -X PATCH 'https://app.rensei.ai/api/capacity/pools/string' \  -H 'Content-Type: application/json' \  -d '{  "property1": null,  "property2": null}'
Example Response
{  "pool": {    "id": "string",    "orgId": "string",    "providerId": "string",    "displayName": "string",    "credentialId": "string",    "config": {      "property1": null,      "property2": null    },    "redactedConfigKeys": [      "string"    ],    "servesPersistent": true,    "servesOnDemand": true,    "status": "string",    "costWeight": 0,    "priority": 0,    "receiptForwarding": true,    "metadata": {      "property1": null,      "property2": null    },    "substrateClass": "local",    "allowedProjectIds": [      "string"    ],    "createdAt": "string",    "updatedAt": "string"  }}