Branch Instance

POST 
/api/instance/:instance_id/branch

Save one hidden synchronous snapshot and create count children from it. The response snapshot is the previous snapshot for compatibility; each child refs.snapshot_id identifies the new snapshot. Body count/digest take precedence over query parameters when provided. Singular and plural instance routes are aliases.

Request

Responses

200

Successful Response

400

Malformed input or invalid operation parameters

401

Missing or invalid authentication

402

Billing or account restriction

403

Authorization or quota refusal

404

Instance not found in the authorized scope

412

Instance readiness or paused-state precondition failed

500

Database or operation failure

503

Snapshot admission busy, or an operation dependency unavailable. A typed no-dispatch admission refusal includes Retry-After: 1.

Response Headers

• Retry-After string

  Present only when snapshot admission was refused before dispatch; other 503 failures may omit it.