Pools

Update a pool name or owned hardware cost

Only name and owned_cost_micros_per_hour can be changed. Predict and Route cannot be enabled.

patch/v1/pools/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Identifier returned by Nodus.

Request body

namestring

Trimmed nonempty pool name, at most 200 UTF-8 bytes.

owned_cost_micros_per_hourinteger
predict_enabledboolean
accepted_predict_rate_versionstring
accepted_predict_monthly_microsinteger
route_enabledboolean
accepted_route_rate_versionstring

Cloud-connected pools accept byoc-free-v1 at zero. Other customer-owned pools require explicit private-supplier-cost-v2 consent on each enable request.

accepted_route_rate_microsinteger

Zero for customer-owned pools. Non-cloud pools require explicit zero with private-supplier-cost-v2 on each enable request. Existing reservations retain their accepted terms.

wait_policy'never' | 'after_wait' | 'cheaper'

never keeps waiting for private capacity without market fallback. after_wait permits fallback after the retained wait. cheaper requires active Predict and a current forecast showing lower expected market completion cost. Missing evidence keeps waiting.

wait_alphanumber

Finite nonnegative wait tolerance multiplier. New pools default to 0.1.

waiting_budget_pctnumber
burst_approval'auto' | 'above_threshold' | 'always'
burst_threshold_microsinteger

Approval threshold in USD micros.

burst_timeout_behaviour'keep_waiting' | 'cancel'

Response

Update a pool name or owned hardware cost

idstring required
namestring required
kindstring required
statestring required
wait_policy'never' | 'after_wait' | 'cheaper' required

never keeps waiting for private capacity without market fallback. after_wait permits fallback after the retained wait. cheaper requires active Predict and a current forecast showing lower expected market completion cost. Missing evidence keeps waiting.

burst_approval'auto' | 'above_threshold' | 'always' required
burst_timeout_behaviour'keep_waiting' | 'cancel' required
predict_enabledboolean required
route_enabledboolean required
sandbox_capableboolean required
wait_alphanumber required

Finite nonnegative wait tolerance multiplier. New pools default to 0.1.

waiting_budget_pctnumber required
burst_threshold_microsinteger required

Approval threshold in USD micros.

platform_rate_microsinteger required

Accepted Route rate per active customer device-hour in USD micros. Retained when Route is disabled.

owned_cost_micros_per_hourinteger required

Customer-supplied owned hardware cost in USD micros per hour. This value does not create a charge.

created_atstring date-time required
updated_atstring date-time required
route_price_versionstring

Accepted Nodus Route pricing version. byoc-free-v1 with a zero platform rate identifies free cloud-connected execution. Absent before pricing terms are accepted. Retained when routing is disabled.

Changes

No recorded changes to this operation across all 70 revisions of this API.