--- title: "Withdraw from a purchase: the statement of withdrawal" description: "The statement that the account's buyer withdraws from a purchase (`charge_id`, one that `GET /v1/billing/withdrawals` lists), with its name, and the address the acknowledgement of receipt goes to (`email`; the account's own where it is left out): what the console's billing page sends with its button `Confirm withdrawal`. Received, at once and in one transaction: the charge is `refunded` (`refund_reason` `withdrawal`); of a top-up, the Credits left of it are taken from the balance (an entry `refund` of the ledger), and the account's auto reload, where it is on, is turned off (`auto_reload_off`); of a plan's charge, its period and the subscription end there, and the account is on the free plan from that moment (`subscription.ended`, `reason` `withdrawn`); the acknowledgement of receipt is sent by mail at once, with what was received, its date and time, and what happens next (the notice `withdrawal_received`); every project of the account is told (`withdrawal.received`). What is given back (`rule`): of a purchase whose buyer did not ask for it at once, all that was paid (`in_full`); of a top-up that was asked for at once, what is left of its Credits, rounded up to the cent (`credits_used`); of a plan's charge that was asked for at once, what was paid less the share of it that the larger of two comes to, the part of the period gone by and the part of its credit used, rounded down to the cent (`share`). What a plan's charge carried of a debt is not given back. The money goes back to the card it was paid with, with the tax that was charged on it: at Stripe by a credit note of the charge's invoice (`withdrawal.refunded`, and the credit note in `GET /v1/billing/invoices`), tried again every minute while Stripe cannot be reached; with what stands in for a collector, in the books at once. With `Idempotency-Key`, the same key and body again is answered with what it made. An account that is held for its payments may call it. Takes `admin`; with the console's session, the account's owners'." --- > Documentation Index > Fetch the complete documentation index at: https://glac.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. Path: Glac API › Account and billing › Billing `POST /v1/billing/withdrawals` The statement that the account's buyer withdraws from a purchase (`charge_id`, one that `GET /v1/billing/withdrawals` lists), with its name, and the address the acknowledgement of receipt goes to (`email`; the account's own where it is left out): what the console's billing page sends with its button `Confirm withdrawal`. Received, at once and in one transaction: the charge is `refunded` (`refund_reason` `withdrawal`); of a top-up, the Credits left of it are taken from the balance (an entry `refund` of the ledger), and the account's auto reload, where it is on, is turned off (`auto_reload_off`); of a plan's charge, its period and the subscription end there, and the account is on the free plan from that moment (`subscription.ended`, `reason` `withdrawn`); the acknowledgement of receipt is sent by mail at once, with what was received, its date and time, and what happens next (the notice `withdrawal_received`); every project of the account is told (`withdrawal.received`). What is given back (`rule`): of a purchase whose buyer did not ask for it at once, all that was paid (`in_full`); of a top-up that was asked for at once, what is left of its Credits, rounded up to the cent (`credits_used`); of a plan's charge that was asked for at once, what was paid less the share of it that the larger of two comes to, the part of the period gone by and the part of its credit used, rounded down to the cent (`share`). What a plan's charge carried of a debt is not given back. The money goes back to the card it was paid with, with the tax that was charged on it: at Stripe by a credit note of the charge's invoice (`withdrawal.refunded`, and the credit note in `GET /v1/billing/invoices`), tried again every minute while Stripe cannot be reached; with what stands in for a collector, in the books at once. With `Idempotency-Key`, the same key and body again is answered with what it made. An account that is held for its payments may call it. Takes `admin`; with the console's session, the account's owners'. ## Authentication - `apiKey`, http, header `Authorization`, scopes: `admin` ## Header parameters - `Idempotency-Key` (`createWithdrawal.header.Idempotency-Key`; string, optional) — 1 to 255 characters: the same key and body again gets the same answer, and nothing is made twice. - minLength 1; maxLength 255 ## Request body _Required._ - `charge_id` (`createWithdrawal.charge_id`; string, required) — The purchase withdrawn from, as `GET /v1/billing/withdrawals` lists it in `withdrawable`. - `name` (`createWithdrawal.name`; string, required) — The buyer's name, as the statement gives it. - minLength 1; maxLength 200 - `email` (`createWithdrawal.email`; string, optional) — Where the acknowledgement of receipt is sent; the address the account's notices go to where it is left out. ## Example request ```json { "charge_id": "string", "name": "string", "email": "string" } ``` ## Code samples ### cURL ```bash curl --request POST \ --url https://api.glac.ai/v1/billing/withdrawals \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "charge_id": "string", "name": "string", "email": "string" } ' ``` ### TypeScript ```typescript const url = 'https://api.glac.ai/v1/billing/withdrawals'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({charge_id: 'string', name: 'string', email: 'string'}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://api.glac.ai/v1/billing/withdrawals" payload = { "charge_id": "string", "name": "string", "email": "string" } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 201 The withdrawal, received. #### Example ```json { "object": "withdrawal", "id": "string", "account_id": "string", "charge_id": "string", "kind": "topup", "plan": "p20", "contract": "string", "bought_at": "2019-08-24T14:15:22Z", "submitted_at": "2019-08-24T14:15:22Z", "name": "string", "email": "string", "statement": "string", "submitted_by": { "id": "string", "name": "string" }, "start_now": true, "rule": "in_full", "paid_usd": 0, "kept_usd": 0, "refund_usd": 0, "credits_taken": 0, "period_share": 1, "credit_share": 1, "plan_ended": true, "auto_reload_off": true, "refund": { "state": "refunding", "refunded_at": "2019-08-24T14:15:22Z", "total_usd": 0 }, "confirmation": { "to": "string", "state": "to_send", "sent_at": "2019-08-24T14:15:22Z" } } ``` - `object` (`createWithdrawal.response.201.object`; string, required) - `id` (`createWithdrawal.response.201.id`; string, required) - pattern `^wdr-[0-9a-hjkmnp-tv-z]{16}$` - `account_id` (`createWithdrawal.response.201.account_id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `charge_id` (`createWithdrawal.response.201.charge_id`; string, required) - `kind` (`createWithdrawal.response.201.kind`; string, required) - one of `"topup"`, `"reload"`, `"subscription"` - `plan` (`createWithdrawal.response.201.plan`; string | null, required) — Of a plan's charge, the plan; null of a top-up. - one of `"p20"`, `"p100"`, `"p300"`, `"p1000"`, `"p2000"`, `null` - `contract` (`createWithdrawal.response.201.contract`; string, required) — What was withdrawn from, in words. - `bought_at` (`createWithdrawal.response.201.bought_at`; string, required) - format `date-time` - `submitted_at` (`createWithdrawal.response.201.submitted_at`; string, required) — When the statement was received: the date and time the acknowledgement says. - format `date-time` - `name` (`createWithdrawal.response.201.name`; string, required) - `email` (`createWithdrawal.response.201.email`; string, required) — Where the acknowledgement of receipt goes. - `statement` (`createWithdrawal.response.201.statement`; string, required) — The statement, in the words of the terms' model form, as it was received and acknowledged. - `submitted_by` (`createWithdrawal.response.201.submitted_by`; object, required) — Who sent it: a user of the console (its id and address), or a key (its id and name). - `id` (`createWithdrawal.response.201.submitted_by.id`; string | null, required) - `name` (`createWithdrawal.response.201.submitted_by.name`; string | null, required) - `start_now` (`createWithdrawal.response.201.start_now`; boolean, required) — Its buyer asked for the purchase to be provided at once. - `rule` (`createWithdrawal.response.201.rule`; string, required) — How what is given back is reckoned: `in_full`, all that was paid (its buyer did not ask for it at once); `credits_used`, a top-up's Credits that are left, rounded up to the cent; `share`, what was paid less the share of it the larger of `period_share` and `credit_share` comes to, rounded down to the cent. - one of `"in_full"`, `"credits_used"`, `"share"` - `paid_usd` (`createWithdrawal.response.201.paid_usd`; number, required) - `kept_usd` (`createWithdrawal.response.201.kept_usd`; number, required) — What was kept of what was paid for what had been provided, before tax. - `refund_usd` (`createWithdrawal.response.201.refund_usd`; number, required) — What is given back, before tax; the tax that was charged on it goes back with it. - `credits_taken` (`createWithdrawal.response.201.credits_taken`; number, required) — Of a top-up, the Credits that were left of it and were taken from the balance. - `period_share` (`createWithdrawal.response.201.period_share`; number | null, required) — Of a plan's charge, the part of its period that had gone by when the statement was received. - min 0; max 1 - `credit_share` (`createWithdrawal.response.201.credit_share`; number | null, required) — Of a plan's charge, the part of its credit that was used by then. - min 0; max 1 - `plan_ended` (`createWithdrawal.response.201.plan_ended`; boolean, required) — The subscription ended with it, and the account is on the free plan. - `auto_reload_off` (`createWithdrawal.response.201.auto_reload_off`; boolean, required) — Of a top-up: the account's auto reload was on, and was turned off with it. - `refund` (`createWithdrawal.response.201.refund`; object, required) - `state` (`createWithdrawal.response.201.refund.state`; string, required) — `refunding`: to be made (tried again every minute while Stripe cannot be reached); `refunded`; `nothing`: nothing is given back. - one of `"refunding"`, `"refunded"`, `"nothing"` - `refunded_at` (`createWithdrawal.response.201.refund.refunded_at`; string | null, required) - format `date-time` - `total_usd` (`createWithdrawal.response.201.refund.total_usd`; number | null, required) — What went back to the card, with its tax. - `confirmation` (`createWithdrawal.response.201.confirmation`; object, required) — The acknowledgement of receipt, by mail. - `to` (`createWithdrawal.response.201.confirmation.to`; string, required) - `state` (`createWithdrawal.response.201.confirmation.state`; string | null, required) — As its notice stands (one that failed is sent again). - one of `"to_send"`, `"accepted"`, `"failed"`, `"cancelled"`, `null` - `sent_at` (`createWithdrawal.response.201.confirmation.sent_at`; string | null, required) - format `date-time` ### 400 `invalid_json`, `unknown_field`, `unknown_parameter`, `invalid_idempotency_key`; `missing_field`: no `charge_id`, no `name`, or no `email` of an account that has no address its notices go to; `invalid_field`: `name` is not 1 to 200 characters, `email` is no address. #### Example ```json { "move_id": "string", "upgrade_id": "string", "move": { "object": "move", "id": "string", "sandbox_id": "string", "project_id": "string", "from": { "id": "string", "name": "string" }, "to": { "id": "string", "name": "string" }, "epoch": 1, "step": "string", "why": "string", "wake": true, "from_store": true, "release": {}, "takeover": {}, "error": { "code": "string", "message": "string", "status": 0, "takeover_refused": { "code": "string", "message": "string", "status": 0 }, "image": "string", "holder": "string", "holder_says": "has" }, "attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "batch": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" }, "lease_until": "2019-08-24T14:15:22Z", "active": { "name": "string", "url": "string", "term": 1 }, "allowed_hosts": [ "string" ], "problems": [ { "at": "string", "message": "string" } ], "report": { "object": "compose_import", "name": "string", "dry_run": true, "strict": true, "profiles": [ "string" ], "treatments": { "done": 0, "adapted": 0, "ignored": 0, "refused": 0 }, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "services": [ { "name": "string", "app_id": "string", "status": "created", "kind": "service", "stateful": true, "version": true, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "app": { "image": "string", "image_pull_secret": "string", "start_command": "string", "start_args": [ "string" ], "port": 0, "ready": { "http": "string" }, "env": { "property1": "string", "property2": "string" }, "secrets": { "property1": "string", "property2": "string" }, "size": { "vcpus": 1, "memory_bytes": 134217728 }, "volumes": [ { "volume": "string", "path": "string", "read_only": true, "nocopy": true } ], "drives": [ { "drive": "string", "path": "string", "mode": "string" } ], "key_drives": [ { "name": "string", "path": "string", "size_bytes": 0, "nocopy": true } ], "kind": "string", "files": [ { "path": "string", "content": "string", "secret": "string", "mode": 0, "uid": 0, "gid": 0 } ], "user": "string", "working_dir": "string", "stop": { "signal": "string", "grace_ms": 0 }, "hostname": "string", "runtime": { "ulimits": { "property1": {}, "property2": {} }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ {} ], "dns": { "servers": [ null ], "search": [ null ], "options": [ null ] }, "shm_size_bytes": 0 }, "regions": [ "string" ], "scale": { "min_instances": 0, "max_instances": 1, "concurrency": 1, "sleep_after_ms": 600000, "sleep_notice_ms": 60000, "sleep_hold_max_ms": 900000, "suspend_after_ms": 1000, "wake_daily_at": "string", "delete_after_ms": 1000 }, "keys": { "from": { "header": "string" }, "upgrade_on_deploy": true, "delete_after_idle_ms": 1000 }, "egress": { "default": "allow", "allow": [ "string" ], "deny": [ "string" ], "http": [ { "allow": [] } ], "inject": [ { "headers": {} } ], "deny_ports": [ 1 ] }, "metadata": { "property1": "string", "property2": "string" }, "logs": { "output": true, "keep": true, "requests": { "sample_rate": 1, "keep_errors": true } }, "traces": { "sample_rate": 1, "trust_incoming": true }, "public": true, "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" } } } ], "volumes": [ { "model": "string", "name": "string", "id": "string", "shared": true, "status": "to_make", "used_by": [ "string" ] } ], "secrets": [ { "model": "string", "name": "string", "there": true, "used_by": [ "string" ] } ], "left_out": [ { "name": "string", "profiles": [ "string" ] } ], "absent": [ "string" ], "deploy": "string" }, "accounts": [ { "id": "string", "name": "string" } ], "error": { "type": "string", "code": "string", "message": "string", "param": "string", "retryable": true, "request_id": "string", "docs_url": "string" } } ``` - `error` (`createWithdrawal.response.400.error`; object, required) - `type` (`createWithdrawal.response.400.error.type`; string, required) - `code` (`createWithdrawal.response.400.error.code`; string, required) - `message` (`createWithdrawal.response.400.error.message`; string, required) - `param` (`createWithdrawal.response.400.error.param`; string | null, required) - `retryable` (`createWithdrawal.response.400.error.retryable`; boolean, required) - `request_id` (`createWithdrawal.response.400.error.request_id`; string, required) - `docs_url` (`createWithdrawal.response.400.error.docs_url`; string | null, required) - `move_id` (`createWithdrawal.response.400.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`createWithdrawal.response.400.upgrade_id`; string, optional) — With `upgrade_in_progress` (the key's upgrade that is not over), `upgrade_started` (the upgrade that has begun) and `rollback_gone` (the upgrade whose revert is refused): that upgrade. - pattern `^upg-[0-9a-hjkmnp-tv-z]{16}$` - `move` (`createWithdrawal.response.400.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`createWithdrawal.response.400.move.object`; string, required) - `id` (`createWithdrawal.response.400.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`createWithdrawal.response.400.move.sandbox_id`; string, required) - `project_id` (`createWithdrawal.response.400.move.project_id`; string, required) - `from` (`createWithdrawal.response.400.move.from`; object, required) - `id` (`createWithdrawal.response.400.move.from.id`; string, required) - `name` (`createWithdrawal.response.400.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`createWithdrawal.response.400.move.to`; object, required) - `id` (`createWithdrawal.response.400.move.to.id`; string, required) - `name` (`createWithdrawal.response.400.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`createWithdrawal.response.400.move.epoch`; integer, required) — The epoch the table held the sandbox at when the move began: the old node releases it at it, the new one takes it over one on, the old one takes it back two on, and from the object store three on. - min 1 - `step` (`createWithdrawal.response.400.move.step`; string, required) — Where it stands: `releasing` (the old node is asked to release it; the table has it there), `taking_over` (the new node is asked to take it over; the table has it there), `reclaiming` (the new node refused it, and the old one is asked to take it back), `restoring` (the old one kept nothing of it, and takes it over from the object store), `done` (on the new node), `failed` (where it was, or back there, or where a failure no time clears or an operator's cancel found it: `error` says why). - `why` (`createWithdrawal.response.400.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`createWithdrawal.response.400.move.wake`; boolean, required) — Whether the new node wakes it: as the call said, or as it was (it ran) when the move began. - `from_store` (`createWithdrawal.response.400.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`createWithdrawal.response.400.move.release`; object | null, required) — What the old node's release answered (sandboxd/openapi/openapi.json, `releaseSandbox`), without the release's key; null before it answered. - `takeover` (`createWithdrawal.response.400.move.takeover`; object | null, required) — What the takeover that ended it answered (`takeoverSandbox` of the node's document): where its disk and memory came from (`source`), how long each took (`ms`), `memory`; null before. - `error` (`createWithdrawal.response.400.move.error`; one of, required) — Why it failed, of one that failed (the new node's refusal, where it was taken back to the old node); null, of one that is done; of one under way, what the step it is at was last told where it is asked again. - one of: `object`, `null` - `attempts` (`createWithdrawal.response.400.move.attempts`; integer, required) — How many times the step it is at was asked without an answer that settles it. - min 0 - `next_attempt_at` (`createWithdrawal.response.400.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`createWithdrawal.response.400.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`createWithdrawal.response.400.move.created_at`; string, required) - format `date-time` - `updated_at` (`createWithdrawal.response.400.move.updated_at`; string, required) - format `date-time` - `ended_at` (`createWithdrawal.response.400.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`createWithdrawal.response.400.lease_until`; string, optional) — With `lease_held`: until when the node may still hold the lease it was granted last, and the time after it for the node to have seen it run out (`recoverNode` is refused until then). - format `date-time` - `active` (`createWithdrawal.response.400.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`createWithdrawal.response.400.active.name`; string, required) - `url` (`createWithdrawal.response.400.active.url`; string, required) - `term` (`createWithdrawal.response.400.active.term`; integer, required) - min 1 - `allowed_hosts` (`createWithdrawal.response.400.allowed_hosts`; array | null, optional) — With `secret_host_not_allowed`: the hosts the secret may go to, as the secret has them; null where it was given none (the node's `SecretHosts`). - `problems` (`createWithdrawal.response.400.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`createWithdrawal.response.400.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`createWithdrawal.response.400.problems.message`; string, required) - `report` (`createWithdrawal.response.400.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`createWithdrawal.response.400.report.object`; string, required) - one of `"compose_import"` - `name` (`createWithdrawal.response.400.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`createWithdrawal.response.400.report.dry_run`; boolean, required) - `strict` (`createWithdrawal.response.400.report.strict`; boolean, required) - `profiles` (`createWithdrawal.response.400.report.profiles`; array, required) - `treatments` (`createWithdrawal.response.400.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`createWithdrawal.response.400.report.treatments.done`; integer, required) - min 0 - `adapted` (`createWithdrawal.response.400.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`createWithdrawal.response.400.report.treatments.ignored`; integer, required) - min 0 - `refused` (`createWithdrawal.response.400.report.treatments.refused`; integer, required) - min 0 - `items` (`createWithdrawal.response.400.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`createWithdrawal.response.400.report.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.400.report.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.400.report.items.why`; string, required) - `change` (`createWithdrawal.response.400.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`createWithdrawal.response.400.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`createWithdrawal.response.400.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`createWithdrawal.response.400.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`createWithdrawal.response.400.report.services.status`; string, required) — What the import does (or, in a dry run, would do) to its app: makes it, writes what changed, or nothing. - one of `"created"`, `"changed"`, `"unchanged"` - `kind` (`createWithdrawal.response.400.report.services.kind`; string, required) — `job`: a service of the model waits for it to complete, and it runs to its end in each deploy that needs it. - one of `"service"`, `"job"` - `stateful` (`createWithdrawal.response.400.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`createWithdrawal.response.400.report.services.version`; boolean, required) — Whether the import's deploy makes a version of it: what its version would be made of, its references resolved, is not what its current version is. - `items` (`createWithdrawal.response.400.report.services.items`; array, required) - `at` (`createWithdrawal.response.400.report.services.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.400.report.services.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.400.report.services.items.why`; string, required) - `change` (`createWithdrawal.response.400.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`createWithdrawal.response.400.report.services.app`; object, required) — The fields of the service's app as the import writes them: what its versions are made of, and what holds at once. - `image` (`createWithdrawal.response.400.report.services.app.image`; string | null, required) — What the app's next version is made of, with the seven fields after it: its newest version's, with what was changed since. `null`: the app has no image, and no version. - `image_pull_secret` (`createWithdrawal.response.400.report.services.app.image_pull_secret`; string | null, required) — The name of the secret that holds the credentials of the image's registry. No answer has its value. `null`: none. - `start_command` (`createWithdrawal.response.400.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`createWithdrawal.response.400.report.services.app.start_args`; any of, required) — What follows the image's ENTRYPOINT in the place of its CMD. `null`: the image's CMD, or the whole of `start_command`. - any of: `array`, `null` - `port` (`createWithdrawal.response.400.report.services.app.port`; integer | null, required) - `ready` (`createWithdrawal.response.400.report.services.app.ready`; object, required) — How to tell that an instance is up, which a version's template is saved after: exactly one of the three. The first two are asked from outside the instance, so the service has to listen on every address (`0.0.0.0`). - `http` (`createWithdrawal.response.400.report.services.app.ready.http`; string, optional) — A path, beginning with `/`: a `GET` of it on the app's port is answered with a status from 200 to 399. - `tcp` (`createWithdrawal.response.400.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`createWithdrawal.response.400.report.services.app.ready.command`; one of, optional) — A command that succeeds in the instance. It is run by the instance's shell: a list of arguments is written as one line for it. - one of: `string`, `array` - `env` (`createWithdrawal.response.400.report.services.app.env`; map, required) - `secrets` (`createWithdrawal.response.400.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`createWithdrawal.response.400.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`createWithdrawal.response.400.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`createWithdrawal.response.400.report.services.app.size.memory_bytes`; integer, required) — An even number of MiB (a whole number of the 2 MiB pages a node loads a machine's memory in), in bytes. Any other size is 400 `invalid_field` (param `size.memory_bytes`): no node would make an instance of it, as none makes a sandbox of it (the node's `SandboxLimitsCreate.memory_bytes`). - min 134217728 - `volumes` (`createWithdrawal.response.400.report.services.app.volumes`; array, required) - `volume` (`createWithdrawal.response.400.report.services.app.volumes.volume`; string, required) - `path` (`createWithdrawal.response.400.report.services.app.volumes.path`; string, required) - `read_only` (`createWithdrawal.response.400.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`createWithdrawal.response.400.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`createWithdrawal.response.400.report.services.app.kind`; string, required) - `files` (`createWithdrawal.response.400.report.services.app.files`; array, required) - `path` (`createWithdrawal.response.400.report.services.app.files.path`; string, required) - `mode` (`createWithdrawal.response.400.report.services.app.files.mode`; integer, required) - `uid` (`createWithdrawal.response.400.report.services.app.files.uid`; integer, required) - `gid` (`createWithdrawal.response.400.report.services.app.files.gid`; integer, required) - `content` (`createWithdrawal.response.400.report.services.app.files.content`; string, optional) - `secret` (`createWithdrawal.response.400.report.services.app.files.secret`; string, optional) - `user` (`createWithdrawal.response.400.report.services.app.user`; string | null, required) - `working_dir` (`createWithdrawal.response.400.report.services.app.working_dir`; string | null, required) - `stop` (`createWithdrawal.response.400.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`createWithdrawal.response.400.report.services.app.hostname`; string | null, required) - `regions` (`createWithdrawal.response.400.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`createWithdrawal.response.400.report.services.app.scale`; object, required) - `min_instances` (`createWithdrawal.response.400.report.services.app.scale.min_instances`; integer, required) — How many instances of the app are kept awake in a region, whether a request comes or not: the floor. The nodes of the region that serve the app share it as they share `max_instances` (two nodes and a floor of 2: one on each; a floor of 1: one, on the node that is tried first; a floor of 5: three and two), and a node that is away is made up for by the others. A node makes its part when it is told, not at the first request, and neither stops nor deletes those instances for being idle; they are metered as instances that are awake. 0, which is what it is when nothing is said: none. Lowered, the instances beyond it are idle from that moment, and are stopped and deleted as idle instances are. At most `max_instances`, where that is given, and at most what the account's plan lets an app ask for in a region (`caps.app_instances.limit`: 5, 50 and 500): more is refused, 403 `plan_cap_reached`. - min 0 - `max_instances` (`createWithdrawal.response.400.report.services.app.scale.max_instances`; integer | null, required) — How many instances the app has at the most in a region: the nodes of the region that serve the app share it. At most what the account's plan lets an app ask for (`caps.app_instances.limit`: 5 on the free plan, 50 on `p20`, 200 on `p100`, 500 on `p300`, 1,000 on `p1000`, 2,000 on `p2000`): more is refused, 403 `plan_cap_reached`, and what an app asked for on a plan that let it is kept, and held to the plan's number. `null`: the plan's number for an app that names none (`caps.app_instances.default`: 2, 10, 20, 50, 100 and 200), or `min_instances` where that is more. What the nodes are told is no more than the account has room for awake beside everything else of it that is awake, nor less than the app has awake. - min 1 - `concurrency` (`createWithdrawal.response.400.report.services.app.scale.concurrency`; integer | null, required) — A cap on what one instance has in hand at a time: the requests the edges sent it, and the connections it has open on its project's network (through its service's address, which the node shares out among the instances connection by connection, or to its own). An instance with that many is full, and another is made for more. `null`, which is what it is when nothing is said: no cap. A node then adds an instance when the ones it has are near their size in CPU or memory, and an app does not have to guess a number; a service that takes one request at a time gives one. - min 1; max 1000 - `sleep_after_ms` (`createWithdrawal.response.400.report.services.app.scale.sleep_after_ms`; integer, required) — After how long without a request an instance stops. One that stays stopped is deleted by its node after `delete_after_ms`, and the next request that needs an instance gets a new one; the instances `min_instances` keeps awake are neither stopped nor deleted. - min 0; max 600000 - `sleep_notice_ms` (`createWithdrawal.response.400.report.services.app.scale.sleep_notice_ms`; integer | null, required) — How long before an instance stops for being idle the programs connected to its guest's `/run/sbx/awake` are sent the line `sleep N`, in milliseconds: they flush what they hold, close their connections, or raise a hold, which puts the stop off. The stop comes that long after, whether they answer or not; where nobody is connected, it is not put off. A keyed instance is told as well. 0 or null: not told (the default). - min 0; max 60000 - `sleep_hold_max_ms` (`createWithdrawal.response.400.report.services.app.scale.sleep_hold_max_ms`; integer, required) — How long the holds a program in an instance raises keep it up after its time idle has run out, in milliseconds: a program connects to `/run/sbx/awake` and sends `+` before it answers a request whose work goes on after the answer, and `-` (or closes the connection, or dies) when that work is done; the instance stops `sleep_after_ms` after the last hold is lowered. Past this time it stops whatever holds it, the programs connected told `sleep N cap` first where `sleep_notice_ms` asks for a notice. Held, it runs and is metered as running. 0: holds are not heeded. Null: 30000 (the default). - min 0; max 900000 - `delete_after_ms` (`createWithdrawal.response.400.report.services.app.scale.delete_after_ms`; integer | null, required) — After how long idle an instance is deleted, counted from where its stop is counted from: the next request that needs one gets a new instance, a clone of the version's template, without what the deleted one had gathered in its memory and on its disk (keep what is to last in a volume or a database). A second to an hour, the platform's time, which is the most: more is refused (400 `invalid_field`), and an instance that is to stay warm is one of `min_instances`. `null`, which is what it is when nothing is said: the hour of the nodes (`--app-delete-after-seconds`). A change holds for the instances the app has as for the ones made after: each node judges every instance by the app's time as it is, once a second at the least. Not for the app's keyed instances, which `keys.delete_after_idle_ms` is for. - min 1000; max 3600000 - `suspend_after_ms` (`createWithdrawal.response.400.report.services.app.scale.suspend_after_ms`; integer | null, optional) — How long a stopped instance stays paused before its memory is saved and it sleeps for real, in milliseconds: paused, the next request is answered in a millisecond or two and its memory is metered; asleep, it wakes in a few more and only what it keeps is. Its node holds it to the longest it holds any instance paused (ten minutes); the host's memory running short, a slot another machine needs and a sleep somebody asks for put it to sleep sooner. Null (the default): its node's longest. A database's `suspend_after_seconds` is its app's. - min 1000; max 86400000 - `wake_daily_at` (`createWithdrawal.response.400.report.services.app.scale.wake_daily_at`; string | null, optional) — A time of day in UTC, `HH:MM`, at which the app's keyed instances and its stateful service's instance that rest are woken every day, for work of their own that waits for a wake (a database's maintenance, say); the instances the nodes make and delete by the app's requests are woken by requests alone. The wake is no activity: what runs then is, and once that is done the instance rests again. A stateful service's instance is woken besides for the next run of its PostgreSQL server's `pg_cron` jobs, whatever this says. Null (the default): none. A database's `wake_daily_at` is its app's. - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$` - `keys` (`createWithdrawal.response.400.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`createWithdrawal.response.400.report.services.app.egress`; object | null, required) — Egress rules as a sandbox has them (`default`, `allow`, `deny`, `http`, `inject`), null when there are none; kept as the calls gave them (a `PATCH` merges them key by key, as a node does). They hold at once and make no version: the nodes that serve the app put them on every instance of its group, the ones there are (one that runs for the connections it has too) and the ones made after; a keyed instance does not have them. The control plane checks only that they are an object of those keys of at most 256 KiB: what the rules say is a node's to check, when it applies them, and an instance whose rules its node cannot read is refused everything (the node's log says why). - `default` (`createWithdrawal.response.400.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`createWithdrawal.response.400.report.services.app.egress.allow`; array | null, optional) - `deny` (`createWithdrawal.response.400.report.services.app.egress.deny`; array | null, optional) - `http` (`createWithdrawal.response.400.report.services.app.egress.http`; array | null, optional) - `inject` (`createWithdrawal.response.400.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`createWithdrawal.response.400.report.services.app.egress.deny_ports`; array | null, optional) — Ports no connection reaches, TCP or UDP, wherever it goes and whatever else the rules say. A Browsers session's always hold 25, 465, 587 and the ports mining pools listen on (3333, 4444, 5555, 7777, 14444, 45700): the control plane adds them to whatever a change of its rules gives. - `metadata` (`createWithdrawal.response.400.report.services.app.metadata`; map, required) - `logs` (`createWithdrawal.response.400.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`createWithdrawal.response.400.report.services.app.logs.output`; boolean, required) - `keep` (`createWithdrawal.response.400.report.services.app.logs.keep`; boolean, required) - `requests` (`createWithdrawal.response.400.report.services.app.logs.requests`; object, required) - `sample_rate` (`createWithdrawal.response.400.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`createWithdrawal.response.400.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`createWithdrawal.response.400.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`createWithdrawal.response.400.report.services.app.depends_on`; array, required) - `service` (`createWithdrawal.response.400.report.services.app.depends_on.service`; string, required) - `condition` (`createWithdrawal.response.400.report.services.app.depends_on.condition`; string, required) - `network` (`createWithdrawal.response.400.report.services.app.network`; object, required) - `aliases` (`createWithdrawal.response.400.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`createWithdrawal.response.400.report.services.app.network.endpoint_mode`; string, required) - `drives` (`createWithdrawal.response.400.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`createWithdrawal.response.400.report.services.app.drives.drive`; string, required) - `path` (`createWithdrawal.response.400.report.services.app.drives.path`; string, required) - `mode` (`createWithdrawal.response.400.report.services.app.drives.mode`; string, required) - `key_drives` (`createWithdrawal.response.400.report.services.app.key_drives`; array, optional) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`createWithdrawal.response.400.report.services.app.key_drives.name`; string, required) - `path` (`createWithdrawal.response.400.report.services.app.key_drives.path`; string, required) - `size_bytes` (`createWithdrawal.response.400.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`createWithdrawal.response.400.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`createWithdrawal.response.400.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`createWithdrawal.response.400.report.services.app.traces`; object, optional) — What the app's requests' traces have, each part as it was given or at its default (`AppTraceSettings`): no span where `sample_rate` is 0. - `sample_rate` (`createWithdrawal.response.400.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`createWithdrawal.response.400.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`createWithdrawal.response.400.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`createWithdrawal.response.400.report.volumes.model`; string | null, required) — Its name in the model. Null: made for a path a stateful service mounts with no volume named. - `name` (`createWithdrawal.response.400.report.volumes.name`; string, required) — Its name in the project. - `id` (`createWithdrawal.response.400.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`createWithdrawal.response.400.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`createWithdrawal.response.400.report.volumes.status`; string, required) — `to_make`: the import makes it (a dry run says so of what it would make); `made`: this import made it; `there`: an earlier import made it, or a volume of its name was there; `external`: the model names it `external`, and the project has it. - one of `"to_make"`, `"made"`, `"there"`, `"external"` - `used_by` (`createWithdrawal.response.400.report.volumes.used_by`; array, required) - `secrets` (`createWithdrawal.response.400.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`createWithdrawal.response.400.report.secrets.model`; string, required) — Its name in the model. - `name` (`createWithdrawal.response.400.report.secrets.name`; string, required) — The project's secret that holds it: the model's name, with each character a secret's name does not take written as an underscore. - `there` (`createWithdrawal.response.400.report.secrets.there`; boolean, required) — Whether the project has it. An import (not a dry run) with one that is not there is refused 404 `secret_not_found`. - `used_by` (`createWithdrawal.response.400.report.secrets.used_by`; array, required) - `left_out` (`createWithdrawal.response.400.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`createWithdrawal.response.400.report.left_out.name`; string, required) - `profiles` (`createWithdrawal.response.400.report.left_out.profiles`; array, required) - `absent` (`createWithdrawal.response.400.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`createWithdrawal.response.400.report.deploy`; string | null, required) — The deploy the import made (`GET /v1/deploys/{id}`). Null: a dry run, or nothing would get a version. - pattern `^dpl-` - `accounts` (`createWithdrawal.response.400.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`createWithdrawal.response.400.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`createWithdrawal.response.400.accounts.name`; string, required) ### 401 `missing_api_key`, `invalid_api_key`, `expired_api_key`, `invalid_token`. #### Example ```json { "move_id": "string", "upgrade_id": "string", "move": { "object": "move", "id": "string", "sandbox_id": "string", "project_id": "string", "from": { "id": "string", "name": "string" }, "to": { "id": "string", "name": "string" }, "epoch": 1, "step": "string", "why": "string", "wake": true, "from_store": true, "release": {}, "takeover": {}, "error": { "code": "string", "message": "string", "status": 0, "takeover_refused": { "code": "string", "message": "string", "status": 0 }, "image": "string", "holder": "string", "holder_says": "has" }, "attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "batch": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" }, "lease_until": "2019-08-24T14:15:22Z", "active": { "name": "string", "url": "string", "term": 1 }, "allowed_hosts": [ "string" ], "problems": [ { "at": "string", "message": "string" } ], "report": { "object": "compose_import", "name": "string", "dry_run": true, "strict": true, "profiles": [ "string" ], "treatments": { "done": 0, "adapted": 0, "ignored": 0, "refused": 0 }, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "services": [ { "name": "string", "app_id": "string", "status": "created", "kind": "service", "stateful": true, "version": true, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "app": { "image": "string", "image_pull_secret": "string", "start_command": "string", "start_args": [ "string" ], "port": 0, "ready": { "http": "string" }, "env": { "property1": "string", "property2": "string" }, "secrets": { "property1": "string", "property2": "string" }, "size": { "vcpus": 1, "memory_bytes": 134217728 }, "volumes": [ { "volume": "string", "path": "string", "read_only": true, "nocopy": true } ], "drives": [ { "drive": "string", "path": "string", "mode": "string" } ], "key_drives": [ { "name": "string", "path": "string", "size_bytes": 0, "nocopy": true } ], "kind": "string", "files": [ { "path": "string", "content": "string", "secret": "string", "mode": 0, "uid": 0, "gid": 0 } ], "user": "string", "working_dir": "string", "stop": { "signal": "string", "grace_ms": 0 }, "hostname": "string", "runtime": { "ulimits": { "property1": {}, "property2": {} }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ {} ], "dns": { "servers": [ null ], "search": [ null ], "options": [ null ] }, "shm_size_bytes": 0 }, "regions": [ "string" ], "scale": { "min_instances": 0, "max_instances": 1, "concurrency": 1, "sleep_after_ms": 600000, "sleep_notice_ms": 60000, "sleep_hold_max_ms": 900000, "suspend_after_ms": 1000, "wake_daily_at": "string", "delete_after_ms": 1000 }, "keys": { "from": { "header": "string" }, "upgrade_on_deploy": true, "delete_after_idle_ms": 1000 }, "egress": { "default": "allow", "allow": [ "string" ], "deny": [ "string" ], "http": [ { "allow": [] } ], "inject": [ { "headers": {} } ], "deny_ports": [ 1 ] }, "metadata": { "property1": "string", "property2": "string" }, "logs": { "output": true, "keep": true, "requests": { "sample_rate": 1, "keep_errors": true } }, "traces": { "sample_rate": 1, "trust_incoming": true }, "public": true, "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" } } } ], "volumes": [ { "model": "string", "name": "string", "id": "string", "shared": true, "status": "to_make", "used_by": [ "string" ] } ], "secrets": [ { "model": "string", "name": "string", "there": true, "used_by": [ "string" ] } ], "left_out": [ { "name": "string", "profiles": [ "string" ] } ], "absent": [ "string" ], "deploy": "string" }, "accounts": [ { "id": "string", "name": "string" } ], "error": { "type": "string", "code": "string", "message": "string", "param": "string", "retryable": true, "request_id": "string", "docs_url": "string" } } ``` - `error` (`createWithdrawal.response.401.error`; object, required) - `type` (`createWithdrawal.response.401.error.type`; string, required) - `code` (`createWithdrawal.response.401.error.code`; string, required) - `message` (`createWithdrawal.response.401.error.message`; string, required) - `param` (`createWithdrawal.response.401.error.param`; string | null, required) - `retryable` (`createWithdrawal.response.401.error.retryable`; boolean, required) - `request_id` (`createWithdrawal.response.401.error.request_id`; string, required) - `docs_url` (`createWithdrawal.response.401.error.docs_url`; string | null, required) - `move_id` (`createWithdrawal.response.401.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`createWithdrawal.response.401.upgrade_id`; string, optional) — With `upgrade_in_progress` (the key's upgrade that is not over), `upgrade_started` (the upgrade that has begun) and `rollback_gone` (the upgrade whose revert is refused): that upgrade. - pattern `^upg-[0-9a-hjkmnp-tv-z]{16}$` - `move` (`createWithdrawal.response.401.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`createWithdrawal.response.401.move.object`; string, required) - `id` (`createWithdrawal.response.401.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`createWithdrawal.response.401.move.sandbox_id`; string, required) - `project_id` (`createWithdrawal.response.401.move.project_id`; string, required) - `from` (`createWithdrawal.response.401.move.from`; object, required) - `id` (`createWithdrawal.response.401.move.from.id`; string, required) - `name` (`createWithdrawal.response.401.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`createWithdrawal.response.401.move.to`; object, required) - `id` (`createWithdrawal.response.401.move.to.id`; string, required) - `name` (`createWithdrawal.response.401.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`createWithdrawal.response.401.move.epoch`; integer, required) — The epoch the table held the sandbox at when the move began: the old node releases it at it, the new one takes it over one on, the old one takes it back two on, and from the object store three on. - min 1 - `step` (`createWithdrawal.response.401.move.step`; string, required) — Where it stands: `releasing` (the old node is asked to release it; the table has it there), `taking_over` (the new node is asked to take it over; the table has it there), `reclaiming` (the new node refused it, and the old one is asked to take it back), `restoring` (the old one kept nothing of it, and takes it over from the object store), `done` (on the new node), `failed` (where it was, or back there, or where a failure no time clears or an operator's cancel found it: `error` says why). - `why` (`createWithdrawal.response.401.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`createWithdrawal.response.401.move.wake`; boolean, required) — Whether the new node wakes it: as the call said, or as it was (it ran) when the move began. - `from_store` (`createWithdrawal.response.401.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`createWithdrawal.response.401.move.release`; object | null, required) — What the old node's release answered (sandboxd/openapi/openapi.json, `releaseSandbox`), without the release's key; null before it answered. - `takeover` (`createWithdrawal.response.401.move.takeover`; object | null, required) — What the takeover that ended it answered (`takeoverSandbox` of the node's document): where its disk and memory came from (`source`), how long each took (`ms`), `memory`; null before. - `error` (`createWithdrawal.response.401.move.error`; one of, required) — Why it failed, of one that failed (the new node's refusal, where it was taken back to the old node); null, of one that is done; of one under way, what the step it is at was last told where it is asked again. - one of: `object`, `null` - `attempts` (`createWithdrawal.response.401.move.attempts`; integer, required) — How many times the step it is at was asked without an answer that settles it. - min 0 - `next_attempt_at` (`createWithdrawal.response.401.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`createWithdrawal.response.401.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`createWithdrawal.response.401.move.created_at`; string, required) - format `date-time` - `updated_at` (`createWithdrawal.response.401.move.updated_at`; string, required) - format `date-time` - `ended_at` (`createWithdrawal.response.401.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`createWithdrawal.response.401.lease_until`; string, optional) — With `lease_held`: until when the node may still hold the lease it was granted last, and the time after it for the node to have seen it run out (`recoverNode` is refused until then). - format `date-time` - `active` (`createWithdrawal.response.401.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`createWithdrawal.response.401.active.name`; string, required) - `url` (`createWithdrawal.response.401.active.url`; string, required) - `term` (`createWithdrawal.response.401.active.term`; integer, required) - min 1 - `allowed_hosts` (`createWithdrawal.response.401.allowed_hosts`; array | null, optional) — With `secret_host_not_allowed`: the hosts the secret may go to, as the secret has them; null where it was given none (the node's `SecretHosts`). - `problems` (`createWithdrawal.response.401.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`createWithdrawal.response.401.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`createWithdrawal.response.401.problems.message`; string, required) - `report` (`createWithdrawal.response.401.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`createWithdrawal.response.401.report.object`; string, required) - one of `"compose_import"` - `name` (`createWithdrawal.response.401.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`createWithdrawal.response.401.report.dry_run`; boolean, required) - `strict` (`createWithdrawal.response.401.report.strict`; boolean, required) - `profiles` (`createWithdrawal.response.401.report.profiles`; array, required) - `treatments` (`createWithdrawal.response.401.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`createWithdrawal.response.401.report.treatments.done`; integer, required) - min 0 - `adapted` (`createWithdrawal.response.401.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`createWithdrawal.response.401.report.treatments.ignored`; integer, required) - min 0 - `refused` (`createWithdrawal.response.401.report.treatments.refused`; integer, required) - min 0 - `items` (`createWithdrawal.response.401.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`createWithdrawal.response.401.report.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.401.report.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.401.report.items.why`; string, required) - `change` (`createWithdrawal.response.401.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`createWithdrawal.response.401.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`createWithdrawal.response.401.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`createWithdrawal.response.401.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`createWithdrawal.response.401.report.services.status`; string, required) — What the import does (or, in a dry run, would do) to its app: makes it, writes what changed, or nothing. - one of `"created"`, `"changed"`, `"unchanged"` - `kind` (`createWithdrawal.response.401.report.services.kind`; string, required) — `job`: a service of the model waits for it to complete, and it runs to its end in each deploy that needs it. - one of `"service"`, `"job"` - `stateful` (`createWithdrawal.response.401.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`createWithdrawal.response.401.report.services.version`; boolean, required) — Whether the import's deploy makes a version of it: what its version would be made of, its references resolved, is not what its current version is. - `items` (`createWithdrawal.response.401.report.services.items`; array, required) - `at` (`createWithdrawal.response.401.report.services.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.401.report.services.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.401.report.services.items.why`; string, required) - `change` (`createWithdrawal.response.401.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`createWithdrawal.response.401.report.services.app`; object, required) — The fields of the service's app as the import writes them: what its versions are made of, and what holds at once. - `image` (`createWithdrawal.response.401.report.services.app.image`; string | null, required) — What the app's next version is made of, with the seven fields after it: its newest version's, with what was changed since. `null`: the app has no image, and no version. - `image_pull_secret` (`createWithdrawal.response.401.report.services.app.image_pull_secret`; string | null, required) — The name of the secret that holds the credentials of the image's registry. No answer has its value. `null`: none. - `start_command` (`createWithdrawal.response.401.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`createWithdrawal.response.401.report.services.app.start_args`; any of, required) — What follows the image's ENTRYPOINT in the place of its CMD. `null`: the image's CMD, or the whole of `start_command`. - any of: `array`, `null` - `port` (`createWithdrawal.response.401.report.services.app.port`; integer | null, required) - `ready` (`createWithdrawal.response.401.report.services.app.ready`; object, required) — How to tell that an instance is up, which a version's template is saved after: exactly one of the three. The first two are asked from outside the instance, so the service has to listen on every address (`0.0.0.0`). - `http` (`createWithdrawal.response.401.report.services.app.ready.http`; string, optional) — A path, beginning with `/`: a `GET` of it on the app's port is answered with a status from 200 to 399. - `tcp` (`createWithdrawal.response.401.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`createWithdrawal.response.401.report.services.app.ready.command`; one of, optional) — A command that succeeds in the instance. It is run by the instance's shell: a list of arguments is written as one line for it. - one of: `string`, `array` - `env` (`createWithdrawal.response.401.report.services.app.env`; map, required) - `secrets` (`createWithdrawal.response.401.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`createWithdrawal.response.401.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`createWithdrawal.response.401.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`createWithdrawal.response.401.report.services.app.size.memory_bytes`; integer, required) — An even number of MiB (a whole number of the 2 MiB pages a node loads a machine's memory in), in bytes. Any other size is 400 `invalid_field` (param `size.memory_bytes`): no node would make an instance of it, as none makes a sandbox of it (the node's `SandboxLimitsCreate.memory_bytes`). - min 134217728 - `volumes` (`createWithdrawal.response.401.report.services.app.volumes`; array, required) - `volume` (`createWithdrawal.response.401.report.services.app.volumes.volume`; string, required) - `path` (`createWithdrawal.response.401.report.services.app.volumes.path`; string, required) - `read_only` (`createWithdrawal.response.401.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`createWithdrawal.response.401.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`createWithdrawal.response.401.report.services.app.kind`; string, required) - `files` (`createWithdrawal.response.401.report.services.app.files`; array, required) - `path` (`createWithdrawal.response.401.report.services.app.files.path`; string, required) - `mode` (`createWithdrawal.response.401.report.services.app.files.mode`; integer, required) - `uid` (`createWithdrawal.response.401.report.services.app.files.uid`; integer, required) - `gid` (`createWithdrawal.response.401.report.services.app.files.gid`; integer, required) - `content` (`createWithdrawal.response.401.report.services.app.files.content`; string, optional) - `secret` (`createWithdrawal.response.401.report.services.app.files.secret`; string, optional) - `user` (`createWithdrawal.response.401.report.services.app.user`; string | null, required) - `working_dir` (`createWithdrawal.response.401.report.services.app.working_dir`; string | null, required) - `stop` (`createWithdrawal.response.401.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`createWithdrawal.response.401.report.services.app.hostname`; string | null, required) - `regions` (`createWithdrawal.response.401.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`createWithdrawal.response.401.report.services.app.scale`; object, required) - `min_instances` (`createWithdrawal.response.401.report.services.app.scale.min_instances`; integer, required) — How many instances of the app are kept awake in a region, whether a request comes or not: the floor. The nodes of the region that serve the app share it as they share `max_instances` (two nodes and a floor of 2: one on each; a floor of 1: one, on the node that is tried first; a floor of 5: three and two), and a node that is away is made up for by the others. A node makes its part when it is told, not at the first request, and neither stops nor deletes those instances for being idle; they are metered as instances that are awake. 0, which is what it is when nothing is said: none. Lowered, the instances beyond it are idle from that moment, and are stopped and deleted as idle instances are. At most `max_instances`, where that is given, and at most what the account's plan lets an app ask for in a region (`caps.app_instances.limit`: 5, 50 and 500): more is refused, 403 `plan_cap_reached`. - min 0 - `max_instances` (`createWithdrawal.response.401.report.services.app.scale.max_instances`; integer | null, required) — How many instances the app has at the most in a region: the nodes of the region that serve the app share it. At most what the account's plan lets an app ask for (`caps.app_instances.limit`: 5 on the free plan, 50 on `p20`, 200 on `p100`, 500 on `p300`, 1,000 on `p1000`, 2,000 on `p2000`): more is refused, 403 `plan_cap_reached`, and what an app asked for on a plan that let it is kept, and held to the plan's number. `null`: the plan's number for an app that names none (`caps.app_instances.default`: 2, 10, 20, 50, 100 and 200), or `min_instances` where that is more. What the nodes are told is no more than the account has room for awake beside everything else of it that is awake, nor less than the app has awake. - min 1 - `concurrency` (`createWithdrawal.response.401.report.services.app.scale.concurrency`; integer | null, required) — A cap on what one instance has in hand at a time: the requests the edges sent it, and the connections it has open on its project's network (through its service's address, which the node shares out among the instances connection by connection, or to its own). An instance with that many is full, and another is made for more. `null`, which is what it is when nothing is said: no cap. A node then adds an instance when the ones it has are near their size in CPU or memory, and an app does not have to guess a number; a service that takes one request at a time gives one. - min 1; max 1000 - `sleep_after_ms` (`createWithdrawal.response.401.report.services.app.scale.sleep_after_ms`; integer, required) — After how long without a request an instance stops. One that stays stopped is deleted by its node after `delete_after_ms`, and the next request that needs an instance gets a new one; the instances `min_instances` keeps awake are neither stopped nor deleted. - min 0; max 600000 - `sleep_notice_ms` (`createWithdrawal.response.401.report.services.app.scale.sleep_notice_ms`; integer | null, required) — How long before an instance stops for being idle the programs connected to its guest's `/run/sbx/awake` are sent the line `sleep N`, in milliseconds: they flush what they hold, close their connections, or raise a hold, which puts the stop off. The stop comes that long after, whether they answer or not; where nobody is connected, it is not put off. A keyed instance is told as well. 0 or null: not told (the default). - min 0; max 60000 - `sleep_hold_max_ms` (`createWithdrawal.response.401.report.services.app.scale.sleep_hold_max_ms`; integer, required) — How long the holds a program in an instance raises keep it up after its time idle has run out, in milliseconds: a program connects to `/run/sbx/awake` and sends `+` before it answers a request whose work goes on after the answer, and `-` (or closes the connection, or dies) when that work is done; the instance stops `sleep_after_ms` after the last hold is lowered. Past this time it stops whatever holds it, the programs connected told `sleep N cap` first where `sleep_notice_ms` asks for a notice. Held, it runs and is metered as running. 0: holds are not heeded. Null: 30000 (the default). - min 0; max 900000 - `delete_after_ms` (`createWithdrawal.response.401.report.services.app.scale.delete_after_ms`; integer | null, required) — After how long idle an instance is deleted, counted from where its stop is counted from: the next request that needs one gets a new instance, a clone of the version's template, without what the deleted one had gathered in its memory and on its disk (keep what is to last in a volume or a database). A second to an hour, the platform's time, which is the most: more is refused (400 `invalid_field`), and an instance that is to stay warm is one of `min_instances`. `null`, which is what it is when nothing is said: the hour of the nodes (`--app-delete-after-seconds`). A change holds for the instances the app has as for the ones made after: each node judges every instance by the app's time as it is, once a second at the least. Not for the app's keyed instances, which `keys.delete_after_idle_ms` is for. - min 1000; max 3600000 - `suspend_after_ms` (`createWithdrawal.response.401.report.services.app.scale.suspend_after_ms`; integer | null, optional) — How long a stopped instance stays paused before its memory is saved and it sleeps for real, in milliseconds: paused, the next request is answered in a millisecond or two and its memory is metered; asleep, it wakes in a few more and only what it keeps is. Its node holds it to the longest it holds any instance paused (ten minutes); the host's memory running short, a slot another machine needs and a sleep somebody asks for put it to sleep sooner. Null (the default): its node's longest. A database's `suspend_after_seconds` is its app's. - min 1000; max 86400000 - `wake_daily_at` (`createWithdrawal.response.401.report.services.app.scale.wake_daily_at`; string | null, optional) — A time of day in UTC, `HH:MM`, at which the app's keyed instances and its stateful service's instance that rest are woken every day, for work of their own that waits for a wake (a database's maintenance, say); the instances the nodes make and delete by the app's requests are woken by requests alone. The wake is no activity: what runs then is, and once that is done the instance rests again. A stateful service's instance is woken besides for the next run of its PostgreSQL server's `pg_cron` jobs, whatever this says. Null (the default): none. A database's `wake_daily_at` is its app's. - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$` - `keys` (`createWithdrawal.response.401.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`createWithdrawal.response.401.report.services.app.egress`; object | null, required) — Egress rules as a sandbox has them (`default`, `allow`, `deny`, `http`, `inject`), null when there are none; kept as the calls gave them (a `PATCH` merges them key by key, as a node does). They hold at once and make no version: the nodes that serve the app put them on every instance of its group, the ones there are (one that runs for the connections it has too) and the ones made after; a keyed instance does not have them. The control plane checks only that they are an object of those keys of at most 256 KiB: what the rules say is a node's to check, when it applies them, and an instance whose rules its node cannot read is refused everything (the node's log says why). - `default` (`createWithdrawal.response.401.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`createWithdrawal.response.401.report.services.app.egress.allow`; array | null, optional) - `deny` (`createWithdrawal.response.401.report.services.app.egress.deny`; array | null, optional) - `http` (`createWithdrawal.response.401.report.services.app.egress.http`; array | null, optional) - `inject` (`createWithdrawal.response.401.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`createWithdrawal.response.401.report.services.app.egress.deny_ports`; array | null, optional) — Ports no connection reaches, TCP or UDP, wherever it goes and whatever else the rules say. A Browsers session's always hold 25, 465, 587 and the ports mining pools listen on (3333, 4444, 5555, 7777, 14444, 45700): the control plane adds them to whatever a change of its rules gives. - `metadata` (`createWithdrawal.response.401.report.services.app.metadata`; map, required) - `logs` (`createWithdrawal.response.401.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`createWithdrawal.response.401.report.services.app.logs.output`; boolean, required) - `keep` (`createWithdrawal.response.401.report.services.app.logs.keep`; boolean, required) - `requests` (`createWithdrawal.response.401.report.services.app.logs.requests`; object, required) - `sample_rate` (`createWithdrawal.response.401.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`createWithdrawal.response.401.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`createWithdrawal.response.401.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`createWithdrawal.response.401.report.services.app.depends_on`; array, required) - `service` (`createWithdrawal.response.401.report.services.app.depends_on.service`; string, required) - `condition` (`createWithdrawal.response.401.report.services.app.depends_on.condition`; string, required) - `network` (`createWithdrawal.response.401.report.services.app.network`; object, required) - `aliases` (`createWithdrawal.response.401.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`createWithdrawal.response.401.report.services.app.network.endpoint_mode`; string, required) - `drives` (`createWithdrawal.response.401.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`createWithdrawal.response.401.report.services.app.drives.drive`; string, required) - `path` (`createWithdrawal.response.401.report.services.app.drives.path`; string, required) - `mode` (`createWithdrawal.response.401.report.services.app.drives.mode`; string, required) - `key_drives` (`createWithdrawal.response.401.report.services.app.key_drives`; array, optional) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`createWithdrawal.response.401.report.services.app.key_drives.name`; string, required) - `path` (`createWithdrawal.response.401.report.services.app.key_drives.path`; string, required) - `size_bytes` (`createWithdrawal.response.401.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`createWithdrawal.response.401.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`createWithdrawal.response.401.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`createWithdrawal.response.401.report.services.app.traces`; object, optional) — What the app's requests' traces have, each part as it was given or at its default (`AppTraceSettings`): no span where `sample_rate` is 0. - `sample_rate` (`createWithdrawal.response.401.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`createWithdrawal.response.401.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`createWithdrawal.response.401.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`createWithdrawal.response.401.report.volumes.model`; string | null, required) — Its name in the model. Null: made for a path a stateful service mounts with no volume named. - `name` (`createWithdrawal.response.401.report.volumes.name`; string, required) — Its name in the project. - `id` (`createWithdrawal.response.401.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`createWithdrawal.response.401.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`createWithdrawal.response.401.report.volumes.status`; string, required) — `to_make`: the import makes it (a dry run says so of what it would make); `made`: this import made it; `there`: an earlier import made it, or a volume of its name was there; `external`: the model names it `external`, and the project has it. - one of `"to_make"`, `"made"`, `"there"`, `"external"` - `used_by` (`createWithdrawal.response.401.report.volumes.used_by`; array, required) - `secrets` (`createWithdrawal.response.401.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`createWithdrawal.response.401.report.secrets.model`; string, required) — Its name in the model. - `name` (`createWithdrawal.response.401.report.secrets.name`; string, required) — The project's secret that holds it: the model's name, with each character a secret's name does not take written as an underscore. - `there` (`createWithdrawal.response.401.report.secrets.there`; boolean, required) — Whether the project has it. An import (not a dry run) with one that is not there is refused 404 `secret_not_found`. - `used_by` (`createWithdrawal.response.401.report.secrets.used_by`; array, required) - `left_out` (`createWithdrawal.response.401.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`createWithdrawal.response.401.report.left_out.name`; string, required) - `profiles` (`createWithdrawal.response.401.report.left_out.profiles`; array, required) - `absent` (`createWithdrawal.response.401.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`createWithdrawal.response.401.report.deploy`; string | null, required) — The deploy the import made (`GET /v1/deploys/{id}`). Null: a dry run, or nothing would get a version. - pattern `^dpl-` - `accounts` (`createWithdrawal.response.401.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`createWithdrawal.response.401.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`createWithdrawal.response.401.accounts.name`; string, required) ### 403 `key_scope`: the key does not allow `admin`; `needs_api_key`: the operator's key, or the SSH gateway's; `not_a_consumer`: the purchase was made by a business (the account had a tax id when it paid), or from outside the EEA and the UK, or from nowhere that is known; the message says which. #### Example ```json { "move_id": "string", "upgrade_id": "string", "move": { "object": "move", "id": "string", "sandbox_id": "string", "project_id": "string", "from": { "id": "string", "name": "string" }, "to": { "id": "string", "name": "string" }, "epoch": 1, "step": "string", "why": "string", "wake": true, "from_store": true, "release": {}, "takeover": {}, "error": { "code": "string", "message": "string", "status": 0, "takeover_refused": { "code": "string", "message": "string", "status": 0 }, "image": "string", "holder": "string", "holder_says": "has" }, "attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "batch": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" }, "lease_until": "2019-08-24T14:15:22Z", "active": { "name": "string", "url": "string", "term": 1 }, "allowed_hosts": [ "string" ], "problems": [ { "at": "string", "message": "string" } ], "report": { "object": "compose_import", "name": "string", "dry_run": true, "strict": true, "profiles": [ "string" ], "treatments": { "done": 0, "adapted": 0, "ignored": 0, "refused": 0 }, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "services": [ { "name": "string", "app_id": "string", "status": "created", "kind": "service", "stateful": true, "version": true, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "app": { "image": "string", "image_pull_secret": "string", "start_command": "string", "start_args": [ "string" ], "port": 0, "ready": { "http": "string" }, "env": { "property1": "string", "property2": "string" }, "secrets": { "property1": "string", "property2": "string" }, "size": { "vcpus": 1, "memory_bytes": 134217728 }, "volumes": [ { "volume": "string", "path": "string", "read_only": true, "nocopy": true } ], "drives": [ { "drive": "string", "path": "string", "mode": "string" } ], "key_drives": [ { "name": "string", "path": "string", "size_bytes": 0, "nocopy": true } ], "kind": "string", "files": [ { "path": "string", "content": "string", "secret": "string", "mode": 0, "uid": 0, "gid": 0 } ], "user": "string", "working_dir": "string", "stop": { "signal": "string", "grace_ms": 0 }, "hostname": "string", "runtime": { "ulimits": { "property1": {}, "property2": {} }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ {} ], "dns": { "servers": [ null ], "search": [ null ], "options": [ null ] }, "shm_size_bytes": 0 }, "regions": [ "string" ], "scale": { "min_instances": 0, "max_instances": 1, "concurrency": 1, "sleep_after_ms": 600000, "sleep_notice_ms": 60000, "sleep_hold_max_ms": 900000, "suspend_after_ms": 1000, "wake_daily_at": "string", "delete_after_ms": 1000 }, "keys": { "from": { "header": "string" }, "upgrade_on_deploy": true, "delete_after_idle_ms": 1000 }, "egress": { "default": "allow", "allow": [ "string" ], "deny": [ "string" ], "http": [ { "allow": [] } ], "inject": [ { "headers": {} } ], "deny_ports": [ 1 ] }, "metadata": { "property1": "string", "property2": "string" }, "logs": { "output": true, "keep": true, "requests": { "sample_rate": 1, "keep_errors": true } }, "traces": { "sample_rate": 1, "trust_incoming": true }, "public": true, "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" } } } ], "volumes": [ { "model": "string", "name": "string", "id": "string", "shared": true, "status": "to_make", "used_by": [ "string" ] } ], "secrets": [ { "model": "string", "name": "string", "there": true, "used_by": [ "string" ] } ], "left_out": [ { "name": "string", "profiles": [ "string" ] } ], "absent": [ "string" ], "deploy": "string" }, "accounts": [ { "id": "string", "name": "string" } ], "error": { "type": "string", "code": "string", "message": "string", "param": "string", "retryable": true, "request_id": "string", "docs_url": "string" } } ``` - `error` (`createWithdrawal.response.403.error`; object, required) - `type` (`createWithdrawal.response.403.error.type`; string, required) - `code` (`createWithdrawal.response.403.error.code`; string, required) - `message` (`createWithdrawal.response.403.error.message`; string, required) - `param` (`createWithdrawal.response.403.error.param`; string | null, required) - `retryable` (`createWithdrawal.response.403.error.retryable`; boolean, required) - `request_id` (`createWithdrawal.response.403.error.request_id`; string, required) - `docs_url` (`createWithdrawal.response.403.error.docs_url`; string | null, required) - `move_id` (`createWithdrawal.response.403.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`createWithdrawal.response.403.upgrade_id`; string, optional) — With `upgrade_in_progress` (the key's upgrade that is not over), `upgrade_started` (the upgrade that has begun) and `rollback_gone` (the upgrade whose revert is refused): that upgrade. - pattern `^upg-[0-9a-hjkmnp-tv-z]{16}$` - `move` (`createWithdrawal.response.403.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`createWithdrawal.response.403.move.object`; string, required) - `id` (`createWithdrawal.response.403.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`createWithdrawal.response.403.move.sandbox_id`; string, required) - `project_id` (`createWithdrawal.response.403.move.project_id`; string, required) - `from` (`createWithdrawal.response.403.move.from`; object, required) - `id` (`createWithdrawal.response.403.move.from.id`; string, required) - `name` (`createWithdrawal.response.403.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`createWithdrawal.response.403.move.to`; object, required) - `id` (`createWithdrawal.response.403.move.to.id`; string, required) - `name` (`createWithdrawal.response.403.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`createWithdrawal.response.403.move.epoch`; integer, required) — The epoch the table held the sandbox at when the move began: the old node releases it at it, the new one takes it over one on, the old one takes it back two on, and from the object store three on. - min 1 - `step` (`createWithdrawal.response.403.move.step`; string, required) — Where it stands: `releasing` (the old node is asked to release it; the table has it there), `taking_over` (the new node is asked to take it over; the table has it there), `reclaiming` (the new node refused it, and the old one is asked to take it back), `restoring` (the old one kept nothing of it, and takes it over from the object store), `done` (on the new node), `failed` (where it was, or back there, or where a failure no time clears or an operator's cancel found it: `error` says why). - `why` (`createWithdrawal.response.403.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`createWithdrawal.response.403.move.wake`; boolean, required) — Whether the new node wakes it: as the call said, or as it was (it ran) when the move began. - `from_store` (`createWithdrawal.response.403.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`createWithdrawal.response.403.move.release`; object | null, required) — What the old node's release answered (sandboxd/openapi/openapi.json, `releaseSandbox`), without the release's key; null before it answered. - `takeover` (`createWithdrawal.response.403.move.takeover`; object | null, required) — What the takeover that ended it answered (`takeoverSandbox` of the node's document): where its disk and memory came from (`source`), how long each took (`ms`), `memory`; null before. - `error` (`createWithdrawal.response.403.move.error`; one of, required) — Why it failed, of one that failed (the new node's refusal, where it was taken back to the old node); null, of one that is done; of one under way, what the step it is at was last told where it is asked again. - one of: `object`, `null` - `attempts` (`createWithdrawal.response.403.move.attempts`; integer, required) — How many times the step it is at was asked without an answer that settles it. - min 0 - `next_attempt_at` (`createWithdrawal.response.403.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`createWithdrawal.response.403.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`createWithdrawal.response.403.move.created_at`; string, required) - format `date-time` - `updated_at` (`createWithdrawal.response.403.move.updated_at`; string, required) - format `date-time` - `ended_at` (`createWithdrawal.response.403.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`createWithdrawal.response.403.lease_until`; string, optional) — With `lease_held`: until when the node may still hold the lease it was granted last, and the time after it for the node to have seen it run out (`recoverNode` is refused until then). - format `date-time` - `active` (`createWithdrawal.response.403.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`createWithdrawal.response.403.active.name`; string, required) - `url` (`createWithdrawal.response.403.active.url`; string, required) - `term` (`createWithdrawal.response.403.active.term`; integer, required) - min 1 - `allowed_hosts` (`createWithdrawal.response.403.allowed_hosts`; array | null, optional) — With `secret_host_not_allowed`: the hosts the secret may go to, as the secret has them; null where it was given none (the node's `SecretHosts`). - `problems` (`createWithdrawal.response.403.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`createWithdrawal.response.403.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`createWithdrawal.response.403.problems.message`; string, required) - `report` (`createWithdrawal.response.403.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`createWithdrawal.response.403.report.object`; string, required) - one of `"compose_import"` - `name` (`createWithdrawal.response.403.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`createWithdrawal.response.403.report.dry_run`; boolean, required) - `strict` (`createWithdrawal.response.403.report.strict`; boolean, required) - `profiles` (`createWithdrawal.response.403.report.profiles`; array, required) - `treatments` (`createWithdrawal.response.403.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`createWithdrawal.response.403.report.treatments.done`; integer, required) - min 0 - `adapted` (`createWithdrawal.response.403.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`createWithdrawal.response.403.report.treatments.ignored`; integer, required) - min 0 - `refused` (`createWithdrawal.response.403.report.treatments.refused`; integer, required) - min 0 - `items` (`createWithdrawal.response.403.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`createWithdrawal.response.403.report.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.403.report.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.403.report.items.why`; string, required) - `change` (`createWithdrawal.response.403.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`createWithdrawal.response.403.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`createWithdrawal.response.403.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`createWithdrawal.response.403.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`createWithdrawal.response.403.report.services.status`; string, required) — What the import does (or, in a dry run, would do) to its app: makes it, writes what changed, or nothing. - one of `"created"`, `"changed"`, `"unchanged"` - `kind` (`createWithdrawal.response.403.report.services.kind`; string, required) — `job`: a service of the model waits for it to complete, and it runs to its end in each deploy that needs it. - one of `"service"`, `"job"` - `stateful` (`createWithdrawal.response.403.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`createWithdrawal.response.403.report.services.version`; boolean, required) — Whether the import's deploy makes a version of it: what its version would be made of, its references resolved, is not what its current version is. - `items` (`createWithdrawal.response.403.report.services.items`; array, required) - `at` (`createWithdrawal.response.403.report.services.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.403.report.services.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.403.report.services.items.why`; string, required) - `change` (`createWithdrawal.response.403.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`createWithdrawal.response.403.report.services.app`; object, required) — The fields of the service's app as the import writes them: what its versions are made of, and what holds at once. - `image` (`createWithdrawal.response.403.report.services.app.image`; string | null, required) — What the app's next version is made of, with the seven fields after it: its newest version's, with what was changed since. `null`: the app has no image, and no version. - `image_pull_secret` (`createWithdrawal.response.403.report.services.app.image_pull_secret`; string | null, required) — The name of the secret that holds the credentials of the image's registry. No answer has its value. `null`: none. - `start_command` (`createWithdrawal.response.403.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`createWithdrawal.response.403.report.services.app.start_args`; any of, required) — What follows the image's ENTRYPOINT in the place of its CMD. `null`: the image's CMD, or the whole of `start_command`. - any of: `array`, `null` - `port` (`createWithdrawal.response.403.report.services.app.port`; integer | null, required) - `ready` (`createWithdrawal.response.403.report.services.app.ready`; object, required) — How to tell that an instance is up, which a version's template is saved after: exactly one of the three. The first two are asked from outside the instance, so the service has to listen on every address (`0.0.0.0`). - `http` (`createWithdrawal.response.403.report.services.app.ready.http`; string, optional) — A path, beginning with `/`: a `GET` of it on the app's port is answered with a status from 200 to 399. - `tcp` (`createWithdrawal.response.403.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`createWithdrawal.response.403.report.services.app.ready.command`; one of, optional) — A command that succeeds in the instance. It is run by the instance's shell: a list of arguments is written as one line for it. - one of: `string`, `array` - `env` (`createWithdrawal.response.403.report.services.app.env`; map, required) - `secrets` (`createWithdrawal.response.403.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`createWithdrawal.response.403.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`createWithdrawal.response.403.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`createWithdrawal.response.403.report.services.app.size.memory_bytes`; integer, required) — An even number of MiB (a whole number of the 2 MiB pages a node loads a machine's memory in), in bytes. Any other size is 400 `invalid_field` (param `size.memory_bytes`): no node would make an instance of it, as none makes a sandbox of it (the node's `SandboxLimitsCreate.memory_bytes`). - min 134217728 - `volumes` (`createWithdrawal.response.403.report.services.app.volumes`; array, required) - `volume` (`createWithdrawal.response.403.report.services.app.volumes.volume`; string, required) - `path` (`createWithdrawal.response.403.report.services.app.volumes.path`; string, required) - `read_only` (`createWithdrawal.response.403.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`createWithdrawal.response.403.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`createWithdrawal.response.403.report.services.app.kind`; string, required) - `files` (`createWithdrawal.response.403.report.services.app.files`; array, required) - `path` (`createWithdrawal.response.403.report.services.app.files.path`; string, required) - `mode` (`createWithdrawal.response.403.report.services.app.files.mode`; integer, required) - `uid` (`createWithdrawal.response.403.report.services.app.files.uid`; integer, required) - `gid` (`createWithdrawal.response.403.report.services.app.files.gid`; integer, required) - `content` (`createWithdrawal.response.403.report.services.app.files.content`; string, optional) - `secret` (`createWithdrawal.response.403.report.services.app.files.secret`; string, optional) - `user` (`createWithdrawal.response.403.report.services.app.user`; string | null, required) - `working_dir` (`createWithdrawal.response.403.report.services.app.working_dir`; string | null, required) - `stop` (`createWithdrawal.response.403.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`createWithdrawal.response.403.report.services.app.hostname`; string | null, required) - `regions` (`createWithdrawal.response.403.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`createWithdrawal.response.403.report.services.app.scale`; object, required) - `min_instances` (`createWithdrawal.response.403.report.services.app.scale.min_instances`; integer, required) — How many instances of the app are kept awake in a region, whether a request comes or not: the floor. The nodes of the region that serve the app share it as they share `max_instances` (two nodes and a floor of 2: one on each; a floor of 1: one, on the node that is tried first; a floor of 5: three and two), and a node that is away is made up for by the others. A node makes its part when it is told, not at the first request, and neither stops nor deletes those instances for being idle; they are metered as instances that are awake. 0, which is what it is when nothing is said: none. Lowered, the instances beyond it are idle from that moment, and are stopped and deleted as idle instances are. At most `max_instances`, where that is given, and at most what the account's plan lets an app ask for in a region (`caps.app_instances.limit`: 5, 50 and 500): more is refused, 403 `plan_cap_reached`. - min 0 - `max_instances` (`createWithdrawal.response.403.report.services.app.scale.max_instances`; integer | null, required) — How many instances the app has at the most in a region: the nodes of the region that serve the app share it. At most what the account's plan lets an app ask for (`caps.app_instances.limit`: 5 on the free plan, 50 on `p20`, 200 on `p100`, 500 on `p300`, 1,000 on `p1000`, 2,000 on `p2000`): more is refused, 403 `plan_cap_reached`, and what an app asked for on a plan that let it is kept, and held to the plan's number. `null`: the plan's number for an app that names none (`caps.app_instances.default`: 2, 10, 20, 50, 100 and 200), or `min_instances` where that is more. What the nodes are told is no more than the account has room for awake beside everything else of it that is awake, nor less than the app has awake. - min 1 - `concurrency` (`createWithdrawal.response.403.report.services.app.scale.concurrency`; integer | null, required) — A cap on what one instance has in hand at a time: the requests the edges sent it, and the connections it has open on its project's network (through its service's address, which the node shares out among the instances connection by connection, or to its own). An instance with that many is full, and another is made for more. `null`, which is what it is when nothing is said: no cap. A node then adds an instance when the ones it has are near their size in CPU or memory, and an app does not have to guess a number; a service that takes one request at a time gives one. - min 1; max 1000 - `sleep_after_ms` (`createWithdrawal.response.403.report.services.app.scale.sleep_after_ms`; integer, required) — After how long without a request an instance stops. One that stays stopped is deleted by its node after `delete_after_ms`, and the next request that needs an instance gets a new one; the instances `min_instances` keeps awake are neither stopped nor deleted. - min 0; max 600000 - `sleep_notice_ms` (`createWithdrawal.response.403.report.services.app.scale.sleep_notice_ms`; integer | null, required) — How long before an instance stops for being idle the programs connected to its guest's `/run/sbx/awake` are sent the line `sleep N`, in milliseconds: they flush what they hold, close their connections, or raise a hold, which puts the stop off. The stop comes that long after, whether they answer or not; where nobody is connected, it is not put off. A keyed instance is told as well. 0 or null: not told (the default). - min 0; max 60000 - `sleep_hold_max_ms` (`createWithdrawal.response.403.report.services.app.scale.sleep_hold_max_ms`; integer, required) — How long the holds a program in an instance raises keep it up after its time idle has run out, in milliseconds: a program connects to `/run/sbx/awake` and sends `+` before it answers a request whose work goes on after the answer, and `-` (or closes the connection, or dies) when that work is done; the instance stops `sleep_after_ms` after the last hold is lowered. Past this time it stops whatever holds it, the programs connected told `sleep N cap` first where `sleep_notice_ms` asks for a notice. Held, it runs and is metered as running. 0: holds are not heeded. Null: 30000 (the default). - min 0; max 900000 - `delete_after_ms` (`createWithdrawal.response.403.report.services.app.scale.delete_after_ms`; integer | null, required) — After how long idle an instance is deleted, counted from where its stop is counted from: the next request that needs one gets a new instance, a clone of the version's template, without what the deleted one had gathered in its memory and on its disk (keep what is to last in a volume or a database). A second to an hour, the platform's time, which is the most: more is refused (400 `invalid_field`), and an instance that is to stay warm is one of `min_instances`. `null`, which is what it is when nothing is said: the hour of the nodes (`--app-delete-after-seconds`). A change holds for the instances the app has as for the ones made after: each node judges every instance by the app's time as it is, once a second at the least. Not for the app's keyed instances, which `keys.delete_after_idle_ms` is for. - min 1000; max 3600000 - `suspend_after_ms` (`createWithdrawal.response.403.report.services.app.scale.suspend_after_ms`; integer | null, optional) — How long a stopped instance stays paused before its memory is saved and it sleeps for real, in milliseconds: paused, the next request is answered in a millisecond or two and its memory is metered; asleep, it wakes in a few more and only what it keeps is. Its node holds it to the longest it holds any instance paused (ten minutes); the host's memory running short, a slot another machine needs and a sleep somebody asks for put it to sleep sooner. Null (the default): its node's longest. A database's `suspend_after_seconds` is its app's. - min 1000; max 86400000 - `wake_daily_at` (`createWithdrawal.response.403.report.services.app.scale.wake_daily_at`; string | null, optional) — A time of day in UTC, `HH:MM`, at which the app's keyed instances and its stateful service's instance that rest are woken every day, for work of their own that waits for a wake (a database's maintenance, say); the instances the nodes make and delete by the app's requests are woken by requests alone. The wake is no activity: what runs then is, and once that is done the instance rests again. A stateful service's instance is woken besides for the next run of its PostgreSQL server's `pg_cron` jobs, whatever this says. Null (the default): none. A database's `wake_daily_at` is its app's. - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$` - `keys` (`createWithdrawal.response.403.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`createWithdrawal.response.403.report.services.app.egress`; object | null, required) — Egress rules as a sandbox has them (`default`, `allow`, `deny`, `http`, `inject`), null when there are none; kept as the calls gave them (a `PATCH` merges them key by key, as a node does). They hold at once and make no version: the nodes that serve the app put them on every instance of its group, the ones there are (one that runs for the connections it has too) and the ones made after; a keyed instance does not have them. The control plane checks only that they are an object of those keys of at most 256 KiB: what the rules say is a node's to check, when it applies them, and an instance whose rules its node cannot read is refused everything (the node's log says why). - `default` (`createWithdrawal.response.403.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`createWithdrawal.response.403.report.services.app.egress.allow`; array | null, optional) - `deny` (`createWithdrawal.response.403.report.services.app.egress.deny`; array | null, optional) - `http` (`createWithdrawal.response.403.report.services.app.egress.http`; array | null, optional) - `inject` (`createWithdrawal.response.403.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`createWithdrawal.response.403.report.services.app.egress.deny_ports`; array | null, optional) — Ports no connection reaches, TCP or UDP, wherever it goes and whatever else the rules say. A Browsers session's always hold 25, 465, 587 and the ports mining pools listen on (3333, 4444, 5555, 7777, 14444, 45700): the control plane adds them to whatever a change of its rules gives. - `metadata` (`createWithdrawal.response.403.report.services.app.metadata`; map, required) - `logs` (`createWithdrawal.response.403.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`createWithdrawal.response.403.report.services.app.logs.output`; boolean, required) - `keep` (`createWithdrawal.response.403.report.services.app.logs.keep`; boolean, required) - `requests` (`createWithdrawal.response.403.report.services.app.logs.requests`; object, required) - `sample_rate` (`createWithdrawal.response.403.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`createWithdrawal.response.403.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`createWithdrawal.response.403.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`createWithdrawal.response.403.report.services.app.depends_on`; array, required) - `service` (`createWithdrawal.response.403.report.services.app.depends_on.service`; string, required) - `condition` (`createWithdrawal.response.403.report.services.app.depends_on.condition`; string, required) - `network` (`createWithdrawal.response.403.report.services.app.network`; object, required) - `aliases` (`createWithdrawal.response.403.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`createWithdrawal.response.403.report.services.app.network.endpoint_mode`; string, required) - `drives` (`createWithdrawal.response.403.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`createWithdrawal.response.403.report.services.app.drives.drive`; string, required) - `path` (`createWithdrawal.response.403.report.services.app.drives.path`; string, required) - `mode` (`createWithdrawal.response.403.report.services.app.drives.mode`; string, required) - `key_drives` (`createWithdrawal.response.403.report.services.app.key_drives`; array, optional) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`createWithdrawal.response.403.report.services.app.key_drives.name`; string, required) - `path` (`createWithdrawal.response.403.report.services.app.key_drives.path`; string, required) - `size_bytes` (`createWithdrawal.response.403.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`createWithdrawal.response.403.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`createWithdrawal.response.403.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`createWithdrawal.response.403.report.services.app.traces`; object, optional) — What the app's requests' traces have, each part as it was given or at its default (`AppTraceSettings`): no span where `sample_rate` is 0. - `sample_rate` (`createWithdrawal.response.403.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`createWithdrawal.response.403.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`createWithdrawal.response.403.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`createWithdrawal.response.403.report.volumes.model`; string | null, required) — Its name in the model. Null: made for a path a stateful service mounts with no volume named. - `name` (`createWithdrawal.response.403.report.volumes.name`; string, required) — Its name in the project. - `id` (`createWithdrawal.response.403.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`createWithdrawal.response.403.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`createWithdrawal.response.403.report.volumes.status`; string, required) — `to_make`: the import makes it (a dry run says so of what it would make); `made`: this import made it; `there`: an earlier import made it, or a volume of its name was there; `external`: the model names it `external`, and the project has it. - one of `"to_make"`, `"made"`, `"there"`, `"external"` - `used_by` (`createWithdrawal.response.403.report.volumes.used_by`; array, required) - `secrets` (`createWithdrawal.response.403.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`createWithdrawal.response.403.report.secrets.model`; string, required) — Its name in the model. - `name` (`createWithdrawal.response.403.report.secrets.name`; string, required) — The project's secret that holds it: the model's name, with each character a secret's name does not take written as an underscore. - `there` (`createWithdrawal.response.403.report.secrets.there`; boolean, required) — Whether the project has it. An import (not a dry run) with one that is not there is refused 404 `secret_not_found`. - `used_by` (`createWithdrawal.response.403.report.secrets.used_by`; array, required) - `left_out` (`createWithdrawal.response.403.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`createWithdrawal.response.403.report.left_out.name`; string, required) - `profiles` (`createWithdrawal.response.403.report.left_out.profiles`; array, required) - `absent` (`createWithdrawal.response.403.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`createWithdrawal.response.403.report.deploy`; string | null, required) — The deploy the import made (`GET /v1/deploys/{id}`). Null: a dry run, or nothing would get a version. - pattern `^dpl-` - `accounts` (`createWithdrawal.response.403.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`createWithdrawal.response.403.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`createWithdrawal.response.403.accounts.name`; string, required) ### 404 `charge_not_found`: the account has no such charge. #### Example ```json { "move_id": "string", "upgrade_id": "string", "move": { "object": "move", "id": "string", "sandbox_id": "string", "project_id": "string", "from": { "id": "string", "name": "string" }, "to": { "id": "string", "name": "string" }, "epoch": 1, "step": "string", "why": "string", "wake": true, "from_store": true, "release": {}, "takeover": {}, "error": { "code": "string", "message": "string", "status": 0, "takeover_refused": { "code": "string", "message": "string", "status": 0 }, "image": "string", "holder": "string", "holder_says": "has" }, "attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "batch": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" }, "lease_until": "2019-08-24T14:15:22Z", "active": { "name": "string", "url": "string", "term": 1 }, "allowed_hosts": [ "string" ], "problems": [ { "at": "string", "message": "string" } ], "report": { "object": "compose_import", "name": "string", "dry_run": true, "strict": true, "profiles": [ "string" ], "treatments": { "done": 0, "adapted": 0, "ignored": 0, "refused": 0 }, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "services": [ { "name": "string", "app_id": "string", "status": "created", "kind": "service", "stateful": true, "version": true, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "app": { "image": "string", "image_pull_secret": "string", "start_command": "string", "start_args": [ "string" ], "port": 0, "ready": { "http": "string" }, "env": { "property1": "string", "property2": "string" }, "secrets": { "property1": "string", "property2": "string" }, "size": { "vcpus": 1, "memory_bytes": 134217728 }, "volumes": [ { "volume": "string", "path": "string", "read_only": true, "nocopy": true } ], "drives": [ { "drive": "string", "path": "string", "mode": "string" } ], "key_drives": [ { "name": "string", "path": "string", "size_bytes": 0, "nocopy": true } ], "kind": "string", "files": [ { "path": "string", "content": "string", "secret": "string", "mode": 0, "uid": 0, "gid": 0 } ], "user": "string", "working_dir": "string", "stop": { "signal": "string", "grace_ms": 0 }, "hostname": "string", "runtime": { "ulimits": { "property1": {}, "property2": {} }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ {} ], "dns": { "servers": [ null ], "search": [ null ], "options": [ null ] }, "shm_size_bytes": 0 }, "regions": [ "string" ], "scale": { "min_instances": 0, "max_instances": 1, "concurrency": 1, "sleep_after_ms": 600000, "sleep_notice_ms": 60000, "sleep_hold_max_ms": 900000, "suspend_after_ms": 1000, "wake_daily_at": "string", "delete_after_ms": 1000 }, "keys": { "from": { "header": "string" }, "upgrade_on_deploy": true, "delete_after_idle_ms": 1000 }, "egress": { "default": "allow", "allow": [ "string" ], "deny": [ "string" ], "http": [ { "allow": [] } ], "inject": [ { "headers": {} } ], "deny_ports": [ 1 ] }, "metadata": { "property1": "string", "property2": "string" }, "logs": { "output": true, "keep": true, "requests": { "sample_rate": 1, "keep_errors": true } }, "traces": { "sample_rate": 1, "trust_incoming": true }, "public": true, "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" } } } ], "volumes": [ { "model": "string", "name": "string", "id": "string", "shared": true, "status": "to_make", "used_by": [ "string" ] } ], "secrets": [ { "model": "string", "name": "string", "there": true, "used_by": [ "string" ] } ], "left_out": [ { "name": "string", "profiles": [ "string" ] } ], "absent": [ "string" ], "deploy": "string" }, "accounts": [ { "id": "string", "name": "string" } ], "error": { "type": "string", "code": "string", "message": "string", "param": "string", "retryable": true, "request_id": "string", "docs_url": "string" } } ``` - `error` (`createWithdrawal.response.404.error`; object, required) - `type` (`createWithdrawal.response.404.error.type`; string, required) - `code` (`createWithdrawal.response.404.error.code`; string, required) - `message` (`createWithdrawal.response.404.error.message`; string, required) - `param` (`createWithdrawal.response.404.error.param`; string | null, required) - `retryable` (`createWithdrawal.response.404.error.retryable`; boolean, required) - `request_id` (`createWithdrawal.response.404.error.request_id`; string, required) - `docs_url` (`createWithdrawal.response.404.error.docs_url`; string | null, required) - `move_id` (`createWithdrawal.response.404.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`createWithdrawal.response.404.upgrade_id`; string, optional) — With `upgrade_in_progress` (the key's upgrade that is not over), `upgrade_started` (the upgrade that has begun) and `rollback_gone` (the upgrade whose revert is refused): that upgrade. - pattern `^upg-[0-9a-hjkmnp-tv-z]{16}$` - `move` (`createWithdrawal.response.404.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`createWithdrawal.response.404.move.object`; string, required) - `id` (`createWithdrawal.response.404.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`createWithdrawal.response.404.move.sandbox_id`; string, required) - `project_id` (`createWithdrawal.response.404.move.project_id`; string, required) - `from` (`createWithdrawal.response.404.move.from`; object, required) - `id` (`createWithdrawal.response.404.move.from.id`; string, required) - `name` (`createWithdrawal.response.404.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`createWithdrawal.response.404.move.to`; object, required) - `id` (`createWithdrawal.response.404.move.to.id`; string, required) - `name` (`createWithdrawal.response.404.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`createWithdrawal.response.404.move.epoch`; integer, required) — The epoch the table held the sandbox at when the move began: the old node releases it at it, the new one takes it over one on, the old one takes it back two on, and from the object store three on. - min 1 - `step` (`createWithdrawal.response.404.move.step`; string, required) — Where it stands: `releasing` (the old node is asked to release it; the table has it there), `taking_over` (the new node is asked to take it over; the table has it there), `reclaiming` (the new node refused it, and the old one is asked to take it back), `restoring` (the old one kept nothing of it, and takes it over from the object store), `done` (on the new node), `failed` (where it was, or back there, or where a failure no time clears or an operator's cancel found it: `error` says why). - `why` (`createWithdrawal.response.404.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`createWithdrawal.response.404.move.wake`; boolean, required) — Whether the new node wakes it: as the call said, or as it was (it ran) when the move began. - `from_store` (`createWithdrawal.response.404.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`createWithdrawal.response.404.move.release`; object | null, required) — What the old node's release answered (sandboxd/openapi/openapi.json, `releaseSandbox`), without the release's key; null before it answered. - `takeover` (`createWithdrawal.response.404.move.takeover`; object | null, required) — What the takeover that ended it answered (`takeoverSandbox` of the node's document): where its disk and memory came from (`source`), how long each took (`ms`), `memory`; null before. - `error` (`createWithdrawal.response.404.move.error`; one of, required) — Why it failed, of one that failed (the new node's refusal, where it was taken back to the old node); null, of one that is done; of one under way, what the step it is at was last told where it is asked again. - one of: `object`, `null` - `attempts` (`createWithdrawal.response.404.move.attempts`; integer, required) — How many times the step it is at was asked without an answer that settles it. - min 0 - `next_attempt_at` (`createWithdrawal.response.404.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`createWithdrawal.response.404.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`createWithdrawal.response.404.move.created_at`; string, required) - format `date-time` - `updated_at` (`createWithdrawal.response.404.move.updated_at`; string, required) - format `date-time` - `ended_at` (`createWithdrawal.response.404.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`createWithdrawal.response.404.lease_until`; string, optional) — With `lease_held`: until when the node may still hold the lease it was granted last, and the time after it for the node to have seen it run out (`recoverNode` is refused until then). - format `date-time` - `active` (`createWithdrawal.response.404.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`createWithdrawal.response.404.active.name`; string, required) - `url` (`createWithdrawal.response.404.active.url`; string, required) - `term` (`createWithdrawal.response.404.active.term`; integer, required) - min 1 - `allowed_hosts` (`createWithdrawal.response.404.allowed_hosts`; array | null, optional) — With `secret_host_not_allowed`: the hosts the secret may go to, as the secret has them; null where it was given none (the node's `SecretHosts`). - `problems` (`createWithdrawal.response.404.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`createWithdrawal.response.404.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`createWithdrawal.response.404.problems.message`; string, required) - `report` (`createWithdrawal.response.404.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`createWithdrawal.response.404.report.object`; string, required) - one of `"compose_import"` - `name` (`createWithdrawal.response.404.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`createWithdrawal.response.404.report.dry_run`; boolean, required) - `strict` (`createWithdrawal.response.404.report.strict`; boolean, required) - `profiles` (`createWithdrawal.response.404.report.profiles`; array, required) - `treatments` (`createWithdrawal.response.404.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`createWithdrawal.response.404.report.treatments.done`; integer, required) - min 0 - `adapted` (`createWithdrawal.response.404.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`createWithdrawal.response.404.report.treatments.ignored`; integer, required) - min 0 - `refused` (`createWithdrawal.response.404.report.treatments.refused`; integer, required) - min 0 - `items` (`createWithdrawal.response.404.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`createWithdrawal.response.404.report.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.404.report.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.404.report.items.why`; string, required) - `change` (`createWithdrawal.response.404.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`createWithdrawal.response.404.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`createWithdrawal.response.404.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`createWithdrawal.response.404.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`createWithdrawal.response.404.report.services.status`; string, required) — What the import does (or, in a dry run, would do) to its app: makes it, writes what changed, or nothing. - one of `"created"`, `"changed"`, `"unchanged"` - `kind` (`createWithdrawal.response.404.report.services.kind`; string, required) — `job`: a service of the model waits for it to complete, and it runs to its end in each deploy that needs it. - one of `"service"`, `"job"` - `stateful` (`createWithdrawal.response.404.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`createWithdrawal.response.404.report.services.version`; boolean, required) — Whether the import's deploy makes a version of it: what its version would be made of, its references resolved, is not what its current version is. - `items` (`createWithdrawal.response.404.report.services.items`; array, required) - `at` (`createWithdrawal.response.404.report.services.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.404.report.services.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.404.report.services.items.why`; string, required) - `change` (`createWithdrawal.response.404.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`createWithdrawal.response.404.report.services.app`; object, required) — The fields of the service's app as the import writes them: what its versions are made of, and what holds at once. - `image` (`createWithdrawal.response.404.report.services.app.image`; string | null, required) — What the app's next version is made of, with the seven fields after it: its newest version's, with what was changed since. `null`: the app has no image, and no version. - `image_pull_secret` (`createWithdrawal.response.404.report.services.app.image_pull_secret`; string | null, required) — The name of the secret that holds the credentials of the image's registry. No answer has its value. `null`: none. - `start_command` (`createWithdrawal.response.404.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`createWithdrawal.response.404.report.services.app.start_args`; any of, required) — What follows the image's ENTRYPOINT in the place of its CMD. `null`: the image's CMD, or the whole of `start_command`. - any of: `array`, `null` - `port` (`createWithdrawal.response.404.report.services.app.port`; integer | null, required) - `ready` (`createWithdrawal.response.404.report.services.app.ready`; object, required) — How to tell that an instance is up, which a version's template is saved after: exactly one of the three. The first two are asked from outside the instance, so the service has to listen on every address (`0.0.0.0`). - `http` (`createWithdrawal.response.404.report.services.app.ready.http`; string, optional) — A path, beginning with `/`: a `GET` of it on the app's port is answered with a status from 200 to 399. - `tcp` (`createWithdrawal.response.404.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`createWithdrawal.response.404.report.services.app.ready.command`; one of, optional) — A command that succeeds in the instance. It is run by the instance's shell: a list of arguments is written as one line for it. - one of: `string`, `array` - `env` (`createWithdrawal.response.404.report.services.app.env`; map, required) - `secrets` (`createWithdrawal.response.404.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`createWithdrawal.response.404.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`createWithdrawal.response.404.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`createWithdrawal.response.404.report.services.app.size.memory_bytes`; integer, required) — An even number of MiB (a whole number of the 2 MiB pages a node loads a machine's memory in), in bytes. Any other size is 400 `invalid_field` (param `size.memory_bytes`): no node would make an instance of it, as none makes a sandbox of it (the node's `SandboxLimitsCreate.memory_bytes`). - min 134217728 - `volumes` (`createWithdrawal.response.404.report.services.app.volumes`; array, required) - `volume` (`createWithdrawal.response.404.report.services.app.volumes.volume`; string, required) - `path` (`createWithdrawal.response.404.report.services.app.volumes.path`; string, required) - `read_only` (`createWithdrawal.response.404.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`createWithdrawal.response.404.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`createWithdrawal.response.404.report.services.app.kind`; string, required) - `files` (`createWithdrawal.response.404.report.services.app.files`; array, required) - `path` (`createWithdrawal.response.404.report.services.app.files.path`; string, required) - `mode` (`createWithdrawal.response.404.report.services.app.files.mode`; integer, required) - `uid` (`createWithdrawal.response.404.report.services.app.files.uid`; integer, required) - `gid` (`createWithdrawal.response.404.report.services.app.files.gid`; integer, required) - `content` (`createWithdrawal.response.404.report.services.app.files.content`; string, optional) - `secret` (`createWithdrawal.response.404.report.services.app.files.secret`; string, optional) - `user` (`createWithdrawal.response.404.report.services.app.user`; string | null, required) - `working_dir` (`createWithdrawal.response.404.report.services.app.working_dir`; string | null, required) - `stop` (`createWithdrawal.response.404.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`createWithdrawal.response.404.report.services.app.hostname`; string | null, required) - `regions` (`createWithdrawal.response.404.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`createWithdrawal.response.404.report.services.app.scale`; object, required) - `min_instances` (`createWithdrawal.response.404.report.services.app.scale.min_instances`; integer, required) — How many instances of the app are kept awake in a region, whether a request comes or not: the floor. The nodes of the region that serve the app share it as they share `max_instances` (two nodes and a floor of 2: one on each; a floor of 1: one, on the node that is tried first; a floor of 5: three and two), and a node that is away is made up for by the others. A node makes its part when it is told, not at the first request, and neither stops nor deletes those instances for being idle; they are metered as instances that are awake. 0, which is what it is when nothing is said: none. Lowered, the instances beyond it are idle from that moment, and are stopped and deleted as idle instances are. At most `max_instances`, where that is given, and at most what the account's plan lets an app ask for in a region (`caps.app_instances.limit`: 5, 50 and 500): more is refused, 403 `plan_cap_reached`. - min 0 - `max_instances` (`createWithdrawal.response.404.report.services.app.scale.max_instances`; integer | null, required) — How many instances the app has at the most in a region: the nodes of the region that serve the app share it. At most what the account's plan lets an app ask for (`caps.app_instances.limit`: 5 on the free plan, 50 on `p20`, 200 on `p100`, 500 on `p300`, 1,000 on `p1000`, 2,000 on `p2000`): more is refused, 403 `plan_cap_reached`, and what an app asked for on a plan that let it is kept, and held to the plan's number. `null`: the plan's number for an app that names none (`caps.app_instances.default`: 2, 10, 20, 50, 100 and 200), or `min_instances` where that is more. What the nodes are told is no more than the account has room for awake beside everything else of it that is awake, nor less than the app has awake. - min 1 - `concurrency` (`createWithdrawal.response.404.report.services.app.scale.concurrency`; integer | null, required) — A cap on what one instance has in hand at a time: the requests the edges sent it, and the connections it has open on its project's network (through its service's address, which the node shares out among the instances connection by connection, or to its own). An instance with that many is full, and another is made for more. `null`, which is what it is when nothing is said: no cap. A node then adds an instance when the ones it has are near their size in CPU or memory, and an app does not have to guess a number; a service that takes one request at a time gives one. - min 1; max 1000 - `sleep_after_ms` (`createWithdrawal.response.404.report.services.app.scale.sleep_after_ms`; integer, required) — After how long without a request an instance stops. One that stays stopped is deleted by its node after `delete_after_ms`, and the next request that needs an instance gets a new one; the instances `min_instances` keeps awake are neither stopped nor deleted. - min 0; max 600000 - `sleep_notice_ms` (`createWithdrawal.response.404.report.services.app.scale.sleep_notice_ms`; integer | null, required) — How long before an instance stops for being idle the programs connected to its guest's `/run/sbx/awake` are sent the line `sleep N`, in milliseconds: they flush what they hold, close their connections, or raise a hold, which puts the stop off. The stop comes that long after, whether they answer or not; where nobody is connected, it is not put off. A keyed instance is told as well. 0 or null: not told (the default). - min 0; max 60000 - `sleep_hold_max_ms` (`createWithdrawal.response.404.report.services.app.scale.sleep_hold_max_ms`; integer, required) — How long the holds a program in an instance raises keep it up after its time idle has run out, in milliseconds: a program connects to `/run/sbx/awake` and sends `+` before it answers a request whose work goes on after the answer, and `-` (or closes the connection, or dies) when that work is done; the instance stops `sleep_after_ms` after the last hold is lowered. Past this time it stops whatever holds it, the programs connected told `sleep N cap` first where `sleep_notice_ms` asks for a notice. Held, it runs and is metered as running. 0: holds are not heeded. Null: 30000 (the default). - min 0; max 900000 - `delete_after_ms` (`createWithdrawal.response.404.report.services.app.scale.delete_after_ms`; integer | null, required) — After how long idle an instance is deleted, counted from where its stop is counted from: the next request that needs one gets a new instance, a clone of the version's template, without what the deleted one had gathered in its memory and on its disk (keep what is to last in a volume or a database). A second to an hour, the platform's time, which is the most: more is refused (400 `invalid_field`), and an instance that is to stay warm is one of `min_instances`. `null`, which is what it is when nothing is said: the hour of the nodes (`--app-delete-after-seconds`). A change holds for the instances the app has as for the ones made after: each node judges every instance by the app's time as it is, once a second at the least. Not for the app's keyed instances, which `keys.delete_after_idle_ms` is for. - min 1000; max 3600000 - `suspend_after_ms` (`createWithdrawal.response.404.report.services.app.scale.suspend_after_ms`; integer | null, optional) — How long a stopped instance stays paused before its memory is saved and it sleeps for real, in milliseconds: paused, the next request is answered in a millisecond or two and its memory is metered; asleep, it wakes in a few more and only what it keeps is. Its node holds it to the longest it holds any instance paused (ten minutes); the host's memory running short, a slot another machine needs and a sleep somebody asks for put it to sleep sooner. Null (the default): its node's longest. A database's `suspend_after_seconds` is its app's. - min 1000; max 86400000 - `wake_daily_at` (`createWithdrawal.response.404.report.services.app.scale.wake_daily_at`; string | null, optional) — A time of day in UTC, `HH:MM`, at which the app's keyed instances and its stateful service's instance that rest are woken every day, for work of their own that waits for a wake (a database's maintenance, say); the instances the nodes make and delete by the app's requests are woken by requests alone. The wake is no activity: what runs then is, and once that is done the instance rests again. A stateful service's instance is woken besides for the next run of its PostgreSQL server's `pg_cron` jobs, whatever this says. Null (the default): none. A database's `wake_daily_at` is its app's. - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$` - `keys` (`createWithdrawal.response.404.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`createWithdrawal.response.404.report.services.app.egress`; object | null, required) — Egress rules as a sandbox has them (`default`, `allow`, `deny`, `http`, `inject`), null when there are none; kept as the calls gave them (a `PATCH` merges them key by key, as a node does). They hold at once and make no version: the nodes that serve the app put them on every instance of its group, the ones there are (one that runs for the connections it has too) and the ones made after; a keyed instance does not have them. The control plane checks only that they are an object of those keys of at most 256 KiB: what the rules say is a node's to check, when it applies them, and an instance whose rules its node cannot read is refused everything (the node's log says why). - `default` (`createWithdrawal.response.404.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`createWithdrawal.response.404.report.services.app.egress.allow`; array | null, optional) - `deny` (`createWithdrawal.response.404.report.services.app.egress.deny`; array | null, optional) - `http` (`createWithdrawal.response.404.report.services.app.egress.http`; array | null, optional) - `inject` (`createWithdrawal.response.404.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`createWithdrawal.response.404.report.services.app.egress.deny_ports`; array | null, optional) — Ports no connection reaches, TCP or UDP, wherever it goes and whatever else the rules say. A Browsers session's always hold 25, 465, 587 and the ports mining pools listen on (3333, 4444, 5555, 7777, 14444, 45700): the control plane adds them to whatever a change of its rules gives. - `metadata` (`createWithdrawal.response.404.report.services.app.metadata`; map, required) - `logs` (`createWithdrawal.response.404.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`createWithdrawal.response.404.report.services.app.logs.output`; boolean, required) - `keep` (`createWithdrawal.response.404.report.services.app.logs.keep`; boolean, required) - `requests` (`createWithdrawal.response.404.report.services.app.logs.requests`; object, required) - `sample_rate` (`createWithdrawal.response.404.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`createWithdrawal.response.404.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`createWithdrawal.response.404.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`createWithdrawal.response.404.report.services.app.depends_on`; array, required) - `service` (`createWithdrawal.response.404.report.services.app.depends_on.service`; string, required) - `condition` (`createWithdrawal.response.404.report.services.app.depends_on.condition`; string, required) - `network` (`createWithdrawal.response.404.report.services.app.network`; object, required) - `aliases` (`createWithdrawal.response.404.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`createWithdrawal.response.404.report.services.app.network.endpoint_mode`; string, required) - `drives` (`createWithdrawal.response.404.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`createWithdrawal.response.404.report.services.app.drives.drive`; string, required) - `path` (`createWithdrawal.response.404.report.services.app.drives.path`; string, required) - `mode` (`createWithdrawal.response.404.report.services.app.drives.mode`; string, required) - `key_drives` (`createWithdrawal.response.404.report.services.app.key_drives`; array, optional) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`createWithdrawal.response.404.report.services.app.key_drives.name`; string, required) - `path` (`createWithdrawal.response.404.report.services.app.key_drives.path`; string, required) - `size_bytes` (`createWithdrawal.response.404.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`createWithdrawal.response.404.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`createWithdrawal.response.404.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`createWithdrawal.response.404.report.services.app.traces`; object, optional) — What the app's requests' traces have, each part as it was given or at its default (`AppTraceSettings`): no span where `sample_rate` is 0. - `sample_rate` (`createWithdrawal.response.404.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`createWithdrawal.response.404.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`createWithdrawal.response.404.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`createWithdrawal.response.404.report.volumes.model`; string | null, required) — Its name in the model. Null: made for a path a stateful service mounts with no volume named. - `name` (`createWithdrawal.response.404.report.volumes.name`; string, required) — Its name in the project. - `id` (`createWithdrawal.response.404.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`createWithdrawal.response.404.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`createWithdrawal.response.404.report.volumes.status`; string, required) — `to_make`: the import makes it (a dry run says so of what it would make); `made`: this import made it; `there`: an earlier import made it, or a volume of its name was there; `external`: the model names it `external`, and the project has it. - one of `"to_make"`, `"made"`, `"there"`, `"external"` - `used_by` (`createWithdrawal.response.404.report.volumes.used_by`; array, required) - `secrets` (`createWithdrawal.response.404.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`createWithdrawal.response.404.report.secrets.model`; string, required) — Its name in the model. - `name` (`createWithdrawal.response.404.report.secrets.name`; string, required) — The project's secret that holds it: the model's name, with each character a secret's name does not take written as an underscore. - `there` (`createWithdrawal.response.404.report.secrets.there`; boolean, required) — Whether the project has it. An import (not a dry run) with one that is not there is refused 404 `secret_not_found`. - `used_by` (`createWithdrawal.response.404.report.secrets.used_by`; array, required) - `left_out` (`createWithdrawal.response.404.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`createWithdrawal.response.404.report.left_out.name`; string, required) - `profiles` (`createWithdrawal.response.404.report.left_out.profiles`; array, required) - `absent` (`createWithdrawal.response.404.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`createWithdrawal.response.404.report.deploy`; string | null, required) — The deploy the import made (`GET /v1/deploys/{id}`). Null: a dry run, or nothing would get a version. - pattern `^dpl-` - `accounts` (`createWithdrawal.response.404.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`createWithdrawal.response.404.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`createWithdrawal.response.404.accounts.name`; string, required) ### 409 `withdrawal_period_over`: the fourteen days are over (the message says when it was bought, and when they ended); `nothing_to_withdraw`: it is no purchase to withdraw from (it is not collected, failed or was refunded; it paid what was owed; it renewed a subscription; the period it paid for is over; a top-up asked for at once whose Credits are all used, which has been provided in full), and the message says which; `already_withdrawn`: it was withdrawn from before (the message names the withdrawal); `subscription_charge_pending`: a charge of the account's subscription is being collected, `retryable`; `idempotency_key_reused`: the account has used this `Idempotency-Key` with another body. #### Example ```json { "move_id": "string", "upgrade_id": "string", "move": { "object": "move", "id": "string", "sandbox_id": "string", "project_id": "string", "from": { "id": "string", "name": "string" }, "to": { "id": "string", "name": "string" }, "epoch": 1, "step": "string", "why": "string", "wake": true, "from_store": true, "release": {}, "takeover": {}, "error": { "code": "string", "message": "string", "status": 0, "takeover_refused": { "code": "string", "message": "string", "status": 0 }, "image": "string", "holder": "string", "holder_says": "has" }, "attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "batch": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" }, "lease_until": "2019-08-24T14:15:22Z", "active": { "name": "string", "url": "string", "term": 1 }, "allowed_hosts": [ "string" ], "problems": [ { "at": "string", "message": "string" } ], "report": { "object": "compose_import", "name": "string", "dry_run": true, "strict": true, "profiles": [ "string" ], "treatments": { "done": 0, "adapted": 0, "ignored": 0, "refused": 0 }, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "services": [ { "name": "string", "app_id": "string", "status": "created", "kind": "service", "stateful": true, "version": true, "items": [ { "at": "string", "treatment": "done", "why": "string", "change": "string" } ], "app": { "image": "string", "image_pull_secret": "string", "start_command": "string", "start_args": [ "string" ], "port": 0, "ready": { "http": "string" }, "env": { "property1": "string", "property2": "string" }, "secrets": { "property1": "string", "property2": "string" }, "size": { "vcpus": 1, "memory_bytes": 134217728 }, "volumes": [ { "volume": "string", "path": "string", "read_only": true, "nocopy": true } ], "drives": [ { "drive": "string", "path": "string", "mode": "string" } ], "key_drives": [ { "name": "string", "path": "string", "size_bytes": 0, "nocopy": true } ], "kind": "string", "files": [ { "path": "string", "content": "string", "secret": "string", "mode": 0, "uid": 0, "gid": 0 } ], "user": "string", "working_dir": "string", "stop": { "signal": "string", "grace_ms": 0 }, "hostname": "string", "runtime": { "ulimits": { "property1": {}, "property2": {} }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ {} ], "dns": { "servers": [ null ], "search": [ null ], "options": [ null ] }, "shm_size_bytes": 0 }, "regions": [ "string" ], "scale": { "min_instances": 0, "max_instances": 1, "concurrency": 1, "sleep_after_ms": 600000, "sleep_notice_ms": 60000, "sleep_hold_max_ms": 900000, "suspend_after_ms": 1000, "wake_daily_at": "string", "delete_after_ms": 1000 }, "keys": { "from": { "header": "string" }, "upgrade_on_deploy": true, "delete_after_idle_ms": 1000 }, "egress": { "default": "allow", "allow": [ "string" ], "deny": [ "string" ], "http": [ { "allow": [] } ], "inject": [ { "headers": {} } ], "deny_ports": [ 1 ] }, "metadata": { "property1": "string", "property2": "string" }, "logs": { "output": true, "keep": true, "requests": { "sample_rate": 1, "keep_errors": true } }, "traces": { "sample_rate": 1, "trust_incoming": true }, "public": true, "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" } } } ], "volumes": [ { "model": "string", "name": "string", "id": "string", "shared": true, "status": "to_make", "used_by": [ "string" ] } ], "secrets": [ { "model": "string", "name": "string", "there": true, "used_by": [ "string" ] } ], "left_out": [ { "name": "string", "profiles": [ "string" ] } ], "absent": [ "string" ], "deploy": "string" }, "accounts": [ { "id": "string", "name": "string" } ], "error": { "type": "string", "code": "string", "message": "string", "param": "string", "retryable": true, "request_id": "string", "docs_url": "string" } } ``` - `error` (`createWithdrawal.response.409.error`; object, required) - `type` (`createWithdrawal.response.409.error.type`; string, required) - `code` (`createWithdrawal.response.409.error.code`; string, required) - `message` (`createWithdrawal.response.409.error.message`; string, required) - `param` (`createWithdrawal.response.409.error.param`; string | null, required) - `retryable` (`createWithdrawal.response.409.error.retryable`; boolean, required) - `request_id` (`createWithdrawal.response.409.error.request_id`; string, required) - `docs_url` (`createWithdrawal.response.409.error.docs_url`; string | null, required) - `move_id` (`createWithdrawal.response.409.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`createWithdrawal.response.409.upgrade_id`; string, optional) — With `upgrade_in_progress` (the key's upgrade that is not over), `upgrade_started` (the upgrade that has begun) and `rollback_gone` (the upgrade whose revert is refused): that upgrade. - pattern `^upg-[0-9a-hjkmnp-tv-z]{16}$` - `move` (`createWithdrawal.response.409.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`createWithdrawal.response.409.move.object`; string, required) - `id` (`createWithdrawal.response.409.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`createWithdrawal.response.409.move.sandbox_id`; string, required) - `project_id` (`createWithdrawal.response.409.move.project_id`; string, required) - `from` (`createWithdrawal.response.409.move.from`; object, required) - `id` (`createWithdrawal.response.409.move.from.id`; string, required) - `name` (`createWithdrawal.response.409.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`createWithdrawal.response.409.move.to`; object, required) - `id` (`createWithdrawal.response.409.move.to.id`; string, required) - `name` (`createWithdrawal.response.409.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`createWithdrawal.response.409.move.epoch`; integer, required) — The epoch the table held the sandbox at when the move began: the old node releases it at it, the new one takes it over one on, the old one takes it back two on, and from the object store three on. - min 1 - `step` (`createWithdrawal.response.409.move.step`; string, required) — Where it stands: `releasing` (the old node is asked to release it; the table has it there), `taking_over` (the new node is asked to take it over; the table has it there), `reclaiming` (the new node refused it, and the old one is asked to take it back), `restoring` (the old one kept nothing of it, and takes it over from the object store), `done` (on the new node), `failed` (where it was, or back there, or where a failure no time clears or an operator's cancel found it: `error` says why). - `why` (`createWithdrawal.response.409.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`createWithdrawal.response.409.move.wake`; boolean, required) — Whether the new node wakes it: as the call said, or as it was (it ran) when the move began. - `from_store` (`createWithdrawal.response.409.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`createWithdrawal.response.409.move.release`; object | null, required) — What the old node's release answered (sandboxd/openapi/openapi.json, `releaseSandbox`), without the release's key; null before it answered. - `takeover` (`createWithdrawal.response.409.move.takeover`; object | null, required) — What the takeover that ended it answered (`takeoverSandbox` of the node's document): where its disk and memory came from (`source`), how long each took (`ms`), `memory`; null before. - `error` (`createWithdrawal.response.409.move.error`; one of, required) — Why it failed, of one that failed (the new node's refusal, where it was taken back to the old node); null, of one that is done; of one under way, what the step it is at was last told where it is asked again. - one of: `object`, `null` - `attempts` (`createWithdrawal.response.409.move.attempts`; integer, required) — How many times the step it is at was asked without an answer that settles it. - min 0 - `next_attempt_at` (`createWithdrawal.response.409.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`createWithdrawal.response.409.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`createWithdrawal.response.409.move.created_at`; string, required) - format `date-time` - `updated_at` (`createWithdrawal.response.409.move.updated_at`; string, required) - format `date-time` - `ended_at` (`createWithdrawal.response.409.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`createWithdrawal.response.409.lease_until`; string, optional) — With `lease_held`: until when the node may still hold the lease it was granted last, and the time after it for the node to have seen it run out (`recoverNode` is refused until then). - format `date-time` - `active` (`createWithdrawal.response.409.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`createWithdrawal.response.409.active.name`; string, required) - `url` (`createWithdrawal.response.409.active.url`; string, required) - `term` (`createWithdrawal.response.409.active.term`; integer, required) - min 1 - `allowed_hosts` (`createWithdrawal.response.409.allowed_hosts`; array | null, optional) — With `secret_host_not_allowed`: the hosts the secret may go to, as the secret has them; null where it was given none (the node's `SecretHosts`). - `problems` (`createWithdrawal.response.409.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`createWithdrawal.response.409.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`createWithdrawal.response.409.problems.message`; string, required) - `report` (`createWithdrawal.response.409.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`createWithdrawal.response.409.report.object`; string, required) - one of `"compose_import"` - `name` (`createWithdrawal.response.409.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`createWithdrawal.response.409.report.dry_run`; boolean, required) - `strict` (`createWithdrawal.response.409.report.strict`; boolean, required) - `profiles` (`createWithdrawal.response.409.report.profiles`; array, required) - `treatments` (`createWithdrawal.response.409.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`createWithdrawal.response.409.report.treatments.done`; integer, required) - min 0 - `adapted` (`createWithdrawal.response.409.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`createWithdrawal.response.409.report.treatments.ignored`; integer, required) - min 0 - `refused` (`createWithdrawal.response.409.report.treatments.refused`; integer, required) - min 0 - `items` (`createWithdrawal.response.409.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`createWithdrawal.response.409.report.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.409.report.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.409.report.items.why`; string, required) - `change` (`createWithdrawal.response.409.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`createWithdrawal.response.409.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`createWithdrawal.response.409.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`createWithdrawal.response.409.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`createWithdrawal.response.409.report.services.status`; string, required) — What the import does (or, in a dry run, would do) to its app: makes it, writes what changed, or nothing. - one of `"created"`, `"changed"`, `"unchanged"` - `kind` (`createWithdrawal.response.409.report.services.kind`; string, required) — `job`: a service of the model waits for it to complete, and it runs to its end in each deploy that needs it. - one of `"service"`, `"job"` - `stateful` (`createWithdrawal.response.409.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`createWithdrawal.response.409.report.services.version`; boolean, required) — Whether the import's deploy makes a version of it: what its version would be made of, its references resolved, is not what its current version is. - `items` (`createWithdrawal.response.409.report.services.items`; array, required) - `at` (`createWithdrawal.response.409.report.services.items.at`; string, required) — Where in the model: of a service, its attribute (`ports[0]`, `depends_on.db`, `environment.KEY`), empty for the service as a whole; of the top level, the element (`volumes.db-data`). - `treatment` (`createWithdrawal.response.409.report.services.items.treatment`; string, required) — `done`: it means the same on the platform; `adapted`: the platform does the same another way; `ignored`: it matters to a local run alone (refused with `strict`); `refused`: the platform cannot do it, and doing without it would let the program go wrong quietly. - one of `"done"`, `"adapted"`, `"ignored"`, `"refused"` - `why` (`createWithdrawal.response.409.report.services.items.why`; string, required) - `change` (`createWithdrawal.response.409.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`createWithdrawal.response.409.report.services.app`; object, required) — The fields of the service's app as the import writes them: what its versions are made of, and what holds at once. - `image` (`createWithdrawal.response.409.report.services.app.image`; string | null, required) — What the app's next version is made of, with the seven fields after it: its newest version's, with what was changed since. `null`: the app has no image, and no version. - `image_pull_secret` (`createWithdrawal.response.409.report.services.app.image_pull_secret`; string | null, required) — The name of the secret that holds the credentials of the image's registry. No answer has its value. `null`: none. - `start_command` (`createWithdrawal.response.409.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`createWithdrawal.response.409.report.services.app.start_args`; any of, required) — What follows the image's ENTRYPOINT in the place of its CMD. `null`: the image's CMD, or the whole of `start_command`. - any of: `array`, `null` - `port` (`createWithdrawal.response.409.report.services.app.port`; integer | null, required) - `ready` (`createWithdrawal.response.409.report.services.app.ready`; object, required) — How to tell that an instance is up, which a version's template is saved after: exactly one of the three. The first two are asked from outside the instance, so the service has to listen on every address (`0.0.0.0`). - `http` (`createWithdrawal.response.409.report.services.app.ready.http`; string, optional) — A path, beginning with `/`: a `GET` of it on the app's port is answered with a status from 200 to 399. - `tcp` (`createWithdrawal.response.409.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`createWithdrawal.response.409.report.services.app.ready.command`; one of, optional) — A command that succeeds in the instance. It is run by the instance's shell: a list of arguments is written as one line for it. - one of: `string`, `array` - `env` (`createWithdrawal.response.409.report.services.app.env`; map, required) - `secrets` (`createWithdrawal.response.409.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`createWithdrawal.response.409.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`createWithdrawal.response.409.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`createWithdrawal.response.409.report.services.app.size.memory_bytes`; integer, required) — An even number of MiB (a whole number of the 2 MiB pages a node loads a machine's memory in), in bytes. Any other size is 400 `invalid_field` (param `size.memory_bytes`): no node would make an instance of it, as none makes a sandbox of it (the node's `SandboxLimitsCreate.memory_bytes`). - min 134217728 - `volumes` (`createWithdrawal.response.409.report.services.app.volumes`; array, required) - `volume` (`createWithdrawal.response.409.report.services.app.volumes.volume`; string, required) - `path` (`createWithdrawal.response.409.report.services.app.volumes.path`; string, required) - `read_only` (`createWithdrawal.response.409.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`createWithdrawal.response.409.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`createWithdrawal.response.409.report.services.app.kind`; string, required) - `files` (`createWithdrawal.response.409.report.services.app.files`; array, required) - `path` (`createWithdrawal.response.409.report.services.app.files.path`; string, required) - `mode` (`createWithdrawal.response.409.report.services.app.files.mode`; integer, required) - `uid` (`createWithdrawal.response.409.report.services.app.files.uid`; integer, required) - `gid` (`createWithdrawal.response.409.report.services.app.files.gid`; integer, required) - `content` (`createWithdrawal.response.409.report.services.app.files.content`; string, optional) - `secret` (`createWithdrawal.response.409.report.services.app.files.secret`; string, optional) - `user` (`createWithdrawal.response.409.report.services.app.user`; string | null, required) - `working_dir` (`createWithdrawal.response.409.report.services.app.working_dir`; string | null, required) - `stop` (`createWithdrawal.response.409.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`createWithdrawal.response.409.report.services.app.hostname`; string | null, required) - `regions` (`createWithdrawal.response.409.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`createWithdrawal.response.409.report.services.app.scale`; object, required) - `min_instances` (`createWithdrawal.response.409.report.services.app.scale.min_instances`; integer, required) — How many instances of the app are kept awake in a region, whether a request comes or not: the floor. The nodes of the region that serve the app share it as they share `max_instances` (two nodes and a floor of 2: one on each; a floor of 1: one, on the node that is tried first; a floor of 5: three and two), and a node that is away is made up for by the others. A node makes its part when it is told, not at the first request, and neither stops nor deletes those instances for being idle; they are metered as instances that are awake. 0, which is what it is when nothing is said: none. Lowered, the instances beyond it are idle from that moment, and are stopped and deleted as idle instances are. At most `max_instances`, where that is given, and at most what the account's plan lets an app ask for in a region (`caps.app_instances.limit`: 5, 50 and 500): more is refused, 403 `plan_cap_reached`. - min 0 - `max_instances` (`createWithdrawal.response.409.report.services.app.scale.max_instances`; integer | null, required) — How many instances the app has at the most in a region: the nodes of the region that serve the app share it. At most what the account's plan lets an app ask for (`caps.app_instances.limit`: 5 on the free plan, 50 on `p20`, 200 on `p100`, 500 on `p300`, 1,000 on `p1000`, 2,000 on `p2000`): more is refused, 403 `plan_cap_reached`, and what an app asked for on a plan that let it is kept, and held to the plan's number. `null`: the plan's number for an app that names none (`caps.app_instances.default`: 2, 10, 20, 50, 100 and 200), or `min_instances` where that is more. What the nodes are told is no more than the account has room for awake beside everything else of it that is awake, nor less than the app has awake. - min 1 - `concurrency` (`createWithdrawal.response.409.report.services.app.scale.concurrency`; integer | null, required) — A cap on what one instance has in hand at a time: the requests the edges sent it, and the connections it has open on its project's network (through its service's address, which the node shares out among the instances connection by connection, or to its own). An instance with that many is full, and another is made for more. `null`, which is what it is when nothing is said: no cap. A node then adds an instance when the ones it has are near their size in CPU or memory, and an app does not have to guess a number; a service that takes one request at a time gives one. - min 1; max 1000 - `sleep_after_ms` (`createWithdrawal.response.409.report.services.app.scale.sleep_after_ms`; integer, required) — After how long without a request an instance stops. One that stays stopped is deleted by its node after `delete_after_ms`, and the next request that needs an instance gets a new one; the instances `min_instances` keeps awake are neither stopped nor deleted. - min 0; max 600000 - `sleep_notice_ms` (`createWithdrawal.response.409.report.services.app.scale.sleep_notice_ms`; integer | null, required) — How long before an instance stops for being idle the programs connected to its guest's `/run/sbx/awake` are sent the line `sleep N`, in milliseconds: they flush what they hold, close their connections, or raise a hold, which puts the stop off. The stop comes that long after, whether they answer or not; where nobody is connected, it is not put off. A keyed instance is told as well. 0 or null: not told (the default). - min 0; max 60000 - `sleep_hold_max_ms` (`createWithdrawal.response.409.report.services.app.scale.sleep_hold_max_ms`; integer, required) — How long the holds a program in an instance raises keep it up after its time idle has run out, in milliseconds: a program connects to `/run/sbx/awake` and sends `+` before it answers a request whose work goes on after the answer, and `-` (or closes the connection, or dies) when that work is done; the instance stops `sleep_after_ms` after the last hold is lowered. Past this time it stops whatever holds it, the programs connected told `sleep N cap` first where `sleep_notice_ms` asks for a notice. Held, it runs and is metered as running. 0: holds are not heeded. Null: 30000 (the default). - min 0; max 900000 - `delete_after_ms` (`createWithdrawal.response.409.report.services.app.scale.delete_after_ms`; integer | null, required) — After how long idle an instance is deleted, counted from where its stop is counted from: the next request that needs one gets a new instance, a clone of the version's template, without what the deleted one had gathered in its memory and on its disk (keep what is to last in a volume or a database). A second to an hour, the platform's time, which is the most: more is refused (400 `invalid_field`), and an instance that is to stay warm is one of `min_instances`. `null`, which is what it is when nothing is said: the hour of the nodes (`--app-delete-after-seconds`). A change holds for the instances the app has as for the ones made after: each node judges every instance by the app's time as it is, once a second at the least. Not for the app's keyed instances, which `keys.delete_after_idle_ms` is for. - min 1000; max 3600000 - `suspend_after_ms` (`createWithdrawal.response.409.report.services.app.scale.suspend_after_ms`; integer | null, optional) — How long a stopped instance stays paused before its memory is saved and it sleeps for real, in milliseconds: paused, the next request is answered in a millisecond or two and its memory is metered; asleep, it wakes in a few more and only what it keeps is. Its node holds it to the longest it holds any instance paused (ten minutes); the host's memory running short, a slot another machine needs and a sleep somebody asks for put it to sleep sooner. Null (the default): its node's longest. A database's `suspend_after_seconds` is its app's. - min 1000; max 86400000 - `wake_daily_at` (`createWithdrawal.response.409.report.services.app.scale.wake_daily_at`; string | null, optional) — A time of day in UTC, `HH:MM`, at which the app's keyed instances and its stateful service's instance that rest are woken every day, for work of their own that waits for a wake (a database's maintenance, say); the instances the nodes make and delete by the app's requests are woken by requests alone. The wake is no activity: what runs then is, and once that is done the instance rests again. A stateful service's instance is woken besides for the next run of its PostgreSQL server's `pg_cron` jobs, whatever this says. Null (the default): none. A database's `wake_daily_at` is its app's. - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$` - `keys` (`createWithdrawal.response.409.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`createWithdrawal.response.409.report.services.app.egress`; object | null, required) — Egress rules as a sandbox has them (`default`, `allow`, `deny`, `http`, `inject`), null when there are none; kept as the calls gave them (a `PATCH` merges them key by key, as a node does). They hold at once and make no version: the nodes that serve the app put them on every instance of its group, the ones there are (one that runs for the connections it has too) and the ones made after; a keyed instance does not have them. The control plane checks only that they are an object of those keys of at most 256 KiB: what the rules say is a node's to check, when it applies them, and an instance whose rules its node cannot read is refused everything (the node's log says why). - `default` (`createWithdrawal.response.409.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`createWithdrawal.response.409.report.services.app.egress.allow`; array | null, optional) - `deny` (`createWithdrawal.response.409.report.services.app.egress.deny`; array | null, optional) - `http` (`createWithdrawal.response.409.report.services.app.egress.http`; array | null, optional) - `inject` (`createWithdrawal.response.409.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`createWithdrawal.response.409.report.services.app.egress.deny_ports`; array | null, optional) — Ports no connection reaches, TCP or UDP, wherever it goes and whatever else the rules say. A Browsers session's always hold 25, 465, 587 and the ports mining pools listen on (3333, 4444, 5555, 7777, 14444, 45700): the control plane adds them to whatever a change of its rules gives. - `metadata` (`createWithdrawal.response.409.report.services.app.metadata`; map, required) - `logs` (`createWithdrawal.response.409.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`createWithdrawal.response.409.report.services.app.logs.output`; boolean, required) - `keep` (`createWithdrawal.response.409.report.services.app.logs.keep`; boolean, required) - `requests` (`createWithdrawal.response.409.report.services.app.logs.requests`; object, required) - `sample_rate` (`createWithdrawal.response.409.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`createWithdrawal.response.409.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`createWithdrawal.response.409.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`createWithdrawal.response.409.report.services.app.depends_on`; array, required) - `service` (`createWithdrawal.response.409.report.services.app.depends_on.service`; string, required) - `condition` (`createWithdrawal.response.409.report.services.app.depends_on.condition`; string, required) - `network` (`createWithdrawal.response.409.report.services.app.network`; object, required) - `aliases` (`createWithdrawal.response.409.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`createWithdrawal.response.409.report.services.app.network.endpoint_mode`; string, required) - `drives` (`createWithdrawal.response.409.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`createWithdrawal.response.409.report.services.app.drives.drive`; string, required) - `path` (`createWithdrawal.response.409.report.services.app.drives.path`; string, required) - `mode` (`createWithdrawal.response.409.report.services.app.drives.mode`; string, required) - `key_drives` (`createWithdrawal.response.409.report.services.app.key_drives`; array, optional) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`createWithdrawal.response.409.report.services.app.key_drives.name`; string, required) - `path` (`createWithdrawal.response.409.report.services.app.key_drives.path`; string, required) - `size_bytes` (`createWithdrawal.response.409.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`createWithdrawal.response.409.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`createWithdrawal.response.409.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`createWithdrawal.response.409.report.services.app.traces`; object, optional) — What the app's requests' traces have, each part as it was given or at its default (`AppTraceSettings`): no span where `sample_rate` is 0. - `sample_rate` (`createWithdrawal.response.409.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`createWithdrawal.response.409.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`createWithdrawal.response.409.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`createWithdrawal.response.409.report.volumes.model`; string | null, required) — Its name in the model. Null: made for a path a stateful service mounts with no volume named. - `name` (`createWithdrawal.response.409.report.volumes.name`; string, required) — Its name in the project. - `id` (`createWithdrawal.response.409.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`createWithdrawal.response.409.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`createWithdrawal.response.409.report.volumes.status`; string, required) — `to_make`: the import makes it (a dry run says so of what it would make); `made`: this import made it; `there`: an earlier import made it, or a volume of its name was there; `external`: the model names it `external`, and the project has it. - one of `"to_make"`, `"made"`, `"there"`, `"external"` - `used_by` (`createWithdrawal.response.409.report.volumes.used_by`; array, required) - `secrets` (`createWithdrawal.response.409.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`createWithdrawal.response.409.report.secrets.model`; string, required) — Its name in the model. - `name` (`createWithdrawal.response.409.report.secrets.name`; string, required) — The project's secret that holds it: the model's name, with each character a secret's name does not take written as an underscore. - `there` (`createWithdrawal.response.409.report.secrets.there`; boolean, required) — Whether the project has it. An import (not a dry run) with one that is not there is refused 404 `secret_not_found`. - `used_by` (`createWithdrawal.response.409.report.secrets.used_by`; array, required) - `left_out` (`createWithdrawal.response.409.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`createWithdrawal.response.409.report.left_out.name`; string, required) - `profiles` (`createWithdrawal.response.409.report.left_out.profiles`; array, required) - `absent` (`createWithdrawal.response.409.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`createWithdrawal.response.409.report.deploy`; string | null, required) — The deploy the import made (`GET /v1/deploys/{id}`). Null: a dry run, or nothing would get a version. - pattern `^dpl-` - `accounts` (`createWithdrawal.response.409.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`createWithdrawal.response.409.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`createWithdrawal.response.409.accounts.name`; string, required) Source: https://glac.ai/docs/api/billing/create-withdrawal/index.md