--- title: "Send an app's traffic to one of its versions that is ready" description: "Where a node has the version's template, the traffic goes to the version from the moment the call is answered, and nothing is built: the nodes that have the template are told of the version before the traffic moves, and the version the traffic leaves is taken off them after. An earlier version or a later one. A deploy that was going on ends: its version takes no traffic when it is ready.\n\nWhere no node has the version's template (it was taken off the nodes when the app had newer versions to go back to: the version's `collected_at`), the version is built again first, as a deploy builds one: with the image it was resolved to when it was first deployed, and the project's secrets as they are now. The call is answered 202 at once; the version is `building`, the app is deploying it (`deploying`), and the traffic stays where it is until every node has the template, and for good if the version cannot be built again: it is then `failed` with why (`app.deploy_failed`), and a rollback to it may be asked for again. `GET /v1/apps/{app}/versions/{version}?wait_seconds=` waits for it as for a deploy, and `app.deployed` says when the traffic has moved. Takes `write`." --- > 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 › Cube › Apps `POST /v1/apps/{app}/rollback` Where a node has the version's template, the traffic goes to the version from the moment the call is answered, and nothing is built: the nodes that have the template are told of the version before the traffic moves, and the version the traffic leaves is taken off them after. An earlier version or a later one. A deploy that was going on ends: its version takes no traffic when it is ready. Where no node has the version's template (it was taken off the nodes when the app had newer versions to go back to: the version's `collected_at`), the version is built again first, as a deploy builds one: with the image it was resolved to when it was first deployed, and the project's secrets as they are now. The call is answered 202 at once; the version is `building`, the app is deploying it (`deploying`), and the traffic stays where it is until every node has the template, and for good if the version cannot be built again: it is then `failed` with why (`app.deploy_failed`), and a rollback to it may be asked for again. `GET /v1/apps/{app}/versions/{version}?wait_seconds=` waits for it as for a deploy, and `app.deployed` says when the traffic has moved. Takes `write`. ## Authentication - `apiKey`, http, header `Authorization`, scopes: `write` ## Path parameters - `app` (`rollbackApp.path.app`; string, required) — The app's id (`app-...`) or its name. ## Header parameters - `Idempotency-Key` (`rollbackApp.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._ - `version` (`rollbackApp.version`; string | integer, required) — One of the app's versions that is `ready`: its id, or its number. ## Example request ```json { "version": "string" } ``` ## Code samples ### cURL ```bash curl --request POST \ --url 'https://api.glac.ai/v1/apps//rollback' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "version": "string" } ' ``` ### TypeScript ```typescript const url = 'https://api.glac.ai/v1/apps//rollback'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({version: '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/apps//rollback" payload = { "version": "string" } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 200 The app, with `current_version` the version named and `deploying` null. #### Example ```json { "managed_by": { "object": "database", "id": "string" }, "public": true, "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 } ], "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" }, "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": { "soft": -1, "hard": -1 }, "property2": { "soft": -1, "hard": -1 } }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ { "path": "string", "size_bytes": 0, "mode": 0 } ], "dns": { "servers": [ "string" ], "search": [ "string" ], "options": [ "string" ] }, "shm_size_bytes": 0 }, "private": { "address": "string", "domain": "string" }, "id": "string", "object": "app", "name": "string", "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 }, "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": [ { "host": "string", "allow": [ { "methods": [ "string" ], "paths": [ "string" ] } ] } ], "inject": [ { "host": "string", "headers": { "property1": "string", "property2": "string" } } ], "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 }, "url": "string", "direct": true, "checkpoint": { "every_seconds": 1 }, "direct_url": "string", "current_version": "string", "deploying": "string", "build_failures": [ { "node_id": "string", "version_id": "string", "error": { "code": "string", "message": "string" }, "failed_at": "2019-08-24T14:15:22Z" } ], "logs_state": { "nodes": [ { "node_id": "string", "for_good": true, "reason": "setting", "since": "2019-08-24T14:15:22Z" } ] }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ``` - `managed_by` (`rollbackApp.response.200.managed_by`; object | null, required) — What changes it alone, where something does. `object` `database`: the database it is under (`id`, `/v1/databases`); every other call that would change it is refused, 409 `managed_by_database`. `object` `sandboxes` (`id` null): the Sandboxes product's, made by the creates of the project's sandboxes (`POST /v1/sandboxes`): the project's default sandbox app, `sbx-sandbox` (its `image` null: each sandbox is made from the base template of the node it goes to, until the project names an image for it, `PATCH` with `image` alone, a new version made of that image, of which the creates that name no image are made from then on), or the app of an image a create named (`image`, as the create named it; `sbx--<12 hex digits>`, one version). A version is ready from when it is made, and the app's instances are the project's sandboxes; every call of it but reading it and its versions, naming the default sandbox app's image and deleting it (its versions' templates go with it; the next create of its image, or of none, makes it again) is refused, 409 `managed_by_sandboxes`. Null: none's. `object` `installation`: the installation of a Managed Application it is part of (`id`, `/v1/installations`), which changes it alone: every other call that would change it is refused, 409 `managed_by_installation`. - `object` (`rollbackApp.response.200.managed_by.object`; string, required) - one of `"database"`, `"sandboxes"`, `"installation"` - `id` (`rollbackApp.response.200.managed_by.id`; string | null, required) - `public` (`rollbackApp.response.200.public`; boolean, required) — Whether it answers at its default domain (`url`). - `volumes` (`rollbackApp.response.200.volumes`; array, required) - `volume` (`rollbackApp.response.200.volumes.volume`; string, required) - `path` (`rollbackApp.response.200.volumes.path`; string, required) - `read_only` (`rollbackApp.response.200.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.200.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `drives` (`rollbackApp.response.200.drives`; array, required) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.200.drives.drive`; string, required) - `path` (`rollbackApp.response.200.drives.path`; string, required) - `mode` (`rollbackApp.response.200.drives.mode`; string, required) - `key_drives` (`rollbackApp.response.200.key_drives`; array, required) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`rollbackApp.response.200.key_drives.name`; string, required) - `path` (`rollbackApp.response.200.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.200.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.200.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `depends_on` (`rollbackApp.response.200.depends_on`; array, required) - `service` (`rollbackApp.response.200.depends_on.service`; string, required) - `condition` (`rollbackApp.response.200.depends_on.condition`; string, required) - `network` (`rollbackApp.response.200.network`; object, required) - `aliases` (`rollbackApp.response.200.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.200.network.endpoint_mode`; string, required) - `kind` (`rollbackApp.response.200.kind`; string, required) - `files` (`rollbackApp.response.200.files`; array, required) - `path` (`rollbackApp.response.200.files.path`; string, required) - `mode` (`rollbackApp.response.200.files.mode`; integer, required) - `uid` (`rollbackApp.response.200.files.uid`; integer, required) - `gid` (`rollbackApp.response.200.files.gid`; integer, required) - `content` (`rollbackApp.response.200.files.content`; string, optional) - `secret` (`rollbackApp.response.200.files.secret`; string, optional) - `user` (`rollbackApp.response.200.user`; string | null, required) - `working_dir` (`rollbackApp.response.200.working_dir`; string | null, required) - `stop` (`rollbackApp.response.200.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.200.hostname`; string | null, required) - `runtime` (`rollbackApp.response.200.runtime`; any of, required) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `private` (`rollbackApp.response.200.private`; object, required) — Where the project's sandboxes on its network find the app: its address there, which it keeps for as long as it is there, renamed or not; and its name under `internal`. A sandbox of the project on the network finds it by its name, by `domain`, and by each of its `network.aliases` with and without `.internal`. - `address` (`rollbackApp.response.200.private.address`; string | null, required) — An address of the project's ranges (`GET /v1/project`). `null` only where every range of the site is cut. - pattern `^10\.(6[4-9]|[7-9][0-9]|1[01][0-9]|12[0-7])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){2}$` - `domain` (`rollbackApp.response.200.private.domain`; string, required) — `.internal`. - `id` (`rollbackApp.response.200.id`; string, required) - pattern `^app-[0-9a-hjkmnp-tv-z]{16}$` - `object` (`rollbackApp.response.200.object`; string, required) - one of `"app"` - `name` (`rollbackApp.response.200.name`; string, required) - `image` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.response.200.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` (`rollbackApp.response.200.port`; integer | null, required) - `ready` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.response.200.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` (`rollbackApp.response.200.env`; map, required) - `secrets` (`rollbackApp.response.200.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.200.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.200.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.response.200.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 - `regions` (`rollbackApp.response.200.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.200.scale`; object, required) - `min_instances` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.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` (`rollbackApp.response.200.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.response.200.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` (`rollbackApp.response.200.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.200.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.200.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.200.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.200.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.response.200.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` (`rollbackApp.response.200.metadata`; map, required) - `logs` (`rollbackApp.response.200.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`rollbackApp.response.200.logs.output`; boolean, required) - `keep` (`rollbackApp.response.200.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.200.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.200.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.200.logs.requests.keep_errors`; boolean, required) - `traces` (`rollbackApp.response.200.traces`; object, required) — 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` (`rollbackApp.response.200.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.200.traces.trust_incoming`; boolean, required) - `url` (`rollbackApp.response.200.url`; string | null, required) — Where the app answers: `https://` and its default domain, `-.`. It is the app's from the moment it is made (503 `app_not_deployed` until its first version is ready) and for as long as the app has its name. `null` on a control plane that is told no zone for apps (`--app-zone`). - `direct` (`rollbackApp.response.200.direct`; boolean, required) — Whether the app answers at a name that reaches the edges without the platform's proxy as well (`direct_url`): there a request has no limit of the proxy's on its body or on how long its answer may pause, and nothing but the edge's own limits protects the app. - `checkpoint` (`rollbackApp.response.200.checkpoint`; one of, required) — Checkpoints of its keyed instances while they run: every `every_seconds` (10 unless said, 1 to 600) an instance's memory and disk as they are at one instant go to its node's object store, and when its node's host is lost the instance is taken over on another node from its newest checkpoint with its processes, losing at most what it did since (an instance that sleeps is taken over from its sleep, which loses nothing). Its node pauses it for a few milliseconds for each; what it wrote since the last one is what is sent, compressed, and one that writes more than its node's link for checkpoints takes falls behind instead of filling it (the instance's `checkpoint`: `last_at`, `behind_seconds`, `bytes_per_second`, `stored_bytes`). What the store keeps of an instance's newest checkpoint is billed as sleeping state (`state`) while it runs; nothing for what is sent. Holds at once and makes no version: the instances that are there are given it, those made later are made with it. Not a stateful service's instance: its volume has no copy in the store. An instance's Drives (its own `key_drives` too) are pinned with its disk at the same instant, and a takeover brings them back as they were then; an instance with a volume that is not a Drive takes none, and its `checkpoint.error` says so. Null: none (the default). - one of: `object`, `null` - `direct_url` (`rollbackApp.response.200.direct_url`; string | null, required) — Where the app answers without the proxy: its default domain's label under the platform's direct zone (`https://-.direct.glac.run`). Null unless it says `direct`, and where the platform has no proxy. - `current_version` (`rollbackApp.response.200.current_version`; string | null, required) — The id of the version the app's traffic goes to: the newest deploy that came up, or what a rollback named. `null` until a version is ready. - `deploying` (`rollbackApp.response.200.deploying`; string | null, required) — The id of the version that is being deployed and takes the traffic when it is ready. - `build_failures` (`rollbackApp.response.200.build_failures`; array, required) — The nodes that are to serve the version the app's traffic goes to and could not build it when they were asked to after its deploy (a node that joined, one whose template of it is of no use any more, one that came back), one an item, by the node's id; empty where there are none. A node whose build failed is asked again ten minutes after its last try, and is no longer here once it has built the version; the other nodes serve the version meanwhile. Each failure is also an event, `app.build_failed`, once. - `node_id` (`rollbackApp.response.200.build_failures.node_id`; string, required) — The node that could not build it. - `version_id` (`rollbackApp.response.200.build_failures.version_id`; string, required) - pattern `^ver-[0-9a-hjkmnp-tv-z]{16}$` - `error` (`rollbackApp.response.200.build_failures.error`; object, required) - `code` (`rollbackApp.response.200.build_failures.error.code`; string, required) — The node's code, or this control plane's (`secret_not_found`, `secret_unreadable`, `invalid_field`, `secret_host_not_allowed`) where the version's secrets could not be read, or may not go to its image's registry. - `message` (`rollbackApp.response.200.build_failures.error.message`; string, required) — The words of the node, or of the registry, which it passes on without the credentials; or this control plane's, which name the secret. - `failed_at` (`rollbackApp.response.200.build_failures.failed_at`; string, required) — When its last try failed. - format `date-time` - `logs_state` (`rollbackApp.response.200.logs_state`; object, required) — How the app's log is kept on each node that keeps one of it, as the node said in its last inventory (every few seconds). - `nodes` (`rollbackApp.response.200.logs_state.nodes`; array, required) — One item a node, by the node's id; empty where no node keeps a log of the app, or none says (a node of before 2026-10-24). - `node_id` (`rollbackApp.response.200.logs_state.nodes.node_id`; string, required) - `for_good` (`rollbackApp.response.200.logs_state.nodes.for_good`; boolean, required) — Whether what the app's instances print there now is kept for good: shipped to the object store, kept for the days the plan keeps, and metered. `false`: it is kept on that node alone, read as ever, not metered, and gone with the node (`logs.keep_off` in the log). Between the look of the control plane's that stops the account's logs (its plan's are used up and it holds nothing to pay for more) and a node's hearing of it, that node's is still `true`: what is printed there then is kept for good and metered, and with nothing to pay with it is written off (the statement's `written_off_usd`). - `reason` (`rollbackApp.response.200.logs_state.nodes.reason`; string | null, required) — Why it is not kept for good: `setting`, the app's `logs.keep`; `over_plan`, its account has used up the logs its plan includes and holds nothing to pay for more. null where it is. - one of `"setting"`, `"over_plan"`, `null` - `since` (`rollbackApp.response.200.logs_state.nodes.since`; string | null, required) — Since when it is so, by the node's clock. null: the node noted no time. - format `date-time` - `created_at` (`rollbackApp.response.200.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.200.updated_at`; string, required) - format `date-time` ### 202 The version is being built again first, no node having its template: the app, with `deploying` the version named and `current_version` what it was. #### Example ```json { "managed_by": { "object": "database", "id": "string" }, "public": true, "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 } ], "depends_on": [ { "service": "string", "condition": "string" } ], "network": { "aliases": [ "string" ], "endpoint_mode": "string" }, "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": { "soft": -1, "hard": -1 }, "property2": { "soft": -1, "hard": -1 } }, "sysctls": { "property1": "string", "property2": "string" }, "tmpfs": [ { "path": "string", "size_bytes": 0, "mode": 0 } ], "dns": { "servers": [ "string" ], "search": [ "string" ], "options": [ "string" ] }, "shm_size_bytes": 0 }, "private": { "address": "string", "domain": "string" }, "id": "string", "object": "app", "name": "string", "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 }, "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": [ { "host": "string", "allow": [ { "methods": [ "string" ], "paths": [ "string" ] } ] } ], "inject": [ { "host": "string", "headers": { "property1": "string", "property2": "string" } } ], "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 }, "url": "string", "direct": true, "checkpoint": { "every_seconds": 1 }, "direct_url": "string", "current_version": "string", "deploying": "string", "build_failures": [ { "node_id": "string", "version_id": "string", "error": { "code": "string", "message": "string" }, "failed_at": "2019-08-24T14:15:22Z" } ], "logs_state": { "nodes": [ { "node_id": "string", "for_good": true, "reason": "setting", "since": "2019-08-24T14:15:22Z" } ] }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ``` - `managed_by` (`rollbackApp.response.202.managed_by`; object | null, required) — What changes it alone, where something does. `object` `database`: the database it is under (`id`, `/v1/databases`); every other call that would change it is refused, 409 `managed_by_database`. `object` `sandboxes` (`id` null): the Sandboxes product's, made by the creates of the project's sandboxes (`POST /v1/sandboxes`): the project's default sandbox app, `sbx-sandbox` (its `image` null: each sandbox is made from the base template of the node it goes to, until the project names an image for it, `PATCH` with `image` alone, a new version made of that image, of which the creates that name no image are made from then on), or the app of an image a create named (`image`, as the create named it; `sbx--<12 hex digits>`, one version). A version is ready from when it is made, and the app's instances are the project's sandboxes; every call of it but reading it and its versions, naming the default sandbox app's image and deleting it (its versions' templates go with it; the next create of its image, or of none, makes it again) is refused, 409 `managed_by_sandboxes`. Null: none's. `object` `installation`: the installation of a Managed Application it is part of (`id`, `/v1/installations`), which changes it alone: every other call that would change it is refused, 409 `managed_by_installation`. - `object` (`rollbackApp.response.202.managed_by.object`; string, required) - one of `"database"`, `"sandboxes"`, `"installation"` - `id` (`rollbackApp.response.202.managed_by.id`; string | null, required) - `public` (`rollbackApp.response.202.public`; boolean, required) — Whether it answers at its default domain (`url`). - `volumes` (`rollbackApp.response.202.volumes`; array, required) - `volume` (`rollbackApp.response.202.volumes.volume`; string, required) - `path` (`rollbackApp.response.202.volumes.path`; string, required) - `read_only` (`rollbackApp.response.202.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.202.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `drives` (`rollbackApp.response.202.drives`; array, required) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.202.drives.drive`; string, required) - `path` (`rollbackApp.response.202.drives.path`; string, required) - `mode` (`rollbackApp.response.202.drives.mode`; string, required) - `key_drives` (`rollbackApp.response.202.key_drives`; array, required) — The Drives each key's instance has of its own (`AppCreate.key_drives`): none, `[]`, where it gives none. - `name` (`rollbackApp.response.202.key_drives.name`; string, required) - `path` (`rollbackApp.response.202.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.202.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.202.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `depends_on` (`rollbackApp.response.202.depends_on`; array, required) - `service` (`rollbackApp.response.202.depends_on.service`; string, required) - `condition` (`rollbackApp.response.202.depends_on.condition`; string, required) - `network` (`rollbackApp.response.202.network`; object, required) - `aliases` (`rollbackApp.response.202.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.202.network.endpoint_mode`; string, required) - `kind` (`rollbackApp.response.202.kind`; string, required) - `files` (`rollbackApp.response.202.files`; array, required) - `path` (`rollbackApp.response.202.files.path`; string, required) - `mode` (`rollbackApp.response.202.files.mode`; integer, required) - `uid` (`rollbackApp.response.202.files.uid`; integer, required) - `gid` (`rollbackApp.response.202.files.gid`; integer, required) - `content` (`rollbackApp.response.202.files.content`; string, optional) - `secret` (`rollbackApp.response.202.files.secret`; string, optional) - `user` (`rollbackApp.response.202.user`; string | null, required) - `working_dir` (`rollbackApp.response.202.working_dir`; string | null, required) - `stop` (`rollbackApp.response.202.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.202.hostname`; string | null, required) - `runtime` (`rollbackApp.response.202.runtime`; any of, required) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `private` (`rollbackApp.response.202.private`; object, required) — Where the project's sandboxes on its network find the app: its address there, which it keeps for as long as it is there, renamed or not; and its name under `internal`. A sandbox of the project on the network finds it by its name, by `domain`, and by each of its `network.aliases` with and without `.internal`. - `address` (`rollbackApp.response.202.private.address`; string | null, required) — An address of the project's ranges (`GET /v1/project`). `null` only where every range of the site is cut. - pattern `^10\.(6[4-9]|[7-9][0-9]|1[01][0-9]|12[0-7])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){2}$` - `domain` (`rollbackApp.response.202.private.domain`; string, required) — `.internal`. - `id` (`rollbackApp.response.202.id`; string, required) - pattern `^app-[0-9a-hjkmnp-tv-z]{16}$` - `object` (`rollbackApp.response.202.object`; string, required) - one of `"app"` - `name` (`rollbackApp.response.202.name`; string, required) - `image` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.response.202.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` (`rollbackApp.response.202.port`; integer | null, required) - `ready` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.response.202.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` (`rollbackApp.response.202.env`; map, required) - `secrets` (`rollbackApp.response.202.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.202.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.202.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.response.202.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 - `regions` (`rollbackApp.response.202.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.202.scale`; object, required) - `min_instances` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.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` (`rollbackApp.response.202.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.response.202.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` (`rollbackApp.response.202.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.202.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.202.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.202.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.202.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.response.202.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` (`rollbackApp.response.202.metadata`; map, required) - `logs` (`rollbackApp.response.202.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`rollbackApp.response.202.logs.output`; boolean, required) - `keep` (`rollbackApp.response.202.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.202.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.202.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.202.logs.requests.keep_errors`; boolean, required) - `traces` (`rollbackApp.response.202.traces`; object, required) — 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` (`rollbackApp.response.202.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.202.traces.trust_incoming`; boolean, required) - `url` (`rollbackApp.response.202.url`; string | null, required) — Where the app answers: `https://` and its default domain, `-.`. It is the app's from the moment it is made (503 `app_not_deployed` until its first version is ready) and for as long as the app has its name. `null` on a control plane that is told no zone for apps (`--app-zone`). - `direct` (`rollbackApp.response.202.direct`; boolean, required) — Whether the app answers at a name that reaches the edges without the platform's proxy as well (`direct_url`): there a request has no limit of the proxy's on its body or on how long its answer may pause, and nothing but the edge's own limits protects the app. - `checkpoint` (`rollbackApp.response.202.checkpoint`; one of, required) — Checkpoints of its keyed instances while they run: every `every_seconds` (10 unless said, 1 to 600) an instance's memory and disk as they are at one instant go to its node's object store, and when its node's host is lost the instance is taken over on another node from its newest checkpoint with its processes, losing at most what it did since (an instance that sleeps is taken over from its sleep, which loses nothing). Its node pauses it for a few milliseconds for each; what it wrote since the last one is what is sent, compressed, and one that writes more than its node's link for checkpoints takes falls behind instead of filling it (the instance's `checkpoint`: `last_at`, `behind_seconds`, `bytes_per_second`, `stored_bytes`). What the store keeps of an instance's newest checkpoint is billed as sleeping state (`state`) while it runs; nothing for what is sent. Holds at once and makes no version: the instances that are there are given it, those made later are made with it. Not a stateful service's instance: its volume has no copy in the store. An instance's Drives (its own `key_drives` too) are pinned with its disk at the same instant, and a takeover brings them back as they were then; an instance with a volume that is not a Drive takes none, and its `checkpoint.error` says so. Null: none (the default). - one of: `object`, `null` - `direct_url` (`rollbackApp.response.202.direct_url`; string | null, required) — Where the app answers without the proxy: its default domain's label under the platform's direct zone (`https://-.direct.glac.run`). Null unless it says `direct`, and where the platform has no proxy. - `current_version` (`rollbackApp.response.202.current_version`; string | null, required) — The id of the version the app's traffic goes to: the newest deploy that came up, or what a rollback named. `null` until a version is ready. - `deploying` (`rollbackApp.response.202.deploying`; string | null, required) — The id of the version that is being deployed and takes the traffic when it is ready. - `build_failures` (`rollbackApp.response.202.build_failures`; array, required) — The nodes that are to serve the version the app's traffic goes to and could not build it when they were asked to after its deploy (a node that joined, one whose template of it is of no use any more, one that came back), one an item, by the node's id; empty where there are none. A node whose build failed is asked again ten minutes after its last try, and is no longer here once it has built the version; the other nodes serve the version meanwhile. Each failure is also an event, `app.build_failed`, once. - `node_id` (`rollbackApp.response.202.build_failures.node_id`; string, required) — The node that could not build it. - `version_id` (`rollbackApp.response.202.build_failures.version_id`; string, required) - pattern `^ver-[0-9a-hjkmnp-tv-z]{16}$` - `error` (`rollbackApp.response.202.build_failures.error`; object, required) - `code` (`rollbackApp.response.202.build_failures.error.code`; string, required) — The node's code, or this control plane's (`secret_not_found`, `secret_unreadable`, `invalid_field`, `secret_host_not_allowed`) where the version's secrets could not be read, or may not go to its image's registry. - `message` (`rollbackApp.response.202.build_failures.error.message`; string, required) — The words of the node, or of the registry, which it passes on without the credentials; or this control plane's, which name the secret. - `failed_at` (`rollbackApp.response.202.build_failures.failed_at`; string, required) — When its last try failed. - format `date-time` - `logs_state` (`rollbackApp.response.202.logs_state`; object, required) — How the app's log is kept on each node that keeps one of it, as the node said in its last inventory (every few seconds). - `nodes` (`rollbackApp.response.202.logs_state.nodes`; array, required) — One item a node, by the node's id; empty where no node keeps a log of the app, or none says (a node of before 2026-10-24). - `node_id` (`rollbackApp.response.202.logs_state.nodes.node_id`; string, required) - `for_good` (`rollbackApp.response.202.logs_state.nodes.for_good`; boolean, required) — Whether what the app's instances print there now is kept for good: shipped to the object store, kept for the days the plan keeps, and metered. `false`: it is kept on that node alone, read as ever, not metered, and gone with the node (`logs.keep_off` in the log). Between the look of the control plane's that stops the account's logs (its plan's are used up and it holds nothing to pay for more) and a node's hearing of it, that node's is still `true`: what is printed there then is kept for good and metered, and with nothing to pay with it is written off (the statement's `written_off_usd`). - `reason` (`rollbackApp.response.202.logs_state.nodes.reason`; string | null, required) — Why it is not kept for good: `setting`, the app's `logs.keep`; `over_plan`, its account has used up the logs its plan includes and holds nothing to pay for more. null where it is. - one of `"setting"`, `"over_plan"`, `null` - `since` (`rollbackApp.response.202.logs_state.nodes.since`; string | null, required) — Since when it is so, by the node's clock. null: the node noted no time. - format `date-time` - `created_at` (`rollbackApp.response.202.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.202.updated_at`; string, required) - format `date-time` ### 400 `invalid_json`, `unknown_field`, `unknown_parameter`, `invalid_field`; `missing_field`: no `version`. #### 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` (`rollbackApp.response.400.error`; object, required) - `type` (`rollbackApp.response.400.error.type`; string, required) - `code` (`rollbackApp.response.400.error.code`; string, required) - `message` (`rollbackApp.response.400.error.message`; string, required) - `param` (`rollbackApp.response.400.error.param`; string | null, required) - `retryable` (`rollbackApp.response.400.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.400.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.400.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.400.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.move.object`; string, required) - `id` (`rollbackApp.response.400.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.400.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.400.move.project_id`; string, required) - `from` (`rollbackApp.response.400.move.from`; object, required) - `id` (`rollbackApp.response.400.move.from.id`; string, required) - `name` (`rollbackApp.response.400.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.400.move.to`; object, required) - `id` (`rollbackApp.response.400.move.to.id`; string, required) - `name` (`rollbackApp.response.400.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.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` (`rollbackApp.response.400.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.400.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.400.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.400.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.active.name`; string, required) - `url` (`rollbackApp.response.400.active.url`; string, required) - `term` (`rollbackApp.response.400.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.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` (`rollbackApp.response.400.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.400.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.400.problems.message`; string, required) - `report` (`rollbackApp.response.400.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.400.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.400.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.400.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.400.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.400.report.profiles`; array, required) - `treatments` (`rollbackApp.response.400.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.400.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.400.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.400.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.400.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.400.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.items.why`; string, required) - `change` (`rollbackApp.response.400.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.400.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.400.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.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` (`rollbackApp.response.400.report.services.items`; array, required) - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.services.items.why`; string, required) - `change` (`rollbackApp.response.400.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.400.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.400.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.400.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.400.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.400.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.400.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.400.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.400.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.400.report.services.app.files`; array, required) - `path` (`rollbackApp.response.400.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.400.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.400.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.400.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.400.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.400.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.400.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.400.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.400.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.400.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.400.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.400.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.400.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.400.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.400.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.400.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.400.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.400.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.400.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.400.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.400.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.400.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.400.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.400.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.400.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.400.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.400.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.400.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.400.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.400.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.400.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.400.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.400.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.400.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.400.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.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` (`rollbackApp.response.400.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.400.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.400.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.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` (`rollbackApp.response.400.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.400.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.400.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.400.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.400.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.400.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.400.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.400.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.400.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.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` (`rollbackApp.response.400.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.400.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.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` (`rollbackApp.response.401.error`; object, required) - `type` (`rollbackApp.response.401.error.type`; string, required) - `code` (`rollbackApp.response.401.error.code`; string, required) - `message` (`rollbackApp.response.401.error.message`; string, required) - `param` (`rollbackApp.response.401.error.param`; string | null, required) - `retryable` (`rollbackApp.response.401.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.401.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.401.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.401.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.move.object`; string, required) - `id` (`rollbackApp.response.401.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.401.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.401.move.project_id`; string, required) - `from` (`rollbackApp.response.401.move.from`; object, required) - `id` (`rollbackApp.response.401.move.from.id`; string, required) - `name` (`rollbackApp.response.401.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.401.move.to`; object, required) - `id` (`rollbackApp.response.401.move.to.id`; string, required) - `name` (`rollbackApp.response.401.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.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` (`rollbackApp.response.401.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.401.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.401.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.401.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.active.name`; string, required) - `url` (`rollbackApp.response.401.active.url`; string, required) - `term` (`rollbackApp.response.401.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.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` (`rollbackApp.response.401.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.401.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.401.problems.message`; string, required) - `report` (`rollbackApp.response.401.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.401.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.401.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.401.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.401.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.401.report.profiles`; array, required) - `treatments` (`rollbackApp.response.401.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.401.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.401.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.401.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.401.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.401.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.items.why`; string, required) - `change` (`rollbackApp.response.401.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.401.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.401.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.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` (`rollbackApp.response.401.report.services.items`; array, required) - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.services.items.why`; string, required) - `change` (`rollbackApp.response.401.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.401.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.401.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.401.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.401.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.401.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.401.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.401.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.401.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.401.report.services.app.files`; array, required) - `path` (`rollbackApp.response.401.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.401.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.401.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.401.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.401.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.401.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.401.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.401.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.401.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.401.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.401.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.401.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.401.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.401.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.401.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.401.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.401.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.401.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.401.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.401.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.401.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.401.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.401.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.401.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.401.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.401.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.401.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.401.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.401.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.401.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.401.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.401.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.401.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.401.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.401.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.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` (`rollbackApp.response.401.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.401.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.401.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.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` (`rollbackApp.response.401.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.401.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.401.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.401.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.401.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.401.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.401.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.401.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.401.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.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` (`rollbackApp.response.401.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.401.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.response.401.accounts.name`; string, required) ### 402 `account_in_debt`: the account owes (its balance is below zero), and until it has paid nothing of it can be used: every call of its keys, and of the tokens of its sandboxes, is refused so, but those that read what it owes and pay it; those that list and read the backups of its volumes and make a volume from one (`POST /v1/volumes` with `from_backup`, but while what it stores is being deleted), what one that stopped paying wants most; and, unless the control plane is started with `--debt-allows-delete false`, those that list, read and delete the volumes, snapshots and sandboxes it stores, and delete its backups. Never a new backup. Before the key's scopes are looked at, and whatever the path. The message says how much is owed, since when, when what the account stores is deleted, how to pay, that it can delete what it stores to stop the amount from growing, and that a volume is still made from a backup (`GET /v1/billing`, `debt`). #### 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` (`rollbackApp.response.402.error`; object, required) - `type` (`rollbackApp.response.402.error.type`; string, required) - `code` (`rollbackApp.response.402.error.code`; string, required) - `message` (`rollbackApp.response.402.error.message`; string, required) - `param` (`rollbackApp.response.402.error.param`; string | null, required) - `retryable` (`rollbackApp.response.402.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.402.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.402.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.402.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.response.402.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` (`rollbackApp.response.402.move`; object, optional) — With `move_over`, `move_going_back` and `move_taken_over` (`POST /internal/moves/{id}/cancel`): the move, as it stands. - `object` (`rollbackApp.response.402.move.object`; string, required) - `id` (`rollbackApp.response.402.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.402.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.402.move.project_id`; string, required) - `from` (`rollbackApp.response.402.move.from`; object, required) - `id` (`rollbackApp.response.402.move.from.id`; string, required) - `name` (`rollbackApp.response.402.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.402.move.to`; object, required) - `id` (`rollbackApp.response.402.move.to.id`; string, required) - `name` (`rollbackApp.response.402.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.response.402.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` (`rollbackApp.response.402.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.move.next_attempt_at`; string | null, required) — When that step is asked again; null where it is not waiting. - format `date-time` - `batch` (`rollbackApp.response.402.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.402.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.402.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.402.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.response.402.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` (`rollbackApp.response.402.active`; object | null, optional) — With `standby`: the active copy, as the standby last read the lease; null while no copy holds it. - `name` (`rollbackApp.response.402.active.name`; string, required) - `url` (`rollbackApp.response.402.active.url`; string, required) - `term` (`rollbackApp.response.402.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.response.402.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` (`rollbackApp.response.402.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.402.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.402.problems.message`; string, required) - `report` (`rollbackApp.response.402.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.402.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.402.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.402.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.402.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.402.report.profiles`; array, required) - `treatments` (`rollbackApp.response.402.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.402.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.402.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.402.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.402.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.402.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.items.why`; string, required) - `change` (`rollbackApp.response.402.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.402.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.402.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.response.402.report.services.app_id`; string | null, required) — Its app. Null: a dry run of a service the project does not have. - pattern `^app-` - `status` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.items`; array, required) - `at` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.items.why`; string, required) - `change` (`rollbackApp.response.402.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.402.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.402.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.402.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.402.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.402.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.402.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.402.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.402.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.402.report.services.app.files`; array, required) - `path` (`rollbackApp.response.402.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.402.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.402.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.402.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.402.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.402.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.402.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.402.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.402.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.402.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.402.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.402.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.402.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.402.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.402.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.402.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.response.402.report.services.app.logs`; object, required) — What the app's log has, each part as it was given or at its default (`AppLogSettings`). - `output` (`rollbackApp.response.402.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.402.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.402.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.402.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.402.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.402.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.402.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.402.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.402.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.402.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.402.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.402.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.402.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.402.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.402.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.402.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.402.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.402.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.402.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.402.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.402.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.402.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.402.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.response.402.report.volumes.shared`; boolean, required) — Several services mount it, or one with several instances: every instance of each mounts it at once. - `status` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.402.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.402.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.response.402.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` (`rollbackApp.response.402.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` (`rollbackApp.response.402.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.402.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.402.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.402.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.402.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.response.402.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` (`rollbackApp.response.402.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.402.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.response.402.accounts.name`; string, required) ### 403 `key_scope`: the key does not allow the scope the call takes (the message names it); `needs_api_key`: the operator's key, or the SSH gateway's; `account_held`: the account is held for its payments, and every call of its keys but `GET /v1/account` is refused so, before the scopes are looked at (`x-error-codes`); `installation_key_scope`: a key held to an installation of a Managed Application, on a call that is not about that installation's own things. (A sandbox token is passed to its node, which answers what it has no call for with 404 `no_such_route`.) #### 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` (`rollbackApp.response.403.error`; object, required) - `type` (`rollbackApp.response.403.error.type`; string, required) - `code` (`rollbackApp.response.403.error.code`; string, required) - `message` (`rollbackApp.response.403.error.message`; string, required) - `param` (`rollbackApp.response.403.error.param`; string | null, required) - `retryable` (`rollbackApp.response.403.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.403.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.403.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.403.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.move.object`; string, required) - `id` (`rollbackApp.response.403.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.403.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.403.move.project_id`; string, required) - `from` (`rollbackApp.response.403.move.from`; object, required) - `id` (`rollbackApp.response.403.move.from.id`; string, required) - `name` (`rollbackApp.response.403.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.403.move.to`; object, required) - `id` (`rollbackApp.response.403.move.to.id`; string, required) - `name` (`rollbackApp.response.403.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.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` (`rollbackApp.response.403.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.403.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.403.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.403.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.active.name`; string, required) - `url` (`rollbackApp.response.403.active.url`; string, required) - `term` (`rollbackApp.response.403.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.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` (`rollbackApp.response.403.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.403.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.403.problems.message`; string, required) - `report` (`rollbackApp.response.403.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.403.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.403.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.403.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.403.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.403.report.profiles`; array, required) - `treatments` (`rollbackApp.response.403.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.403.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.403.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.403.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.403.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.403.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.items.why`; string, required) - `change` (`rollbackApp.response.403.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.403.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.403.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.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` (`rollbackApp.response.403.report.services.items`; array, required) - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.services.items.why`; string, required) - `change` (`rollbackApp.response.403.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.403.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.403.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.403.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.403.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.403.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.403.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.403.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.403.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.403.report.services.app.files`; array, required) - `path` (`rollbackApp.response.403.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.403.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.403.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.403.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.403.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.403.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.403.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.403.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.403.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.403.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.403.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.403.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.403.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.403.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.403.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.403.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.403.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.403.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.403.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.403.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.403.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.403.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.403.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.403.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.403.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.403.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.403.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.403.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.403.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.403.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.403.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.403.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.403.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.403.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.403.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.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` (`rollbackApp.response.403.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.403.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.403.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.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` (`rollbackApp.response.403.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.403.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.403.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.403.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.403.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.403.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.403.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.403.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.403.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.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` (`rollbackApp.response.403.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.403.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.response.403.accounts.name`; string, required) ### 404 `app_not_found`; `version_not_found` (`param` is `version`). #### 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` (`rollbackApp.response.404.error`; object, required) - `type` (`rollbackApp.response.404.error.type`; string, required) - `code` (`rollbackApp.response.404.error.code`; string, required) - `message` (`rollbackApp.response.404.error.message`; string, required) - `param` (`rollbackApp.response.404.error.param`; string | null, required) - `retryable` (`rollbackApp.response.404.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.404.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.404.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.404.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.move.object`; string, required) - `id` (`rollbackApp.response.404.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.404.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.404.move.project_id`; string, required) - `from` (`rollbackApp.response.404.move.from`; object, required) - `id` (`rollbackApp.response.404.move.from.id`; string, required) - `name` (`rollbackApp.response.404.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.404.move.to`; object, required) - `id` (`rollbackApp.response.404.move.to.id`; string, required) - `name` (`rollbackApp.response.404.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.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` (`rollbackApp.response.404.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.404.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.404.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.404.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.active.name`; string, required) - `url` (`rollbackApp.response.404.active.url`; string, required) - `term` (`rollbackApp.response.404.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.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` (`rollbackApp.response.404.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.404.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.404.problems.message`; string, required) - `report` (`rollbackApp.response.404.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.404.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.404.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.404.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.404.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.404.report.profiles`; array, required) - `treatments` (`rollbackApp.response.404.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.404.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.404.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.404.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.404.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.404.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.items.why`; string, required) - `change` (`rollbackApp.response.404.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.404.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.404.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.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` (`rollbackApp.response.404.report.services.items`; array, required) - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.services.items.why`; string, required) - `change` (`rollbackApp.response.404.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.404.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.404.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.404.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.404.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.404.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.404.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.404.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.404.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.404.report.services.app.files`; array, required) - `path` (`rollbackApp.response.404.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.404.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.404.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.404.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.404.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.404.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.404.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.404.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.404.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.404.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.404.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.404.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.404.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.404.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.404.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.404.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.404.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.404.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.404.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.404.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.404.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.404.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.404.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.404.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.404.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.404.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.404.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.404.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.404.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.404.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.404.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.404.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.404.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.404.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.404.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.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` (`rollbackApp.response.404.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.404.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.404.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.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` (`rollbackApp.response.404.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.404.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.404.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.404.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.404.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.404.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.404.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.404.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.404.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.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` (`rollbackApp.response.404.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.404.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.response.404.accounts.name`; string, required) ### 409 `version_not_ready`: the version is being built, or failed and never was ready; `rollback_failed`: the version is of a service with a volume of its own, whose instance of it did not come up (the message says what it said): the service has its instance of the version the traffic was with again, with the volume, and the traffic stays there (`param` is `version`); `idempotency_key_reused`. `managed_by_database`: the app is a database's (`managed_by`), changed through `/v1/databases` alone. `managed_by_sandboxes`: the app is the Sandboxes product's (`managed_by`), whose instances are the project's sandboxes, made, changed and deleted through `/v1/sandboxes`. #### 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` (`rollbackApp.response.409.error`; object, required) - `type` (`rollbackApp.response.409.error.type`; string, required) - `code` (`rollbackApp.response.409.error.code`; string, required) - `message` (`rollbackApp.response.409.error.message`; string, required) - `param` (`rollbackApp.response.409.error.param`; string | null, required) - `retryable` (`rollbackApp.response.409.error.retryable`; boolean, required) - `request_id` (`rollbackApp.response.409.error.request_id`; string, required) - `docs_url` (`rollbackApp.response.409.error.docs_url`; string | null, required) - `move_id` (`rollbackApp.response.409.move_id`; string, optional) — With `already_moving`: the move of the sandbox that is under way. - `upgrade_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.move.object`; string, required) - `id` (`rollbackApp.response.409.move.id`; string, required) - pattern `^mov-[0-9a-hjkmnp-tv-z]{16}$` - `sandbox_id` (`rollbackApp.response.409.move.sandbox_id`; string, required) - `project_id` (`rollbackApp.response.409.move.project_id`; string, required) - `from` (`rollbackApp.response.409.move.from`; object, required) - `id` (`rollbackApp.response.409.move.from.id`; string, required) - `name` (`rollbackApp.response.409.move.from.name`; string | null, required) — Its name; null for a node that is off the books since. - `to` (`rollbackApp.response.409.move.to`; object, required) - `id` (`rollbackApp.response.409.move.to.id`; string, required) - `name` (`rollbackApp.response.409.move.to.name`; string | null, required) — Its name; null for a node that is off the books since. - `epoch` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.move.why`; string, required) — What made it: the operator's move, an evacuation, a recovery. - `wake` (`rollbackApp.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` (`rollbackApp.response.409.move.from_store`; boolean, required) — The new node takes it from the object store alone. - `release` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.move.batch`; string | null, required) — The evacuation (`evc-…`) or recovery (`rcv-…`) it is of. - `created_at` (`rollbackApp.response.409.move.created_at`; string, required) - format `date-time` - `updated_at` (`rollbackApp.response.409.move.updated_at`; string, required) - format `date-time` - `ended_at` (`rollbackApp.response.409.move.ended_at`; string | null, required) - format `date-time` - `lease_until` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.active.name`; string, required) - `url` (`rollbackApp.response.409.active.url`; string, required) - `term` (`rollbackApp.response.409.active.term`; integer, required) - min 1 - `allowed_hosts` (`rollbackApp.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` (`rollbackApp.response.409.problems`; array, optional) — With `invalid_definition`: every problem of the definition, each where it is and what it is. - `at` (`rollbackApp.response.409.problems.at`; string, required) — Where in the definition, a dotted path (`services.web.port`); empty for the whole of it. - `message` (`rollbackApp.response.409.problems.message`; string, required) - `report` (`rollbackApp.response.409.report`; object, optional) — With `compose_refused`: the import's report, which says what is refused, why, and what to change. - `object` (`rollbackApp.response.409.report.object`; string, required) - one of `"compose_import"` - `name` (`rollbackApp.response.409.report.name`; string | null, required) — The model's `name`: each service's label `compose.project`. Null: it has none. - `dry_run` (`rollbackApp.response.409.report.dry_run`; boolean, required) - `strict` (`rollbackApp.response.409.report.strict`; boolean, required) - `profiles` (`rollbackApp.response.409.report.profiles`; array, required) - `treatments` (`rollbackApp.response.409.report.treatments`; object, required) — How many items of the report have each treatment. - `done` (`rollbackApp.response.409.report.treatments.done`; integer, required) - min 0 - `adapted` (`rollbackApp.response.409.report.treatments.adapted`; integer, required) - min 0 - `ignored` (`rollbackApp.response.409.report.treatments.ignored`; integer, required) - min 0 - `refused` (`rollbackApp.response.409.report.treatments.refused`; integer, required) - min 0 - `items` (`rollbackApp.response.409.report.items`; array, required) — The model's top-level elements: `name`, each volume, network, config and secret, extensions. - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.items.why`; string, required) - `change` (`rollbackApp.response.409.report.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `services` (`rollbackApp.response.409.report.services`; array, required) — The services the import takes, in the model's order. - `name` (`rollbackApp.response.409.report.services.name`; string, required) — The service's name, which is its app's. - `app_id` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.services.stateful`; boolean, required) — It mounts a volume of its own: one instance, which has the volume. - `version` (`rollbackApp.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` (`rollbackApp.response.409.report.services.items`; array, required) - `at` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.services.items.why`; string, required) - `change` (`rollbackApp.response.409.report.services.items.change`; string | null, required) — Of one that is refused: what to change. Null otherwise. - `app` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.start_command`; any of, required) - any of: `StartCommand`, `null` - `start_args` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.port`; integer | null, required) - `ready` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.ready.tcp`; boolean, optional) — The app's port takes a connection. - one of `true` - `command` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.env`; map, required) - `secrets` (`rollbackApp.response.409.report.services.app.secrets`; map, required) — Names of secrets. No answer has a value. - `size` (`rollbackApp.response.409.report.services.app.size`; object, required) — What one instance may use at most. It is billed by what it uses. - `vcpus` (`rollbackApp.response.409.report.services.app.size.vcpus`; integer, required) - min 1 - `memory_bytes` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.volumes`; array, required) - `volume` (`rollbackApp.response.409.report.services.app.volumes.volume`; string, required) - `path` (`rollbackApp.response.409.report.services.app.volumes.path`; string, required) - `read_only` (`rollbackApp.response.409.report.services.app.volumes.read_only`; boolean, required) - `nocopy` (`rollbackApp.response.409.report.services.app.volumes.nocopy`; unknown, optional) — There only where it was given as `true`. - `kind` (`rollbackApp.response.409.report.services.app.kind`; string, required) - `files` (`rollbackApp.response.409.report.services.app.files`; array, required) - `path` (`rollbackApp.response.409.report.services.app.files.path`; string, required) - `mode` (`rollbackApp.response.409.report.services.app.files.mode`; integer, required) - `uid` (`rollbackApp.response.409.report.services.app.files.uid`; integer, required) - `gid` (`rollbackApp.response.409.report.services.app.files.gid`; integer, required) - `content` (`rollbackApp.response.409.report.services.app.files.content`; string, optional) - `secret` (`rollbackApp.response.409.report.services.app.files.secret`; string, optional) - `user` (`rollbackApp.response.409.report.services.app.user`; string | null, required) - `working_dir` (`rollbackApp.response.409.report.services.app.working_dir`; string | null, required) - `stop` (`rollbackApp.response.409.report.services.app.stop`; any of, required) - any of: `ServiceStop`, `null` - `hostname` (`rollbackApp.response.409.report.services.app.hostname`; string | null, required) - `regions` (`rollbackApp.response.409.report.services.app.regions`; array, required) — In the order na, eu, ap. - `scale` (`rollbackApp.response.409.report.services.app.scale`; object, required) - `min_instances` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.keys`; any of, required) - any of: `object`, `null` - `egress` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.egress.default`; string | null, optional) - one of `"allow"`, `"deny"`, `null` - `allow` (`rollbackApp.response.409.report.services.app.egress.allow`; array | null, optional) - `deny` (`rollbackApp.response.409.report.services.app.egress.deny`; array | null, optional) - `http` (`rollbackApp.response.409.report.services.app.egress.http`; array | null, optional) - `inject` (`rollbackApp.response.409.report.services.app.egress.inject`; array | null, optional) - `deny_ports` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.metadata`; map, required) - `logs` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.logs.output`; boolean, required) - `keep` (`rollbackApp.response.409.report.services.app.logs.keep`; boolean, required) - `requests` (`rollbackApp.response.409.report.services.app.logs.requests`; object, required) - `sample_rate` (`rollbackApp.response.409.report.services.app.logs.requests.sample_rate`; number, required) - min 0; max 1 - `keep_errors` (`rollbackApp.response.409.report.services.app.logs.requests.keep_errors`; boolean, required) - `public` (`rollbackApp.response.409.report.services.app.public`; boolean, required) — Whether it answers at its default domain (`url`). - `depends_on` (`rollbackApp.response.409.report.services.app.depends_on`; array, required) - `service` (`rollbackApp.response.409.report.services.app.depends_on.service`; string, required) - `condition` (`rollbackApp.response.409.report.services.app.depends_on.condition`; string, required) - `network` (`rollbackApp.response.409.report.services.app.network`; object, required) - `aliases` (`rollbackApp.response.409.report.services.app.network.aliases`; array, required) - `endpoint_mode` (`rollbackApp.response.409.report.services.app.network.endpoint_mode`; string, required) - `drives` (`rollbackApp.response.409.report.services.app.drives`; array, optional) — The Drives its instance mounts (`AppCreate.drives`): none, `[]`, where it names none. - `drive` (`rollbackApp.response.409.report.services.app.drives.drive`; string, required) - `path` (`rollbackApp.response.409.report.services.app.drives.path`; string, required) - `mode` (`rollbackApp.response.409.report.services.app.drives.mode`; string, required) - `key_drives` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.key_drives.name`; string, required) - `path` (`rollbackApp.response.409.report.services.app.key_drives.path`; string, required) - `size_bytes` (`rollbackApp.response.409.report.services.app.key_drives.size_bytes`; integer | null, required) - format `int64` - `nocopy` (`rollbackApp.response.409.report.services.app.key_drives.nocopy`; unknown, optional) — There only where it was given as `true`. - `runtime` (`rollbackApp.response.409.report.services.app.runtime`; any of, optional) — Its runtime settings (`AppCreate.runtime`). `null`: none. - any of: `Runtime`, `null` - `traces` (`rollbackApp.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` (`rollbackApp.response.409.report.services.app.traces.sample_rate`; number, required) - min 0; max 1 - `trust_incoming` (`rollbackApp.response.409.report.services.app.traces.trust_incoming`; boolean, required) - `volumes` (`rollbackApp.response.409.report.volumes`; array, required) — The volumes of the project the services mount. - `model` (`rollbackApp.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` (`rollbackApp.response.409.report.volumes.name`; string, required) — Its name in the project. - `id` (`rollbackApp.response.409.report.volumes.id`; string | null, required) — Null: not made yet (`to_make`). - pattern `^vol-` - `shared` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.volumes.used_by`; array, required) - `secrets` (`rollbackApp.response.409.report.secrets`; array, required) — The secrets of the model that services are granted. - `model` (`rollbackApp.response.409.report.secrets.model`; string, required) — Its name in the model. - `name` (`rollbackApp.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` (`rollbackApp.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` (`rollbackApp.response.409.report.secrets.used_by`; array, required) - `left_out` (`rollbackApp.response.409.report.left_out`; array, required) — The services of profiles that are not turned on, which the import does not touch. - `name` (`rollbackApp.response.409.report.left_out.name`; string, required) - `profiles` (`rollbackApp.response.409.report.left_out.profiles`; array, required) - `absent` (`rollbackApp.response.409.report.absent`; array, required) — The project's services that the model does not have: kept as they are. - `deploy` (`rollbackApp.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` (`rollbackApp.response.409.accounts`; array, optional) — With `sole_owner`: the accounts the user is the only owner of. - `id` (`rollbackApp.response.409.accounts.id`; string, required) - pattern `^acct-[0-9a-hjkmnp-tv-z]{16}$` - `name` (`rollbackApp.response.409.accounts.name`; string, required) Source: https://glac.ai/docs/api/apps/rollback/index.md