---
title: "Source: schemas/manifest.schema.json"
description: "Generated page for the indexed contract source schemas/manifest.schema.json: its schema fields or contract text, and its published text."
slug: /reference/sources/schemas/manifest-schema
order: 12
visibility: public
redirects_from: []
---

# Source: schemas/manifest\.schema\.json

Generated automatically from the [published contract sources](/cloud/reference/about/#contract-sources).

Source path: schemas/manifest\.schema\.json.

The file itself is served at `https://turnzero.ai/cloud/reference/sources/schemas/manifest.schema.json`, the same bytes as the source below, for a validator that loads a schema by address.

## Schema fields

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | The schema of your application's manifest, `manifest.json`, the executable form of the admission manifest contract \(MAN\)\. This schema and that contract change together, and a test in the platform's suite checks that they agree\. The required members: `manifest_version`, the contract revision; `services`, its provisioned services; `region`, its region; `egress`, the hosts it calls; `audience`, who may reach it; and `packages`, its library entries\. Optional `settings` holds stored secrets or plain process values\. A zip's own start needs `health`, its health path\. Other optional members: `upstreams` \(keyed gateway APIs\), `realm` \(end\-user sign\-in\), `websockets` \(WebSocket upgrades\), `smoke_paths` \(checks after the health gate\), and `application` \(deploy target\)\. Read one member alone with `read_context` and the id `manifest_schema:<member>`, and one service kind with `manifest_schema:services:<kind>`\. The `examples` member that follows is a complete manifest for an application that runs a server: no services, no outside hosts, a public audience, and no library entries\. For a static site, use this example without `health`; its files go under `client/` and it needs no server start script\.<br><br>$schema: <https://json-schema.org/draft/2020-12/schema><br>version: 2026\-11\-19\.2<br>title: tzCloud — application manifest, revision 1<br>Examples: \[\{"manifest\_version":1,"services":\[\],"health":"/health","region":"usa","egress":\[\],"audience":\{"kind":"public"\},"packages":\[\]\}\]<br>Type: object<br>Additional properties: false<br>Required fields: \["manifest\_version","services","region","egress","audience","packages"\] |
| /<wbr>properties/<wbr>manifest\_version | The contract revision your manifest follows: `1` for this form\.<br><br>Required value: 1 |
| /<wbr>properties/<wbr>services | The provisioned services your application uses, each by its catalog name\. An empty list states that your application uses none; it is not an omission\.<br><br>Type: array<br>uniqueItems: true |
| /<wbr>properties/<wbr>services/<wbr>items |  |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>0 | Type: object<br>Additional properties: false<br>Required fields: \["kind"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>0/<wbr>properties/<wbr>kind | `database`, `object_storage`, `accounts`, and `push` are the kinds the platform provisions or admits at submission as their services state\. An `accounts` entry contains only `kind`; use the manifest's top\-level `realm` to configure sign\-in and its top\-level `audience` to choose who may reach the application\.<br><br>The `object_storage` kind alone creates no storage area\. Each area is declared in the entry's `areas`, with the client's `mintArea` at the backend's start, or with `declare_storage_area`, before its first use\. The `push` kind admits the configuration and the routes and provisions nothing at submission\. The `email` kind provisions nothing and is admitted on a plan whose `email-send-supported` row reads 1, Pro at the beta; elsewhere submit\_manifest refuses it `email_not_on_plan`\.<br><br>Allowed values: \["database","object\_storage","email","accounts","push"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>1 | Type: object<br>Additional properties: false<br>Required fields: \["kind"\]<br>minProperties: 2 |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>kind | The `push` kind with its providers, `apns` and `fcm`, in the form `configure_push` takes them, except that `apns` has no gateway member\. Each submission records the providers on the push configuration of every environment your application has, effective at once\. `create_environment` records them on the development configuration it creates\. Where `configure_push` would refuse a value under a named rule, the submission refuses it `manifest_invalid` at the member's path, and the violation gives that rule's error\.<br><br>A credential name you have not stored yet is accepted, as for the `realm` member\. A provider this entry lists belongs to the manifest: `configure_push` refuses a change to it `manifest_owned_field`\. Apple's gateway differs by environment and stays with `configure_push`: `sandbox` in development and `production` in production, until you set another there\.<br><br>Required value: push |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>apns | $ref: \#/$defs/pushApns |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>fcm | $ref: \#/$defs/pushFcm |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2 | Type: object<br>Additional properties: false<br>Required fields: \["kind","areas"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>kind | The `object_storage` kind with the storage areas each submission declares\. Each area belongs to your application and keeps no file versions\. An existing area with the same declarations is left unchanged\. A name that already exists with other declarations, or under another application, is refused `manifest_invalid` at its path, before anything is recorded\. An area whose name you later leave out keeps existing, with its files\. To end an empty area, call `declare_storage_area` with `remove: true`\.<br><br>Required value: object\_storage |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>areas | One to fifty areas, each name listed once\. A second `object_storage` entry in `services` is refused\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 50 |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>areas/<wbr>items | Type: object<br>Additional properties: false<br>Required fields: \["name","account\_keyed"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>areas/<wbr>items/<wbr>properties/<wbr>name | The area's name: a letter or digit, then letters, digits, hyphens, or underscores, at most 64 characters in all\.<br><br>Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>areas/<wbr>items/<wbr>properties/<wbr>account\_keyed | Whether files are keyed by end user\. The platform records it and does not yet separate files by end user\.<br><br>Type: boolean |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>3 | Type: object<br>Additional properties: false<br>Required fields: \["kind","domain"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>3/<wbr>properties/<wbr>kind | A custom domain for your application\. `domain` is one lowercase hostname of at least three labels, such as `app.example.com`\.<br><br>Required value: custom\_domain |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>3/<wbr>properties/<wbr>domain | $ref: \#/$defs/customDomainHostname |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4 | Type: object<br>Additional properties: false<br>Required fields: \["kind","schedules"\]<br>Examples: \[\{"kind":"schedule","schedules":\[\{"name":"daily\_report","cron":"0 6 \* \* \*","path":"/jobs/daily\-report"\}\]\}\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>kind | Required value: schedule |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>schedules | Your application's schedules, one to twenty\-five\. The schema allows twenty\-five, and a submission over your plan's `schedule-count-limit` is refused by that name\. Each schedule has a name, a five\-field cron expression, and an absolute path\. The name is a lowercase letter first, then lowercase letters, digits, or underscores, with no hyphen, of at most 64 characters, unique within the application\. The platform evaluates the cron expression in UTC at the minute grain\. Its fields are minute, hour, day of month, month, and day of week, each `*`, an integer, a range, a list, or a step\. The schema refuses names, macros, and a sixth field\. The submission refuses a field out of range, or an expression with no due time within a year\. The path is an absolute path on your application's own server, in the form `health` uses\. It is under neither reserved prefix, `/__account/` nor `/__router/`\. The handler at that path is an ordinary `POST` route: the platform calls it through the serving router with an empty body, the router's mark, and the invocation headers that Node\.js Runtime describes\. The platform's harness returns 404 on that path to any request the router did not mark as a scheduled run, so your handler receives scheduled runs only\. The handler's one rule is idempotency per `x-turnzero-cloud-schedule-due`\. That header's value is the due instant in ISO 8601 form in UTC, to the millisecond, such as `2026-10-08T05:00:00.000Z`\. Checking `x-turnzero-cloud-invocation` is your own option, and the handler finishes within the schedule kind's time window\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 25<br>uniqueItems: true |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>schedules/<wbr>items | Type: object<br>Additional properties: false<br>Required fields: \["name","cron","path"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>schedules/<wbr>items/<wbr>properties/<wbr>name | $ref: \#/$defs/slug |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>schedules/<wbr>items/<wbr>properties/<wbr>cron | $ref: \#/$defs/cron |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>4/<wbr>properties/<wbr>schedules/<wbr>items/<wbr>properties/<wbr>path | Type: string<br>Pattern: ^/\[^\\s\]\*$ |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5 | Type: object<br>Additional properties: false<br>Required fields: \["kind"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>kind | The issue\-tracking service\. With no `space`, your application's first submission creates one space of its own for both environments, and your deployments reach it at the `report` level\. An application given a space per environment before this keeps its two spaces\. The receipt's `issue_tracking` list gives each space your application's calls reach\.<br><br>Required value: issue\_tracking |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>space | Optional\. A space your account has, which your application's calls reach instead of a space of its own\. Give one space identifier for both environments, or `{ development, production }` with one for each\. The platform binds the space and creates nothing\. The gateway serves the binding while your account has the issue tracking product, and refuses each call `blueprint_required` otherwise\. An application's own space, this application's or another's, cannot be given here: it is refused `space_not_owned`, as is a space your account does not have\. An application that already has its own space, or a space per environment from before, is refused `invalid_request`, because it cannot bind a chosen space\.<br><br> |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>space/<wbr>oneOf/<wbr>0 | $ref: \#/$defs/space\_id |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>space/<wbr>oneOf/<wbr>1 | Type: object<br>Additional properties: false<br>Required fields: \["development","production"\] |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>space/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>development | $ref: \#/$defs/space\_id |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>space/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>production | $ref: \#/$defs/space\_id |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>level | Optional, and only with `space`\. `report`, the default, files reports and reads them\. The `contribute` level adds the working calls, such as update, comment, and relate\. Any other value, `owner` included, is refused `level_invalid`, because a deployment never settles, configures, or exports a space\. A `level` without `space` is refused `invalid_request`, a refusal that points to `space`\.<br><br>Type: string |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>components | Optional, and only with `space` at the `report` level\. One to two hundred of the space's declared component names, each listed once\. The platform then mints a `report` token for the binding with this list, and your application's calls reach the space under that token\. They read and file within these components only, and see no restricted issue\. They can make only the `/v2` calls `submit`, `read`, `list`, and `search`\. Every other call, and any call on the `/v1` wire, is refused `issue_tracking_call_refused`\. A changed list mints a new token and revokes the old one\. The platform's own space can be bound only this way, by the account it belongs to\. Without `space`, the list is refused `invalid_request`; with another `level`, it is refused `level_invalid`\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 200<br>uniqueItems: true |
| /<wbr>properties/<wbr>services/<wbr>items/<wbr>oneOf/<wbr>5/<wbr>properties/<wbr>components/<wbr>items | Type: string<br>Minimum length: 1<br>Maximum length: 64 |
| /<wbr>properties/<wbr>health | The health endpoint: an absolute HTTP path on your application's own address, usually `/health`\. At each deploy, promote, redeploy, and restart, the health gate sends GET to this path every three seconds for up to 180 seconds\. It passes only on three consecutive answers of status 200 exactly\. Under an invited or workforce audience the serving router gates this path from outside, while the health gate reaches the compute directly; the `audience` description says what each means\. Each probe waits at most ten seconds for its answer to begin\. Twenty consecutive probes that return the same 4xx status, other than 408, 425, and 429, then a control probe that your application's own process responds to, end the gate early, about a minute in\. A 5xx answer or a transport error \(a failed or timed\-out connection\) never counts toward that run\. Serve the route from the moment the server listens, returning 503 until it is ready, so the gate never ends early on a route mounted late\. Return no 4xx status while starting\. A server that waits to listen until its database migrations finish reads as starting, and the gate keeps waiting within its bound\.<br><br>A failed gate records its evidence in the version row's `outcome.gate`, which `read_status` and `list_versions` return\. The evidence lists the probe answers, and the last non\-200 answer with the first 512 bytes of its body where your application gave it\. It also gives what gave that answer, the compute's state, and the console's last forty lines\.<br><br>The schema does not require this member\. An application whose zip names a start of its own needs it\. A deploy, promote, or redeploy that needs it refuses `health_path_undeclared` when it is absent\.<br><br>Type: string<br>Pattern: ^/\[^\\s\]\*$ |
| /<wbr>properties/<wbr>region | Where your application runs, one of the day\-one regions\. During our introductory period the platform serves `usa` alone\. The schema accepts `europe`, `uk`, and `global` ahead of their availability\. A submission with one of them is refused `region_unavailable` before anything is provisioned\.<br><br>Allowed values: \["usa","europe","uk","global"\] |
| /<wbr>properties/<wbr>egress | The network allowlist: exact lowercase DNS hostnames, and host families with one leading wildcard label\. A family such as `*.example.com` covers names below it at any depth, but not `example.com` itself\. The list gives the outside hosts your application's own process dials, apart from the platform endpoints and the declared upstreams, which the gateway dials\. An empty list declares no tunneled outside destinations\. Applications begin in observe mode; an operator can select enforce mode\. In enforce mode, an undeclared destination is refused `egress_undeclared`, a hostname before the proxy resolves it\. In observe mode, an undeclared destination is not refused for being undeclared, and the attempt is recorded as `egress_undeclared` with the attempted host and the remedy\. For a hostname, the remedy is the exact manifest edit: add the host to `egress` and redeploy\. An address literal cannot be declared, so its remedy gives the hostname the address serves\. Where your client's route exposes the proxy's response, a refusal returns 403 and the `X-Egress-Refusal` header; the two caps, on connections and on daily bytes, return 429\. CONNECT tunnels are limited to port 443, and the proxy passes their bytes without checking for TLS or HTTP, so an entry has no scheme or port\. Platform endpoints, which are your declared services' endpoints and the platform origin, are reached outside the proxy and need no entry\. A name that resolves to, or an address literal in, a private, loopback, link\-local \(metadata included\), reserved, or platform range is refused in both modes\. Declare an upstream called on a stored key in the `upstreams` member or through `declare_outbound_api`, not in this list\.<br><br>Type: array<br>uniqueItems: true |
| /<wbr>properties/<wbr>egress/<wbr>items | $ref: \#/$defs/egressEntry |
| /<wbr>properties/<wbr>audience | Who may reach your application: exactly one of three audiences\. The `public` audience lets anyone reach it\. The `invited` audience gates every request on a session of your application's end\-user realm, and makes your realms invitation\-only from the declaration, whatever creation mode their configuration has\. For `invited`, declare the accounts service as `{"kind":"accounts"}` in `services` so your application's users can sign in\. The `workforce` audience lets in only the signed\-in users of one company's identity\-provider tenant, which the `tenant` member gives\. Under `invited` and `workforce`, the optional `session_free_paths` member lists the paths the router lets through with no session\. Under those two, the serving router gates every path, the `health` path among them\. A request from outside carrying no valid session is sent to sign\-in or refused with status 401, unless a `session_free_paths` prefix covers it\. The router also serves its three well\-known documents, and passes its own sign\-in pages under `/__account/`, with no session\. The health gate at each deploy, promote, redeploy, and restart probes the application's compute directly, never through the router, so a deploy needs nothing listed\.<br><br> |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>0 | Type: object<br>Additional properties: false<br>Required fields: \["kind"\] |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>0/<wbr>properties/<wbr>kind | Required value: public |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>1 | Type: object<br>Additional properties: false<br>Required fields: \["kind"\] |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>kind | Required value: invited |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>session\_free\_paths | $ref: \#/$defs/sessionFreePaths |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>2 | Type: object<br>Additional properties: false<br>Required fields: \["kind","tenant"\] |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>kind | Required value: workforce |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>tenant | The company's identity\-provider tenant identifier on the provider's terms — Microsoft Entra ID's tenant id, a GUID, at this revision\. It is the same tenant the realm's `entra` member names, for two purposes: here it gates who reaches the application and signs nobody in, and there it signs people in\. So declare `entra` in the `realm` member's `sign_in_methods` and name this tenant in its `entra` member, in the same manifest\.<br><br>Type: string<br>Minimum length: 1 |
| /<wbr>properties/<wbr>audience/<wbr>oneOf/<wbr>2/<wbr>properties/<wbr>session\_free\_paths | $ref: \#/$defs/sessionFreePaths |
| /<wbr>properties/<wbr>packages | The library entries this application holds, each as its name and the version held\. The act that writes the files writes it: `scaffold` composes it from the rows the take answered, and `library take` rewrites it from the project's folder manifest, the manifest\.json in its system/ folder\. From turnzero 0\.26\.0, the take makes this manifest in the application's folder where none stands\. For a manifest those acts did not write, copy each row of the folder manifest into this list as its `name` and `version` at each submission\. Either way the member is derived from the project's own record; what the rule forbids is a list kept by hand beside the folder manifest as its rows\. Admission reads it to refuse a deploy declaring a version whose compatibility window has closed, a refusal not active during our introductory period while the first\-customer\-release date is unset\. An application holding no entry declares \[\] rather than omitting the member — the member is required, and an omission would read as a fact not yet known where the truth is that there are none\.<br><br>Type: array<br>uniqueItems: true |
| /<wbr>properties/<wbr>packages/<wbr>items | Type: object<br>Additional properties: false<br>Required fields: \["name","version"\] |
| /<wbr>properties/<wbr>packages/<wbr>items/<wbr>properties/<wbr>name | The entry's stable name, as the catalog returns it: a package's folder name, `ui/<vocabulary>`, `fonts/<family>`, or `library/prd` for the library's own requirements entry\.<br><br>Type: string<br>Minimum length: 1 |
| /<wbr>properties/<wbr>packages/<wbr>items/<wbr>properties/<wbr>version | The version your application has, as in the entry's front matter\. It is null for a font family, which has no specification and so no version, and for the library's own requirements entry, whose two documents declare none\.<br><br>Type: \["string","null"\] |
| /<wbr>properties/<wbr>settings | Optional\. The settings your application's process reads\. It is an object from each setting's name to `{"secret": "<stored name>"}`, which binds a stored secret, or `{"value": "<text>"}`, a plain value, with at most fifty entries\. Leave the member out where your process reads no setting this way\. Put a value that is not secret, such as a page title, in `{"value": ...}`: at most 4,096 characters on one line, the same in both environments\. A value that differs by environment stays a stored name\. A secret never goes in `value`, since it stays on each version that applied it; store it, bind it, and rotate it instead\. This member is not an upstream's `sdk_settings`, which list the settings an upstream's client reads while the stored key stays at the gateway\. Declare outside API keys in `upstreams` or through `declare_outbound_api`, even if code reads them now; bind one here only if the client's host is fixed in code your task forbids changing \(see /cloud/guides/call\-an\-external\-api\-with\-an\-api\-key/\#if\-your\-code\-reads\-an\-api\-key\-from\-a\-variable\)\. A setting name is an upper\-case letter, then upper\-case letters, digits, or underscores, ending in a letter or a digit, at most 64 characters\. A name the platform reserves is refused `manifest_invalid` at its own path\. The platform reserves any name under `TURNZERO_`, `APP_`, `HOSTING_`, `EGRESS_`, `ROUTER_`, `NODE_`, or `NPM_`, and `PORT`, `PATH`, `HOME`, `HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`\. Store a bound value with `store_secret`, giving the application and each environment; one name may have a development value and a production value\. A name at the account scope or at another application's scope is refused `setting_scope_refused`, and a platform\-minted name is refused `platform_minted_name`\. A name one of your application's upstreams uses is refused `setting_is_upstream_key`, because the gateway applies that key and never gives it to your application\. The page /cloud/getting\-started/store\-a\-secret/, which `read_documentation` serves, gives the whole rule for choosing between a setting and `declare_outbound_api`, with its example\. A realm's route credential is refused `name_bound_to_realm`, and a push provider's credential `name_bound_to_push`\. Each deploy and promote reads a bound value at that environment's scope and injects it as the setting, and injects a plain value as written\. Where the name is not stored there, the act is refused `setting_secret_missing`\. A rotated value takes effect at the environment's next deploy or promote, and at a `restart_application` where the running copy already has the binding\.<br><br>Type: object<br>maxProperties: 50<br>Additional properties: false |
| /<wbr>properties/<wbr>settings/<wbr>patternProperties/<wbr>^\[A\-Z\]\(?:\[A\-Z0\-9\_\]\{0,62\}\[A\-Z0\-9\]\)?$ | $ref: \#/$defs/binding |
| /<wbr>properties/<wbr>upstreams | Optional\. The keyed upstreams your application calls through the egress gateway, as an object from each upstream's name to its declaration, at most fifty entries\. A declaration takes what `declare_outbound_api` takes but `application`, because the manifest binds each upstream to the application it is submitted for\.<br><br>An upstream's name is unique within the account\. Each submission records every entry as `declare_outbound_api` records a declaration, effective at once, and each deploy and promote injects its `sdk_settings`\. Where `declare_outbound_api` would refuse an entry under a named rule, the submission refuses it `manifest_invalid` at the entry's path, and the violation gives that rule's error\. A name another application of your account uses is refused `binding_refused`, and the refusal gives that application\. The other errors are `reserved_upstream_name`, `refused_platform_host`, `platform_minted_name`, `upstream_key_is_bound`, `name_bound_to_realm`, `name_bound_to_push`, and `invalid_request`\.<br><br>A credential name you have not stored yet is accepted\. The answer's `upstreams` rows say whether it is stored, and the gateway refuses the upstream's calls `credential_not_in_custody` until `store_secret` stores it\. A deploy or promote whose environment reads no stored key for an upstream lists that upstream in its row's `outcome.credentials_missing`\.<br><br>An upstream this member lists belongs to the manifest: `declare_outbound_api` refuses a change to it, and its end with `remove: true`, both `manifest_owned_field`\. Removing an entry leaves the upstream declared, and `declare_outbound_api` can then revise it; no submission ends an upstream\. To end one, remove its entry, submit the manifest, deploy and promote the version that no longer calls it, and call `declare_outbound_api` with `remove: true`\. Leave the member out to declare every upstream through `declare_outbound_api`\.<br><br>Type: object<br>maxProperties: 50<br>Additional properties: false |
| /<wbr>properties/<wbr>upstreams/<wbr>patternProperties/<wbr>^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ | $ref: \#/$defs/upstream |
| /<wbr>properties/<wbr>realm | Optional\. The sign\-in configuration of your application's end\-user realms, in the form `configure_app_sign_in` takes\. The manifest controls each field the member lists: `sign_in_methods`, `creation`, the `entra` and `apple` members, and each listed environment's native `clients`\. The limits, the session days and their cap, and the invitation days stay `configure_app_sign_in`'s, and so do each client's `minimum_version` and `update_url`\. Step 4, Configure the realm, of the page /cloud/guides/manage\-end\-users/, which `read_documentation` serves, has a table of each field's owner\. The `entra` and `apple` members give a stored credential's name and never contain its value\. The services list must include the `accounts` kind\.<br><br>Each submission records the member on each end\-user realm the application has, effective at once, except `clients`, as its own description says\. `create_environment` records it on the development realm it creates\. Where `configure_app_sign_in` would refuse a value under a named rule, the submission refuses it `manifest_invalid` at the member's path, and the violation gives that rule's error\.<br><br>A credential name not stored yet at an environment's scope is accepted\. The answer's `detail` lists each credential not stored yet, with the environment where only one lacks it\. A sign\-in method reads the credential once `store_secret` stores it and you submit the manifest again, which moves it into the realm's vault\. A deploy or promote lists a credential its environment cannot read in its row's `outcome.provider_credentials_missing`\.<br><br>`configure_app_sign_in` refuses a call that would change a field this member lists, `manifest_owned_field`; a call that repeats the recorded value passes\. On a listed environment it refuses a change to the clients the same way, except each client's `minimum_version` and `update_url`\. Removing a field leaves its configuration in place, and `configure_app_sign_in` can then change it\.<br><br>Type: object<br>Additional properties: false<br>minProperties: 1 |
| /<wbr>properties/<wbr>realm/<wbr>properties/<wbr>sign\_in\_methods | $ref: \#/$defs/realmSignInMethods |
| /<wbr>properties/<wbr>realm/<wbr>properties/<wbr>creation | Who may create an account by signing in: `open` or `invited`\. Under an `invited` audience, `open` is refused, and the violation gives `creation_contradicts_audience`\.<br><br>Allowed values: \["open","invited"\] |
| /<wbr>properties/<wbr>realm/<wbr>properties/<wbr>entra | $ref: \#/$defs/realmEntra |
| /<wbr>properties/<wbr>realm/<wbr>properties/<wbr>apple | $ref: \#/$defs/realmApple |
| /<wbr>properties/<wbr>realm/<wbr>properties/<wbr>clients | $ref: \#/$defs/realmClients |
| /<wbr>properties/<wbr>websockets | Optional\. Declares that your application accepts WebSocket upgrades, and from which browser origins besides its own hostname\. A serverless application's manifest cannot declare this member\. The member is an object with at most `origins`, a list of at most ten browser origins\. The empty object accepts a page on your application's own hostname and a client outside a browser\. A manifest without the member accepts no upgrade: the serving router refuses every upgrade `websockets_not_declared`, and nothing reaches your application\. Each origin is exact, in the form a browser's `Origin` header has: the `https` scheme, a lowercase host, and an optional port other than the default 443\. It has no path, query, fragment, user information, or wildcard, and no origin repeats an earlier one\. The submission refuses a list that breaks a rule by the rule's name, at the entry's own JSON path, before the schema check\. Each submission records the member, and the serving router reads it within about 30 seconds, with no redeploy\. Both environments read the one declaration, and the plan's `websocket-connections-per-replica` limits its connections\.<br><br>Type: object<br>Additional properties: false |
| /<wbr>properties/<wbr>websockets/<wbr>properties/<wbr>origins | The browser origins accepted besides your hostname's own, at most ten, each exact and listed once\.<br><br>Type: array<br>Maximum items: 10<br>uniqueItems: true |
| /<wbr>properties/<wbr>websockets/<wbr>properties/<wbr>origins/<wbr>items | $ref: \#/$defs/websocketOrigin |
| /<wbr>properties/<wbr>smoke\_paths | Optional\. One to five distinct absolute HTTP paths, each `/` followed by non\-whitespace, that a deploy or a promote requests with GET in its `smoke_check` step, after the health gate passes\. Each is a path, not a URL, as for `health`, and outside the platform's prefixes `/__account/` and `/__router/`\. Without this member, the deploy requests the health path only\. List the routes whose crash should stop a deploy or a promote before it switches\. A path passes on any status below 500 except 404\. A 404, a 5xx answer, or a transport error is requested again every three seconds\. A path that has not passed within 30 seconds of the first smoke request fails the act `smoke_path_failed`\. List routes that change nothing on GET and respond within ten seconds, because on a promote they run against production's data and secrets\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 5<br>uniqueItems: true |
| /<wbr>properties/<wbr>smoke\_paths/<wbr>items | Type: string<br>Pattern: ^/\[^\\s\]\*$ |
| /<wbr>properties/<wbr>application | Optional\. The application this folder deploys to: a lowercase UUID, as `create_application` returns it\. It is no admission declaration\. The platform checks its form only and does nothing else with it, and the deploy's `manifest_notice` leaves it out of its comparison\. A fork deployed to another application changes or removes it\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{8\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{12\}$ |
| /<wbr>$defs/<wbr>realmSignInMethods | The enabled sign\-in methods, which replace each realm's set: any of `google`, `github`, `passkey`, `email`, `entra`, and `apple`\. Google and GitHub use the platform's registrations; `google`, `github`, `email` and `passkey` need no credential of the developer's\. To list `entra` or `apple`, configure that route too, in the `realm` member or with `configure_app_sign_in`\.<br><br>Type: array<br>uniqueItems: true |
| /<wbr>$defs/<wbr>realmSignInMethods/<wbr>items | Allowed values: \["google","github","passkey","email","entra","apple"\] |
| /<wbr>$defs/<wbr>realmEntra | The work\-account sign\-in route's configuration: the Entra tenant id as a GUID, the app registration's client id, and the stored name of the client secret, never its value\. In the app registration, list the platform's callback as a web redirect URI, exactly as `configure_app_sign_in` and `read_app_sign_in` return it in `callbacks.entra`\. It is one address for the platform, the same for both environments, and never the application's hostname\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["tenant","client\_id","client\_secret\_name"\] |
| /<wbr>$defs/<wbr>realmEntra/<wbr>properties/<wbr>tenant | Type: string<br>Pattern: ^\[0\-9a\-fA\-F\]\{8\}\-\[0\-9a\-fA\-F\]\{4\}\-\[0\-9a\-fA\-F\]\{4\}\-\[0\-9a\-fA\-F\]\{4\}\-\[0\-9a\-fA\-F\]\{12\}$ |
| /<wbr>$defs/<wbr>realmEntra/<wbr>properties/<wbr>client\_id | Type: string<br>Pattern: ^\[A\-Za\-z0\-9\]\[A\-Za\-z0\-9\.\_:\-\]\{0,254\}$ |
| /<wbr>$defs/<wbr>realmEntra/<wbr>properties/<wbr>client\_secret\_name | Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>realmApple | Sign in with Apple's configuration: the Services ID, the team and key identifiers, and the stored name of the signing key, never its value\. In the Services ID, list the host of `callbacks.apple` as a domain and that address, exactly, as its return URL, as `configure_app_sign_in` and `read_app_sign_in` return it\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["services\_id","team\_id","key\_id","key\_secret\_name"\] |
| /<wbr>$defs/<wbr>realmApple/<wbr>properties/<wbr>services\_id | Type: string<br>Pattern: ^\[A\-Za\-z0\-9\]\[A\-Za\-z0\-9\.\-\]\{0,254\}$ |
| /<wbr>$defs/<wbr>realmApple/<wbr>properties/<wbr>team\_id | Type: string<br>Pattern: ^\[A\-Z0\-9\]\{10\}$ |
| /<wbr>$defs/<wbr>realmApple/<wbr>properties/<wbr>key\_id | Type: string<br>Pattern: ^\[A\-Z0\-9\]\{10\}$ |
| /<wbr>$defs/<wbr>realmApple/<wbr>properties/<wbr>key\_secret\_name | Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>realmClients | Optional\. The native apps that sign in through each realm: one list for `development`, `production`, or both\. Each list has one to ten clients and replaces that realm's list at each submission\. A development list on an application without a development environment is checked now, and `create_environment` declares it later\. A listed environment's clients belong to the manifest\. There, `configure_app_sign_in` changes only each client's `minimum_version` and `update_url`, which a submission keeps\.<br><br>Type: object<br>Additional properties: false<br>minProperties: 1 |
| /<wbr>$defs/<wbr>realmClients/<wbr>properties/<wbr>development | Type: array<br>Minimum items: 1<br>Maximum items: 10 |
| /<wbr>$defs/<wbr>realmClients/<wbr>properties/<wbr>development/<wbr>items | $ref: \#/$defs/realmClient |
| /<wbr>$defs/<wbr>realmClients/<wbr>properties/<wbr>production | Type: array<br>Minimum items: 1<br>Maximum items: 10 |
| /<wbr>$defs/<wbr>realmClients/<wbr>properties/<wbr>production/<wbr>items | $ref: \#/$defs/realmClient |
| /<wbr>$defs/<wbr>realmClient | One native public client, in the form `configure_app_sign_in` takes, without `minimum_version` and `update_url`\. A redirect URI is a reverse\-domain custom scheme, an `https` URI on one of your application's own hostnames, or a loopback `http` URI\. Any other is refused `invalid_redirect_uri` at its path\. A production list may also use the custom domain while the same manifest declares it\. A re\-created or copied application has new hostnames, so its `https` URIs must use them, or the submission is refused whole, recording nothing\. A copy made for another app replaces `client_id` and the platform identities with that app's own\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["client\_id","redirect\_uris"\] |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>client\_id | Its id: letters, digits, dots, underscores, colons, and hyphens\.<br><br>Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>redirect\_uris | A reverse\-domain custom scheme, `https` on the application's own hostnames or, on the production realm, its custom domain, or loopback `http` on `localhost`, `[::1]`, or 127\.0\.0\.0/8; others are refused `invalid_redirect_uri`\.<br><br>Type: array<br>Minimum items: 1<br>Maximum items: 20 |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>redirect\_uris/<wbr>items | Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>ios | Bundle id and ten\-character team id\.<br><br>Type: object<br>Required fields: \["bundle\_id","team\_id"\]<br>Additional properties: false |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>ios/<wbr>properties/<wbr>bundle\_id | Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>ios/<wbr>properties/<wbr>team\_id | Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>android | Package name and SHA\-256 signing\-certificate fingerprints: 32 upper\-case hex pairs joined by colons\.<br><br>Type: object<br>Required fields: \["package","sha256\_cert\_fingerprints"\]<br>Additional properties: false |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>android/<wbr>properties/<wbr>package | Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>android/<wbr>properties/<wbr>sha256\_cert\_fingerprints | Type: array<br>Minimum items: 1<br>Maximum items: 10 |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>android/<wbr>properties/<wbr>sha256\_cert\_fingerprints/<wbr>items | Type: string |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>google\_client\_ids | The Google ID token audiences for this app\.<br><br>Type: array<br>Maximum items: 10 |
| /<wbr>$defs/<wbr>realmClient/<wbr>properties/<wbr>google\_client\_ids/<wbr>items | Type: string |
| /<wbr>$defs/<wbr>pushApns | Apple's push provider: the team and key identifiers, the app's bundle identifier, and the stored name of the signing key\. The gateway is not set here, because it differs by environment\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["team\_id","key\_id","bundle\_id","key\_secret\_name"\] |
| /<wbr>$defs/<wbr>pushApns/<wbr>properties/<wbr>team\_id | Type: string<br>Pattern: ^\[A\-Z0\-9\]\{10\}$ |
| /<wbr>$defs/<wbr>pushApns/<wbr>properties/<wbr>key\_id | Type: string<br>Pattern: ^\[A\-Z0\-9\]\{10\}$ |
| /<wbr>$defs/<wbr>pushApns/<wbr>properties/<wbr>bundle\_id | Type: string<br>Pattern: ^\[A\-Za\-z0\-9\-\]\+\(\\\.\[A\-Za\-z0\-9\-\]\+\)\+$<br>Maximum length: 255 |
| /<wbr>$defs/<wbr>pushApns/<wbr>properties/<wbr>key\_secret\_name | Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>pushFcm | Google's push provider: the Firebase project identifier and the stored name of the service\-account file\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["project\_id","service\_account\_secret\_name"\] |
| /<wbr>$defs/<wbr>pushFcm/<wbr>properties/<wbr>project\_id | Type: string<br>Pattern: ^\[a\-z\]\[a\-z0\-9\-\]\{4,29\}$ |
| /<wbr>$defs/<wbr>pushFcm/<wbr>properties/<wbr>service\_account\_secret\_name | Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>slug | A name in this form: a lowercase letter first, then lowercase letters, digits, or underscores, with no hyphen, of at most 64 characters\. The pattern is `^[a-z][a-z0-9_]*$`, so `hourly_heartbeat` passes and `hourly-heartbeat` is refused\.<br><br>Type: string<br>Pattern: ^\[a\-z\]\[a\-z0\-9\_\]\*$<br>Maximum length: 64 |
| /<wbr>$defs/<wbr>hostname | Type: string<br>Pattern: ^\(?=\.\{1,253\}$\)\(\[a\-z0\-9\]\(\[a\-z0\-9\-\]\{0,61\}\[a\-z0\-9\]\)?\\\.\)\+\[a\-z\]\{2,63\}$ |
| /<wbr>$defs/<wbr>customDomainHostname | One lowercase hostname of at least three labels, so `app.example.com` passes and `example.com` is refused here\. The schema checks only this minimum; the submission applies the apex rule and the other hostname rules\.<br><br>Type: string<br>Pattern: ^\(?=\.\{1,253\}$\)\(\[a\-z0\-9\]\(\[a\-z0\-9\-\]\{0,61\}\[a\-z0\-9\]\)?\\\.\)\{2,\}\[a\-z\]\{2,63\}$ |
| /<wbr>$defs/<wbr>egressEntry | One egress entry: an exact lowercase hostname, or a host family, which is one leading wildcard label and then a hostname of at least two labels\. So `*.example.com` passes, and `*.com`, `*.*.example.com`, and a wildcard anywhere but first are refused\.<br><br>Type: string<br>Pattern: ^\(?=\.\{1,253\}$\)\(\\\*\\\.\)?\(\[a\-z0\-9\]\(\[a\-z0\-9\-\]\{0,61\}\[a\-z0\-9\]\)?\\\.\)\+\[a\-z\]\{2,63\}$ |
| /<wbr>$defs/<wbr>cron | Five cron fields, evaluated in UTC, each made of digits, `*`, `,`, `/`, and `-`\. The submission refuses a field out of range\. Where neither day field is a lone `*`, the schedule runs on a day the month field admits that matches either one\.<br><br>Type: string<br>Pattern: ^\(\[0\-9\*,/\-\]\+\)\\s\+\(\[0\-9\*,/\-\]\+\)\\s\+\(\[0\-9\*,/\-\]\+\)\\s\+\(\[0\-9\*,/\-\]\+\)\\s\+\(\[0\-9\*,/\-\]\+\)$ |
| /<wbr>$defs/<wbr>binding | One setting, exactly one of two forms\. `{"secret": "<stored name>"}` binds the stored name whose value the setting receives: a letter or digit, then letters, digits, hyphens, or underscores, at most 64 characters, the form of every stored name\. `{"value": "<text>"}` gives a plain value: at most 4,096 characters, empty allowed, with no control character\.<br><br> |
| /<wbr>$defs/<wbr>binding/<wbr>oneOf/<wbr>0 | Type: object<br>Additional properties: false<br>Required fields: \["secret"\] |
| /<wbr>$defs/<wbr>binding/<wbr>oneOf/<wbr>0/<wbr>properties/<wbr>secret | Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>binding/<wbr>oneOf/<wbr>1 | Type: object<br>Additional properties: false<br>Required fields: \["value"\] |
| /<wbr>$defs/<wbr>binding/<wbr>oneOf/<wbr>1/<wbr>properties/<wbr>value | Type: string<br>Maximum length: 4096<br>Pattern: ^\[^\\u0000\-\\u001F\\u007F\]\*$ |
| /<wbr>$defs/<wbr>sessionFreePaths | The paths the serving router lets through with no end\-user session under the `invited` or `workforce` audience, so a provider's callback, such as a payment webhook, reaches your application\. List at most ten path prefixes\. Each starts with `/`, is never `/` alone, and has no whitespace and no `..`\. Each is outside the platform's own prefixes, `/__account/` and `/__router/`, in any letter case\. A prefix covers the path equal to it and every path below it, segment by segment\. Your application checks each such caller itself, for example by the provider's signature\. The `public` audience has no such list\.<br><br>Type: array<br>Maximum items: 10 |
| /<wbr>$defs/<wbr>sessionFreePaths/<wbr>items | Type: string<br>Pattern: ^/\(?\!\_\_\[aA\]\[cC\]\[cC\]\[oO\]\[uU\]\[nN\]\[tT\]\(/\|$\)\)\(?\!\_\_\[rR\]\[oO\]\[uU\]\[tT\]\[eE\]\[rR\]\(/\|$\)\)\(?\!\.\*\\\.\\\.\)\[^\\s\]\+$ |
| /<wbr>$defs/<wbr>upstream | One upstream's declaration: the members `declare_outbound_api` takes, except `name`, which is the entry's key, and `application`\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["base\_url","credential\_name","auth\_header"\] |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>base\_url | The upstream's base URL, a public `https://` address only\. A platform host is refused `refused_platform_host`\.<br><br>Type: string<br>Minimum length: 9<br>Maximum length: 2000 |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>credential\_name | The stored name of the upstream's key\. Store it with `store_secret` at one of your application's environment scopes, or at the account scope\.<br><br>Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\]\[a\-zA\-Z0\-9\_\-\]\{0,63\}$ |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>auth\_header | The HTTP header the gateway sends the key in, such as `Authorization` or `x-api-key`\.<br><br>Type: string<br>Pattern: ^\[a\-zA\-Z0\-9\-\]\{1,64\}$ |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>auth\_format | The header value around the key, with `{value}` in place of the key, such as `Bearer {value}`\. Without this member, the header value is the key alone\.<br><br>Type: string<br>Minimum length: 7<br>Maximum length: 200 |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>token\_shape | How token counts are read from the upstream's responses: `gemini` or `anthropic`\. Leave it out for an upstream that reports none\.<br><br>Allowed values: \["gemini","anthropic"\] |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>sdk\_settings | $ref: \#/$defs/upstreamSettings |
| /<wbr>$defs/<wbr>upstream/<wbr>properties/<wbr>settings | Deprecated: the former name of `sdk_settings`, still accepted in its place\. Use `sdk_settings` instead\. An entry with both is refused `manifest_invalid` at this member, and the violation gives `invalid_request`\.<br><br>$ref: \#/$defs/upstreamSettings |
| /<wbr>$defs/<wbr>upstreamSettings | The settings an unchanged client of the upstream reads in your deployed container\. The setting named in `base_url` receives the gateway's address for the upstream, ending with `base_path` where given\. The setting named in `key` receives an egress key, which the gateway reads from `Authorization: Bearer` alone, whatever the upstream's `auth_header`, and swaps for the stored key\. Without this member, no setting is injected for the upstream\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["base\_url"\] |
| /<wbr>$defs/<wbr>upstreamSettings/<wbr>properties/<wbr>base\_url | Type: string<br>Pattern: ^\[A\-Z\]\(?:\[A\-Z0\-9\_\]\{0,62\}\[A\-Z0\-9\]\)?$ |
| /<wbr>$defs/<wbr>upstreamSettings/<wbr>properties/<wbr>key | Type: string<br>Pattern: ^\[A\-Z\]\(?:\[A\-Z0\-9\_\]\{0,62\}\[A\-Z0\-9\]\)?$ |
| /<wbr>$defs/<wbr>upstreamSettings/<wbr>properties/<wbr>base\_path | Type: string<br>Pattern: ^\(/\[A\-Za\-z0\-9\.\_\~%\-\]\+\)\+$<br>Maximum length: 200 |
| /<wbr>$defs/<wbr>space\_id | A space's identifier at the issue\-tracking service, a lower\-case UUID\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{8\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{4\}\-\[0\-9a\-f\]\{12\}$ |
| /<wbr>$defs/<wbr>websocketOrigin | One browser origin of a WebSocket declaration, in the form a browser's `Origin` header has\. It is `https://`, then a lowercase host of letters, digits, hyphens, and dots, then an optional port from 1 to 65535 other than the default 443\. A host label has at most 63 characters and the host at most 253\. So `https://app.example.com` and `https://app.example.com:8443` pass\. A path, a trailing slash, a query, a wildcard, user information, an upper\-case letter, another scheme, and `:443` are refused\.<br><br>Type: string<br>Pattern: ^https\://\(?=\[a\-z0\-9\.\-\]\{1,253\}\(?::\|$\)\)\[a\-z0\-9\]\(?:\[a\-z0\-9\-\]\{0,61\}\[a\-z0\-9\]\)?\(?:\\\.\[a\-z0\-9\]\(?:\[a\-z0\-9\-\]\{0,61\}\[a\-z0\-9\]\)?\)\*\(?::\(?\!443$\)\(?:\[1\-9\]\[0\-9\]\{0,3\}\|\[1\-5\]\[0\-9\]\{4\}\|6\[0\-4\]\[0\-9\]\{3\}\|65\[0\-4\]\[0\-9\]\{2\}\|655\[0\-2\]\[0\-9\]\|6553\[0\-5\]\)\)?$ |

## Complete source

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "version": "2026-11-19.2",
  "title": "tzCloud — application manifest, revision 1",
  "description": "The schema of your application's manifest, `manifest.json`, the executable form of the admission manifest contract (MAN). This schema and that contract change together, and a test in the platform's suite checks that they agree. The required members: `manifest_version`, the contract revision; `services`, its provisioned services; `region`, its region; `egress`, the hosts it calls; `audience`, who may reach it; and `packages`, its library entries. Optional `settings` holds stored secrets or plain process values. A zip's own start needs `health`, its health path. Other optional members: `upstreams` (keyed gateway APIs), `realm` (end-user sign-in), `websockets` (WebSocket upgrades), `smoke_paths` (checks after the health gate), and `application` (deploy target). Read one member alone with `read_context` and the id `manifest_schema:<member>`, and one service kind with `manifest_schema:services:<kind>`. The `examples` member that follows is a complete manifest for an application that runs a server: no services, no outside hosts, a public audience, and no library entries. For a static site, use this example without `health`; its files go under `client/` and it needs no server start script.",
  "examples": [
    {
      "manifest_version": 1,
      "services": [],
      "health": "/health",
      "region": "usa",
      "egress": [],
      "audience": {
        "kind": "public"
      },
      "packages": []
    }
  ],
  "type": "object",
  "additionalProperties": false,
  "required": [
    "manifest_version",
    "services",
    "region",
    "egress",
    "audience",
    "packages"
  ],
  "properties": {
    "manifest_version": {
      "description": "The contract revision your manifest follows: `1` for this form (MAN-01).",
      "const": 1
    },
    "services": {
      "description": "The provisioned services your application uses, each by its catalog name. An empty list states that your application uses none; it is not an omission (MAN-03).",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "oneOf": [
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind"
            ],
            "properties": {
              "kind": {
                "enum": [
                  "database",
                  "object_storage",
                  "email",
                  "accounts",
                  "push"
                ],
                "description": "`database`, `object_storage`, `accounts`, and `push` are the kinds the platform provisions or admits at submission as their services state. An `accounts` entry contains only `kind`; use the manifest's top-level `realm` to configure sign-in and its top-level `audience` to choose who may reach the application.\n\nThe `object_storage` kind alone creates no storage area. Each area is declared in the entry's `areas`, with the client's `mintArea` at the backend's start, or with `declare_storage_area`, before its first use (OST-L0-01). The `push` kind admits the configuration and the routes and provisions nothing at submission. The `email` kind provisions nothing and is admitted on a plan whose `email-send-supported` row reads 1, Pro at the beta; elsewhere submit_manifest refuses it `email_not_on_plan`."
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind"
            ],
            "minProperties": 2,
            "properties": {
              "kind": {
                "const": "push",
                "description": "The `push` kind with its providers, `apns` and `fcm`, in the form `configure_push` takes them, except that `apns` has no gateway member (PSH-L0-01). Each submission records the providers on the push configuration of every environment your application has, effective at once. `create_environment` records them on the development configuration it creates. Where `configure_push` would refuse a value under a named rule, the submission refuses it `manifest_invalid` at the member's path, and the violation gives that rule's error.\n\nA credential name you have not stored yet is accepted, as for the `realm` member. A provider this entry lists belongs to the manifest: `configure_push` refuses a change to it `manifest_owned_field`. Apple's gateway differs by environment and stays with `configure_push`: `sandbox` in development and `production` in production, until you set another there."
              },
              "apns": {
                "$ref": "#/$defs/pushApns"
              },
              "fcm": {
                "$ref": "#/$defs/pushFcm"
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind",
              "areas"
            ],
            "properties": {
              "kind": {
                "const": "object_storage",
                "description": "The `object_storage` kind with the storage areas each submission declares. Each area belongs to your application and keeps no file versions (MAN-03; OST-L0-01). An existing area with the same declarations is left unchanged. A name that already exists with other declarations, or under another application, is refused `manifest_invalid` at its path, before anything is recorded. An area whose name you later leave out keeps existing, with its files. To end an empty area, call `declare_storage_area` with `remove: true`."
              },
              "areas": {
                "type": "array",
                "minItems": 1,
                "maxItems": 50,
                "description": "One to fifty areas, each name listed once. A second `object_storage` entry in `services` is refused.",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "account_keyed"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$",
                      "description": "The area's name: a letter or digit, then letters, digits, hyphens, or underscores, at most 64 characters in all."
                    },
                    "account_keyed": {
                      "type": "boolean",
                      "description": "Whether files are keyed by end user. The platform records it and does not yet separate files by end user."
                    }
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind",
              "domain"
            ],
            "properties": {
              "kind": {
                "const": "custom_domain",
                "description": "A custom domain for your application. `domain` is one lowercase hostname of at least three labels, such as `app.example.com` (MAN-03; SVC-L0-25)."
              },
              "domain": {
                "$ref": "#/$defs/customDomainHostname"
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind",
              "schedules"
            ],
            "examples": [
              {
                "kind": "schedule",
                "schedules": [
                  {
                    "name": "daily_report",
                    "cron": "0 6 * * *",
                    "path": "/jobs/daily-report"
                  }
                ]
              }
            ],
            "properties": {
              "kind": {
                "const": "schedule"
              },
              "schedules": {
                "description": "Your application's schedules, one to twenty-five (MAN-03; SVC-L0-15). The schema allows twenty-five, and a submission over your plan's `schedule-count-limit` is refused by that name. Each schedule has a name, a five-field cron expression, and an absolute path. The name is a lowercase letter first, then lowercase letters, digits, or underscores, with no hyphen, of at most 64 characters, unique within the application. The platform evaluates the cron expression in UTC at the minute grain. Its fields are minute, hour, day of month, month, and day of week, each `*`, an integer, a range, a list, or a step. The schema refuses names, macros, and a sixth field. The submission refuses a field out of range, or an expression with no due time within a year. The path is an absolute path on your application's own server, in the form `health` uses (MAN-05). It is under neither reserved prefix, `/__account/` nor `/__router/`. The handler at that path is an ordinary `POST` route: the platform calls it through the serving router with an empty body, the router's mark, and the invocation headers that Node.js Runtime describes. The platform's harness returns 404 on that path to any request the router did not mark as a scheduled run, so your handler receives scheduled runs only. The handler's one rule is idempotency per `x-turnzero-cloud-schedule-due`. That header's value is the due instant in ISO 8601 form in UTC, to the millisecond, such as `2026-10-08T05:00:00.000Z`. Checking `x-turnzero-cloud-invocation` is your own option, and the handler finishes within the schedule kind's time window (HST-L0-02).",
                "type": "array",
                "minItems": 1,
                "maxItems": 25,
                "uniqueItems": true,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "cron",
                    "path"
                  ],
                  "properties": {
                    "name": {
                      "$ref": "#/$defs/slug"
                    },
                    "cron": {
                      "$ref": "#/$defs/cron"
                    },
                    "path": {
                      "type": "string",
                      "pattern": "^/[^\\s]*$"
                    }
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind"
            ],
            "properties": {
              "kind": {
                "const": "issue_tracking",
                "description": "The issue-tracking service (MAN-03; SVC-L0-19). With no `space`, your application's first submission creates one space of its own for both environments, and your deployments reach it at the `report` level. An application given a space per environment before this keeps its two spaces (ITS-L0-01). The receipt's `issue_tracking` list gives each space your application's calls reach."
              },
              "space": {
                "description": "Optional. A space your account has, which your application's calls reach instead of a space of its own (MAN-03). Give one space identifier for both environments, or `{ development, production }` with one for each. The platform binds the space and creates nothing. The gateway serves the binding while your account has the issue tracking product, and refuses each call `blueprint_required` otherwise. An application's own space, this application's or another's, cannot be given here: it is refused `space_not_owned`, as is a space your account does not have. An application that already has its own space, or a space per environment from before, is refused `invalid_request`, because it cannot bind a chosen space (ITS-L0-01).",
                "oneOf": [
                  {
                    "$ref": "#/$defs/space_id"
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "development",
                      "production"
                    ],
                    "properties": {
                      "development": {
                        "$ref": "#/$defs/space_id"
                      },
                      "production": {
                        "$ref": "#/$defs/space_id"
                      }
                    }
                  }
                ]
              },
              "level": {
                "type": "string",
                "description": "Optional, and only with `space` (MAN-03). `report`, the default, files reports and reads them. The `contribute` level adds the working calls, such as update, comment, and relate. Any other value, `owner` included, is refused `level_invalid`, because a deployment never settles, configures, or exports a space. A `level` without `space` is refused `invalid_request`, a refusal that points to `space` (ITS-L0-01)."
              },
              "components": {
                "type": "array",
                "minItems": 1,
                "maxItems": 200,
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "description": "Optional, and only with `space` at the `report` level (MAN-03). One to two hundred of the space's declared component names, each listed once. The platform then mints a `report` token for the binding with this list, and your application's calls reach the space under that token. They read and file within these components only, and see no restricted issue. They can make only the `/v2` calls `submit`, `read`, `list`, and `search`. Every other call, and any call on the `/v1` wire, is refused `issue_tracking_call_refused`. A changed list mints a new token and revokes the old one. The platform's own space can be bound only this way, by the account it belongs to. Without `space`, the list is refused `invalid_request`; with another `level`, it is refused `level_invalid` (ITS-L0-01)."
              }
            }
          }
        ]
      }
    },
    "health": {
      "description": "The health endpoint: an absolute HTTP path on your application's own address, usually `/health` (MAN-05). At each deploy, promote, redeploy, and restart, the health gate sends GET to this path every three seconds for up to 180 seconds. It passes only on three consecutive answers of status 200 exactly (PLD-L0-63). Under an invited or workforce audience the serving router gates this path from outside, while the health gate reaches the compute directly; the `audience` description says what each means (ADM-L0-05). Each probe waits at most ten seconds for its answer to begin. Twenty consecutive probes that return the same 4xx status, other than 408, 425, and 429, then a control probe that your application's own process responds to, end the gate early, about a minute in. A 5xx answer or a transport error (a failed or timed-out connection) never counts toward that run. Serve the route from the moment the server listens, returning 503 until it is ready, so the gate never ends early on a route mounted late. Return no 4xx status while starting. A server that waits to listen until its database migrations finish reads as starting, and the gate keeps waiting within its bound.\n\nA failed gate records its evidence in the version row's `outcome.gate`, which `read_status` and `list_versions` return. The evidence lists the probe answers, and the last non-200 answer with the first 512 bytes of its body where your application gave it. It also gives what gave that answer, the compute's state, and the console's last forty lines (PLD-L0-59).\n\nThe schema does not require this member. An application whose zip names a start of its own needs it. A deploy, promote, or redeploy that needs it refuses `health_path_undeclared` when it is absent.",
      "type": "string",
      "pattern": "^/[^\\s]*$"
    },
    "region": {
      "description": "Where your application runs, one of the day-one regions (PLD-L0-22). During our introductory period the platform serves `usa` alone. The schema accepts `europe`, `uk`, and `global` ahead of their availability. A submission with one of them is refused `region_unavailable` before anything is provisioned (PLD-L0-22).",
      "enum": [
        "usa",
        "europe",
        "uk",
        "global"
      ]
    },
    "egress": {
      "description": "The network allowlist: exact lowercase DNS hostnames, and host families with one leading wildcard label (MAN-09). A family such as `*.example.com` covers names below it at any depth, but not `example.com` itself. The list gives the outside hosts your application's own process dials, apart from the platform endpoints and the declared upstreams, which the gateway dials. An empty list declares no tunneled outside destinations. Applications begin in observe mode; an operator can select enforce mode. In enforce mode, an undeclared destination is refused `egress_undeclared`, a hostname before the proxy resolves it. In observe mode, an undeclared destination is not refused for being undeclared, and the attempt is recorded as `egress_undeclared` with the attempted host and the remedy. For a hostname, the remedy is the exact manifest edit: add the host to `egress` and redeploy. An address literal cannot be declared, so its remedy gives the hostname the address serves (ADM-L0-03; EGW-L0-14; EGW-L0-17). Where your client's route exposes the proxy's response, a refusal returns 403 and the `X-Egress-Refusal` header; the two caps, on connections and on daily bytes, return 429 (EGW-L0-14). CONNECT tunnels are limited to port 443, and the proxy passes their bytes without checking for TLS or HTTP, so an entry has no scheme or port (EGW-L0-12). Platform endpoints, which are your declared services' endpoints and the platform origin, are reached outside the proxy and need no entry (EGW-L0-15). A name that resolves to, or an address literal in, a private, loopback, link-local (metadata included), reserved, or platform range is refused in both modes (EGW-L0-13). Declare an upstream called on a stored key in the `upstreams` member or through `declare_outbound_api`, not in this list (EGW-L0-02).",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "#/$defs/egressEntry"
      }
    },
    "audience": {
      "description": "Who may reach your application: exactly one of three audiences (MAN-10). The `public` audience lets anyone reach it. The `invited` audience gates every request on a session of your application's end-user realm, and makes your realms invitation-only from the declaration, whatever creation mode their configuration has (ADM-L0-05). For `invited`, declare the accounts service as `{\"kind\":\"accounts\"}` in `services` so your application's users can sign in (MAN-03). The `workforce` audience lets in only the signed-in users of one company's identity-provider tenant, which the `tenant` member gives. Under `invited` and `workforce`, the optional `session_free_paths` member lists the paths the router lets through with no session (ADM-L0-05). Under those two, the serving router gates every path, the `health` path among them. A request from outside carrying no valid session is sent to sign-in or refused with status 401, unless a `session_free_paths` prefix covers it (ADM-L0-05). The router also serves its three well-known documents, and passes its own sign-in pages under `/__account/`, with no session (ADM-L0-05). The health gate at each deploy, promote, redeploy, and restart probes the application's compute directly, never through the router, so a deploy needs nothing listed (PLD-L0-63).",
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind"
          ],
          "properties": {
            "kind": {
              "const": "public"
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind"
          ],
          "properties": {
            "kind": {
              "const": "invited"
            },
            "session_free_paths": {
              "$ref": "#/$defs/sessionFreePaths"
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "tenant"
          ],
          "properties": {
            "kind": {
              "const": "workforce"
            },
            "tenant": {
              "type": "string",
              "minLength": 1,
              "description": "The company's identity-provider tenant identifier on the provider's terms — Microsoft Entra ID's tenant id, a GUID, at this revision (ACS-L0-09). It is the same tenant the realm's `entra` member names, for two purposes: here it gates who reaches the application and signs nobody in, and there it signs people in. So declare `entra` in the `realm` member's `sign_in_methods` and name this tenant in its `entra` member, in the same manifest."
            },
            "session_free_paths": {
              "$ref": "#/$defs/sessionFreePaths"
            }
          }
        }
      ]
    },
    "packages": {
      "description": "The library entries this application holds, each as its name and the version held. The act that writes the files writes it: `scaffold` composes it from the rows the take answered, and `library take` rewrites it from the project's folder manifest, the manifest.json in its system/ folder. From turnzero 0.26.0, the take makes this manifest in the application's folder where none stands. For a manifest those acts did not write, copy each row of the folder manifest into this list as its `name` and `version` at each submission. Either way the member is derived from the project's own record; what the rule forbids is a list kept by hand beside the folder manifest as its rows (SPM-L0-50; SPM-L0-49). Admission reads it to refuse a deploy declaring a version whose compatibility window has closed (API-L0-16), a refusal not active during our introductory period while the first-customer-release date is unset. An application holding no entry declares [] rather than omitting the member — the member is required, and an omission would read as a fact not yet known where the truth is that there are none.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name",
          "version"
        ],
        "properties": {
          "name": {
            "description": "The entry's stable name, as the catalog returns it: a package's folder name, `ui/<vocabulary>`, `fonts/<family>`, or `library/prd` for the library's own requirements entry.",
            "type": "string",
            "minLength": 1
          },
          "version": {
            "description": "The version your application has, as in the entry's front matter (FTR-L0-62). It is null for a font family, which has no specification and so no version, and for the library's own requirements entry, whose two documents declare none.",
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    },
    "settings": {
      "description": "Optional. The settings your application's process reads (MAN-14). It is an object from each setting's name to `{\"secret\": \"<stored name>\"}`, which binds a stored secret, or `{\"value\": \"<text>\"}`, a plain value, with at most fifty entries. Leave the member out where your process reads no setting this way. Put a value that is not secret, such as a page title, in `{\"value\": ...}`: at most 4,096 characters on one line, the same in both environments. A value that differs by environment stays a stored name. A secret never goes in `value`, since it stays on each version that applied it; store it, bind it, and rotate it instead. This member is not an upstream's `sdk_settings`, which list the settings an upstream's client reads while the stored key stays at the gateway. Declare outside API keys in `upstreams` or through `declare_outbound_api`, even if code reads them now; bind one here only if the client's host is fixed in code your task forbids changing (see /cloud/guides/call-an-external-api-with-an-api-key/#if-your-code-reads-an-api-key-from-a-variable). A setting name is an upper-case letter, then upper-case letters, digits, or underscores, ending in a letter or a digit, at most 64 characters. A name the platform reserves is refused `manifest_invalid` at its own path. The platform reserves any name under `TURNZERO_`, `APP_`, `HOSTING_`, `EGRESS_`, `ROUTER_`, `NODE_`, or `NPM_`, and `PORT`, `PATH`, `HOME`, `HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`. Store a bound value with `store_secret`, giving the application and each environment; one name may have a development value and a production value. A name at the account scope or at another application's scope is refused `setting_scope_refused`, and a platform-minted name is refused `platform_minted_name`. A name one of your application's upstreams uses is refused `setting_is_upstream_key`, because the gateway applies that key and never gives it to your application. The page /cloud/getting-started/store-a-secret/, which `read_documentation` serves, gives the whole rule for choosing between a setting and `declare_outbound_api`, with its example. A realm's route credential is refused `name_bound_to_realm`, and a push provider's credential `name_bound_to_push`. Each deploy and promote reads a bound value at that environment's scope and injects it as the setting, and injects a plain value as written. Where the name is not stored there, the act is refused `setting_secret_missing`. A rotated value takes effect at the environment's next deploy or promote, and at a `restart_application` where the running copy already has the binding.",
      "type": "object",
      "maxProperties": 50,
      "patternProperties": {
        "^[A-Z](?:[A-Z0-9_]{0,62}[A-Z0-9])?$": {
          "$ref": "#/$defs/binding"
        }
      },
      "additionalProperties": false
    },
    "upstreams": {
      "description": "Optional. The keyed upstreams your application calls through the egress gateway, as an object from each upstream's name to its declaration, at most fifty entries (EGW-L0-02). A declaration takes what `declare_outbound_api` takes but `application`, because the manifest binds each upstream to the application it is submitted for.\n\nAn upstream's name is unique within the account. Each submission records every entry as `declare_outbound_api` records a declaration, effective at once, and each deploy and promote injects its `sdk_settings`. Where `declare_outbound_api` would refuse an entry under a named rule, the submission refuses it `manifest_invalid` at the entry's path, and the violation gives that rule's error. A name another application of your account uses is refused `binding_refused`, and the refusal gives that application. The other errors are `reserved_upstream_name`, `refused_platform_host`, `platform_minted_name`, `upstream_key_is_bound`, `name_bound_to_realm`, `name_bound_to_push`, and `invalid_request`.\n\nA credential name you have not stored yet is accepted. The answer's `upstreams` rows say whether it is stored, and the gateway refuses the upstream's calls `credential_not_in_custody` until `store_secret` stores it. A deploy or promote whose environment reads no stored key for an upstream lists that upstream in its row's `outcome.credentials_missing`.\n\nAn upstream this member lists belongs to the manifest: `declare_outbound_api` refuses a change to it, and its end with `remove: true`, both `manifest_owned_field`. Removing an entry leaves the upstream declared, and `declare_outbound_api` can then revise it; no submission ends an upstream. To end one, remove its entry, submit the manifest, deploy and promote the version that no longer calls it, and call `declare_outbound_api` with `remove: true`. Leave the member out to declare every upstream through `declare_outbound_api`.",
      "type": "object",
      "maxProperties": 50,
      "patternProperties": {
        "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$": {
          "$ref": "#/$defs/upstream"
        }
      },
      "additionalProperties": false
    },
    "realm": {
      "description": "Optional. The sign-in configuration of your application's end-user realms, in the form `configure_app_sign_in` takes (ACS-L0-07). The manifest controls each field the member lists: `sign_in_methods`, `creation`, the `entra` and `apple` members, and each listed environment's native `clients`. The limits, the session days and their cap, and the invitation days stay `configure_app_sign_in`'s, and so do each client's `minimum_version` and `update_url`. Step 4, Configure the realm, of the page /cloud/guides/manage-end-users/, which `read_documentation` serves, has a table of each field's owner. The `entra` and `apple` members give a stored credential's name and never contain its value (ACS-L0-09). The services list must include the `accounts` kind.\n\nEach submission records the member on each end-user realm the application has, effective at once, except `clients`, as its own description says. `create_environment` records it on the development realm it creates. Where `configure_app_sign_in` would refuse a value under a named rule, the submission refuses it `manifest_invalid` at the member's path, and the violation gives that rule's error.\n\nA credential name not stored yet at an environment's scope is accepted. The answer's `detail` lists each credential not stored yet, with the environment where only one lacks it. A sign-in method reads the credential once `store_secret` stores it and you submit the manifest again, which moves it into the realm's vault. A deploy or promote lists a credential its environment cannot read in its row's `outcome.provider_credentials_missing`.\n\n`configure_app_sign_in` refuses a call that would change a field this member lists, `manifest_owned_field`; a call that repeats the recorded value passes. On a listed environment it refuses a change to the clients the same way, except each client's `minimum_version` and `update_url`. Removing a field leaves its configuration in place, and `configure_app_sign_in` can then change it.",
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "sign_in_methods": {
          "$ref": "#/$defs/realmSignInMethods"
        },
        "creation": {
          "description": "Who may create an account by signing in: `open` or `invited` (ACS-L0-07). Under an `invited` audience, `open` is refused, and the violation gives `creation_contradicts_audience`.",
          "enum": [
            "open",
            "invited"
          ]
        },
        "entra": {
          "$ref": "#/$defs/realmEntra"
        },
        "apple": {
          "$ref": "#/$defs/realmApple"
        },
        "clients": {
          "$ref": "#/$defs/realmClients"
        }
      }
    },
    "websockets": {
      "description": "Optional. Declares that your application accepts WebSocket upgrades, and from which browser origins besides its own hostname (MAN-15; SVC-L0-22). A serverless application's manifest cannot declare this member (FNS-L0-06). The member is an object with at most `origins`, a list of at most ten browser origins. The empty object accepts a page on your application's own hostname and a client outside a browser. A manifest without the member accepts no upgrade: the serving router refuses every upgrade `websockets_not_declared`, and nothing reaches your application. Each origin is exact, in the form a browser's `Origin` header has: the `https` scheme, a lowercase host, and an optional port other than the default 443. It has no path, query, fragment, user information, or wildcard, and no origin repeats an earlier one. The submission refuses a list that breaks a rule by the rule's name, at the entry's own JSON path, before the schema check (MAN-12). Each submission records the member, and the serving router reads it within about 30 seconds, with no redeploy. Both environments read the one declaration, and the plan's `websocket-connections-per-replica` limits its connections (SVC-L0-23).",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "origins": {
          "description": "The browser origins accepted besides your hostname's own, at most ten, each exact and listed once (MAN-15).",
          "type": "array",
          "maxItems": 10,
          "uniqueItems": true,
          "items": {
            "$ref": "#/$defs/websocketOrigin"
          }
        }
      }
    },
    "smoke_paths": {
      "description": "Optional. One to five distinct absolute HTTP paths, each `/` followed by non-whitespace, that a deploy or a promote requests with GET in its `smoke_check` step, after the health gate passes (MAN-18; PLD-L0-63). Each is a path, not a URL, as for `health`, and outside the platform's prefixes `/__account/` and `/__router/` (MAN-05; ADM-L0-01). Without this member, the deploy requests the health path only. List the routes whose crash should stop a deploy or a promote before it switches. A path passes on any status below 500 except 404. A 404, a 5xx answer, or a transport error is requested again every three seconds. A path that has not passed within 30 seconds of the first smoke request fails the act `smoke_path_failed` (PLD-L0-63). List routes that change nothing on GET and respond within ten seconds, because on a promote they run against production's data and secrets.",
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^/[^\\s]*$"
      }
    },
    "application": {
      "description": "Optional. The application this folder deploys to: a lowercase UUID, as `create_application` returns it (MAN-02). It is no admission declaration. The platform checks its form only and does nothing else with it, and the deploy's `manifest_notice` leaves it out of its comparison (PLD-L0-63). A fork deployed to another application changes or removes it.",
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    }
  },
  "$defs": {
    "realmSignInMethods": {
      "description": "The enabled sign-in methods, which replace each realm's set: any of `google`, `github`, `passkey`, `email`, `entra`, and `apple` (ACS-L0-07). Google and GitHub use the platform's registrations; `google`, `github`, `email` and `passkey` need no credential of the developer's. To list `entra` or `apple`, configure that route too, in the `realm` member or with `configure_app_sign_in`.",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "enum": [
          "google",
          "github",
          "passkey",
          "email",
          "entra",
          "apple"
        ]
      }
    },
    "realmEntra": {
      "description": "The work-account sign-in route's configuration: the Entra tenant id as a GUID, the app registration's client id, and the stored name of the client secret, never its value (ACS-L0-09). In the app registration, list the platform's callback as a web redirect URI, exactly as `configure_app_sign_in` and `read_app_sign_in` return it in `callbacks.entra`. It is one address for the platform, the same for both environments, and never the application's hostname.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "tenant",
        "client_id",
        "client_secret_name"
      ],
      "properties": {
        "tenant": {
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
        },
        "client_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,254}$"
        },
        "client_secret_name": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
        }
      }
    },
    "realmApple": {
      "description": "Sign in with Apple's configuration: the Services ID, the team and key identifiers, and the stored name of the signing key, never its value (ACS-L0-09). In the Services ID, list the host of `callbacks.apple` as a domain and that address, exactly, as its return URL, as `configure_app_sign_in` and `read_app_sign_in` return it.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "services_id",
        "team_id",
        "key_id",
        "key_secret_name"
      ],
      "properties": {
        "services_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,254}$"
        },
        "team_id": {
          "type": "string",
          "pattern": "^[A-Z0-9]{10}$"
        },
        "key_id": {
          "type": "string",
          "pattern": "^[A-Z0-9]{10}$"
        },
        "key_secret_name": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
        }
      }
    },
    "realmClients": {
      "description": "Optional. The native apps that sign in through each realm: one list for `development`, `production`, or both (ACS-L0-07; ACS-L0-15). Each list has one to ten clients and replaces that realm's list at each submission. A development list on an application without a development environment is checked now, and `create_environment` declares it later. A listed environment's clients belong to the manifest. There, `configure_app_sign_in` changes only each client's `minimum_version` and `update_url`, which a submission keeps.",
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "development": {
          "type": "array",
          "minItems": 1,
          "maxItems": 10,
          "items": {
            "$ref": "#/$defs/realmClient"
          }
        },
        "production": {
          "type": "array",
          "minItems": 1,
          "maxItems": 10,
          "items": {
            "$ref": "#/$defs/realmClient"
          }
        }
      }
    },
    "realmClient": {
      "description": "One native public client, in the form `configure_app_sign_in` takes, without `minimum_version` and `update_url` (ACS-L0-15). A redirect URI is a reverse-domain custom scheme, an `https` URI on one of your application's own hostnames, or a loopback `http` URI. Any other is refused `invalid_redirect_uri` at its path. A production list may also use the custom domain while the same manifest declares it. A re-created or copied application has new hostnames, so its `https` URIs must use them, or the submission is refused whole, recording nothing. A copy made for another app replaces `client_id` and the platform identities with that app's own.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "client_id",
        "redirect_uris"
      ],
      "properties": {
        "client_id": {
          "type": "string",
          "description": "Its id: letters, digits, dots, underscores, colons, and hyphens."
        },
        "redirect_uris": {
          "type": "array",
          "minItems": 1,
          "maxItems": 20,
          "items": {
            "type": "string"
          },
          "description": "A reverse-domain custom scheme, `https` on the application's own hostnames or, on the production realm, its custom domain, or loopback `http` on `localhost`, `[::1]`, or 127.0.0.0/8; others are refused `invalid_redirect_uri`."
        },
        "ios": {
          "type": "object",
          "required": [
            "bundle_id",
            "team_id"
          ],
          "properties": {
            "bundle_id": {
              "type": "string"
            },
            "team_id": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "description": "Bundle id and ten-character team id."
        },
        "android": {
          "type": "object",
          "required": [
            "package",
            "sha256_cert_fingerprints"
          ],
          "properties": {
            "package": {
              "type": "string"
            },
            "sha256_cert_fingerprints": {
              "type": "array",
              "minItems": 1,
              "maxItems": 10,
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false,
          "description": "Package name and SHA-256 signing-certificate fingerprints: 32 upper-case hex pairs joined by colons."
        },
        "google_client_ids": {
          "type": "array",
          "maxItems": 10,
          "items": {
            "type": "string"
          },
          "description": "The Google ID token audiences for this app."
        }
      }
    },
    "pushApns": {
      "description": "Apple's push provider: the team and key identifiers, the app's bundle identifier, and the stored name of the signing key (PSH-L0-01). The gateway is not set here, because it differs by environment.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "team_id",
        "key_id",
        "bundle_id",
        "key_secret_name"
      ],
      "properties": {
        "team_id": {
          "type": "string",
          "pattern": "^[A-Z0-9]{10}$"
        },
        "key_id": {
          "type": "string",
          "pattern": "^[A-Z0-9]{10}$"
        },
        "bundle_id": {
          "type": "string",
          "pattern": "^[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)+$",
          "maxLength": 255
        },
        "key_secret_name": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
        }
      }
    },
    "pushFcm": {
      "description": "Google's push provider: the Firebase project identifier and the stored name of the service-account file (PSH-L0-01).",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "project_id",
        "service_account_secret_name"
      ],
      "properties": {
        "project_id": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9-]{4,29}$"
        },
        "service_account_secret_name": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
        }
      }
    },
    "slug": {
      "description": "A name in this form: a lowercase letter first, then lowercase letters, digits, or underscores, with no hyphen, of at most 64 characters. The pattern is `^[a-z][a-z0-9_]*$`, so `hourly_heartbeat` passes and `hourly-heartbeat` is refused.",
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]*$",
      "maxLength": 64
    },
    "hostname": {
      "type": "string",
      "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
    },
    "customDomainHostname": {
      "description": "One lowercase hostname of at least three labels, so `app.example.com` passes and `example.com` is refused here (SVC-L0-25). The schema checks only this minimum; the submission applies the apex rule and the other hostname rules.",
      "type": "string",
      "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.){2,}[a-z]{2,63}$"
    },
    "egressEntry": {
      "description": "One egress entry: an exact lowercase hostname, or a host family, which is one leading wildcard label and then a hostname of at least two labels (MAN-09). So `*.example.com` passes, and `*.com`, `*.*.example.com`, and a wildcard anywhere but first are refused.",
      "type": "string",
      "pattern": "^(?=.{1,253}$)(\\*\\.)?([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
    },
    "cron": {
      "description": "Five cron fields, evaluated in UTC, each made of digits, `*`, `,`, `/`, and `-` (MAN-03). The submission refuses a field out of range. Where neither day field is a lone `*`, the schedule runs on a day the month field admits that matches either one (SCH-L0-01).",
      "type": "string",
      "pattern": "^([0-9*,/-]+)\\s+([0-9*,/-]+)\\s+([0-9*,/-]+)\\s+([0-9*,/-]+)\\s+([0-9*,/-]+)$"
    },
    "binding": {
      "description": "One setting, exactly one of two forms (MAN-14). `{\"secret\": \"<stored name>\"}` binds the stored name whose value the setting receives: a letter or digit, then letters, digits, hyphens, or underscores, at most 64 characters, the form of every stored name (SCRT-L0-01). `{\"value\": \"<text>\"}` gives a plain value: at most 4,096 characters, empty allowed, with no control character.",
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "secret"
          ],
          "properties": {
            "secret": {
              "type": "string",
              "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "value"
          ],
          "properties": {
            "value": {
              "type": "string",
              "maxLength": 4096,
              "pattern": "^[^\\u0000-\\u001F\\u007F]*$"
            }
          }
        }
      ]
    },
    "sessionFreePaths": {
      "description": "The paths the serving router lets through with no end-user session under the `invited` or `workforce` audience, so a provider's callback, such as a payment webhook, reaches your application (MAN-10; ADM-L0-05). List at most ten path prefixes. Each starts with `/`, is never `/` alone, and has no whitespace and no `..`. Each is outside the platform's own prefixes, `/__account/` and `/__router/`, in any letter case. A prefix covers the path equal to it and every path below it, segment by segment. Your application checks each such caller itself, for example by the provider's signature. The `public` audience has no such list.",
      "type": "array",
      "maxItems": 10,
      "items": {
        "type": "string",
        "pattern": "^/(?!__[aA][cC][cC][oO][uU][nN][tT](/|$))(?!__[rR][oO][uU][tT][eE][rR](/|$))(?!.*\\.\\.)[^\\s]+$"
      }
    },
    "upstream": {
      "description": "One upstream's declaration: the members `declare_outbound_api` takes, except `name`, which is the entry's key, and `application` (EGW-L0-01).",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "base_url",
        "credential_name",
        "auth_header"
      ],
      "properties": {
        "base_url": {
          "description": "The upstream's base URL, a public `https://` address only. A platform host is refused `refused_platform_host`.",
          "type": "string",
          "minLength": 9,
          "maxLength": 2000
        },
        "credential_name": {
          "description": "The stored name of the upstream's key. Store it with `store_secret` at one of your application's environment scopes, or at the account scope.",
          "type": "string",
          "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$"
        },
        "auth_header": {
          "description": "The HTTP header the gateway sends the key in, such as `Authorization` or `x-api-key`.",
          "type": "string",
          "pattern": "^[a-zA-Z0-9-]{1,64}$"
        },
        "auth_format": {
          "description": "The header value around the key, with `{value}` in place of the key, such as `Bearer {value}`. Without this member, the header value is the key alone.",
          "type": "string",
          "minLength": 7,
          "maxLength": 200
        },
        "token_shape": {
          "description": "How token counts are read from the upstream's responses: `gemini` or `anthropic`. Leave it out for an upstream that reports none.",
          "enum": [
            "gemini",
            "anthropic"
          ]
        },
        "sdk_settings": {
          "$ref": "#/$defs/upstreamSettings"
        },
        "settings": {
          "description": "Deprecated: the former name of `sdk_settings`, still accepted in its place. Use `sdk_settings` instead. An entry with both is refused `manifest_invalid` at this member, and the violation gives `invalid_request`.",
          "$ref": "#/$defs/upstreamSettings"
        }
      }
    },
    "upstreamSettings": {
      "description": "The settings an unchanged client of the upstream reads in your deployed container (EGW-L0-01). The setting named in `base_url` receives the gateway's address for the upstream, ending with `base_path` where given. The setting named in `key` receives an egress key, which the gateway reads from `Authorization: Bearer` alone, whatever the upstream's `auth_header`, and swaps for the stored key. Without this member, no setting is injected for the upstream.",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "base_url"
      ],
      "properties": {
        "base_url": {
          "type": "string",
          "pattern": "^[A-Z](?:[A-Z0-9_]{0,62}[A-Z0-9])?$"
        },
        "key": {
          "type": "string",
          "pattern": "^[A-Z](?:[A-Z0-9_]{0,62}[A-Z0-9])?$"
        },
        "base_path": {
          "type": "string",
          "pattern": "^(/[A-Za-z0-9._~%-]+)+$",
          "maxLength": 200
        }
      }
    },
    "space_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "A space's identifier at the issue-tracking service, a lower-case UUID."
    },
    "websocketOrigin": {
      "description": "One browser origin of a WebSocket declaration, in the form a browser's `Origin` header has (MAN-15). It is `https://`, then a lowercase host of letters, digits, hyphens, and dots, then an optional port from 1 to 65535 other than the default 443. A host label has at most 63 characters and the host at most 253. So `https://app.example.com` and `https://app.example.com:8443` pass. A path, a trailing slash, a query, a wildcard, user information, an upper-case letter, another scheme, and `:443` are refused.",
      "type": "string",
      "pattern": "^https://(?=[a-z0-9.-]{1,253}(?::|$))[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*(?::(?!443$)(?:[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$"
    }
  }
}

```
