{"components":{"headers":{"RateLimit-Limit":{"description":"Requests this API key may make per window.","schema":{"format":"uint64","minimum":0,"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"format":"uint64","minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"format":"uint64","minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"format":"uint64","minimum":0,"type":"integer"}}},"responses":{"AddressRateLimited":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Error"}}},"description":"Too many requests from this client address (code `rate_limited`); retry after `Retry-After` seconds.","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"RateLimited":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Error"}}},"description":"This API key spent its request budget for the current window (code `rate_limited`); retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}}},"schemas":{"AppEgressResponse":{"description":"An app's outbound settings.","properties":{"effective_mode":{"description":"The mode in force: `mode`, or else `inherited_mode`.","type":"string"},"inherited_mode":{"description":"The project's mode, used while `mode` is `null`.","type":"string"},"inherited_rules":{"description":"The project's rules, which also apply to the app.","items":{"$ref":"#/components/schemas/RuleResponse"},"type":"array"},"mode":{"description":"`null` follows the project.","type":["string","null"]},"rules":{"description":"The app's own allowlist rules.","items":{"$ref":"#/components/schemas/RuleResponse"},"type":"array"}},"required":["inherited_mode","effective_mode","rules","inherited_rules"],"type":"object"},"AppStatus":{"description":"The derived app status.","properties":{"desired":{"description":"Desired pods, when known.","format":"int32","type":["integer","null"]},"detail":{"description":"A human detail (scheduler message, deploy error).","type":["string","null"]},"kind":{"allOf":[{"$ref":"#/components/schemas/AppStatusKind"}],"description":"What the app is doing."},"ready":{"description":"Ready pods, when observed.","format":"int32","type":["integer","null"]},"reason":{"description":"A short machine reason, e.g. `FailedScheduling`, `CrashLoopBackOff`,\n `ImagePullBackOff`, `OOMKilled`.","type":["string","null"]}},"required":["kind"],"type":"object"},"AppStatusKind":{"description":"What the app is doing, for display.","oneOf":[{"const":"pending","description":"Created, never deployed.","type":"string"},{"const":"setup","description":"A subtensor archive waiting for its seed source (SUBBACKUP setup).","type":"string"},{"const":"building","description":"A build runs.","type":"string"},{"const":"deploying","description":"A rollout runs.","type":"string"},{"const":"starting","description":"Deployed, pods are coming up and none is ready yet.","type":"string"},{"const":"running","description":"At least one pod is ready and no rollout failed.","type":"string"},{"const":"running_previous","description":"The latest deploy failed but pods of the previous version still serve.","type":"string"},{"const":"failed","description":"Nothing is ready and something failed (see `reason`).","type":"string"},{"const":"scaled_to_zero","description":"Scaled to zero on purpose (KEDA idle): not a failure.","type":"string"},{"const":"stopping","description":"Stopping.","type":"string"},{"const":"stopped","description":"Stopped by the user.","type":"string"},{"const":"deleting","description":"Being deleted.","type":"string"}]},"AuditOut":{"description":"One audit event: a control change or a data-plane call.","properties":{"actor_name":{"description":"The actor's name (user name or email, API key name); null when gone.","type":["string","null"]},"created_at":{"description":"When the event happened.","format":"date-time","type":"string"},"error_code":{"description":"The error code of a failed data call.","type":["string","null"]},"event":{"description":"The body: `op`, `actor` (`user:<id>` / `apikey:<id>`), `key`; data\n calls add `version`, `context`, `plaintext_len`, `ciphertext_len` and\n `counted`. Never a payload."},"id":{"description":"The event id; higher ids are newer.","format":"int64","type":"integer"},"result":{"description":"`ok` or `error`.","type":"string"}},"required":["id","event","created_at","result"],"type":"object"},"AuditQuery":{"description":"Audit event filters.","properties":{"actor":{"description":"Only events of this actor: `user:<id>`, `apikey:<id>` or\n `system:<name>` (`system:kms-scheduler` and `system:kms-sweeper` are\n the scheduled rotations and destroys).","type":["string","null"]},"cursor":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"key":{"description":"Only events of this key id.","type":["string","null"]},"limit":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"op":{"description":"Only this operation, such as `key.rotate` or `decrypt`.","type":["string","null"]},"since":{"description":"Only events at or after this time.","format":"date-time","type":["string","null"]},"until":{"description":"Only events before this time.","format":"date-time","type":["string","null"]}},"type":"object"},"BackupRunInfo":{"description":"The last recorded backup run, for the app or for one target.\n\n Without it \"backups are on\" was the only thing the platform could say:\n a CronJob whose pod never started looked exactly like a healthy schedule.","properties":{"error":{"description":"Failure message when it failed.","type":["string","null"]},"finished_at":{"description":"When it ended, while running `null`.","format":"date-time","type":["string","null"]},"kind":{"description":"`backup` or `mirror`.","type":"string"},"started_at":{"description":"When it started.","format":"date-time","type":"string"},"status":{"description":"`running`, `succeeded` or `failed`.","type":"string"},"storage_id":{"description":"Target the run wrote to, when it is still known.","format":"uuid","type":["string","null"]},"trigger":{"description":"`manual` or `scheduled`.","type":"string"}},"required":["kind","trigger","status","started_at"],"type":"object"},"BlockedDestinationResponse":{"description":"A destination the app's egress policy recently blocked.","properties":{"count":{"description":"Logged blocks in the last 24 hours (at most one per destination per\n 5 minutes per node).","format":"uint64","minimum":0,"type":"integer"},"fqdn":{"description":"DNS name the app looked up for `ip`, when known.","type":["string","null"]},"ip":{"description":"Destination IP address.","type":"string"},"last_seen":{"description":"Last logged block.","format":"date-time","type":"string"},"port":{"description":"Destination port.","format":"uint16","maximum":65535,"minimum":0,"type":"integer"},"protocol":{"description":"`tcp` or `udp`.","type":"string"}},"required":["ip","port","protocol","last_seen","count"],"type":"object"},"BlockedEgressResponse":{"description":"The app's recently blocked destinations, most recent first.","properties":{"destinations":{"description":"At most 20, from the last 24 hours.","items":{"$ref":"#/components/schemas/BlockedDestinationResponse"},"type":"array"}},"required":["destinations"],"type":"object"},"ContentNegotiation":{"description":"The `http.content_negotiation` settings.","properties":{"enabled":{"default":false,"description":"Answer `Accept`-preferred twins of extensionless pages (default off).","type":"boolean"},"markdown_tokens":{"default":true,"description":"Send `x-markdown-tokens` (a token estimate made at deploy) on\n Markdown twins (default on).","type":"boolean"},"types":{"default":["markdown","json","yaml","text"],"description":"The types served (default all of them).","items":{"$ref":"#/components/schemas/NegotiationType"},"type":"array"}},"type":"object"},"Coop":{"description":"Cross-Origin-Opener-Policy.","oneOf":[{"const":"off","description":"No COOP header.","type":"string"},{"const":"same_origin_allow_popups","description":"`same-origin-allow-popups`: keeps OAuth and payment popups working.","type":"string"},{"const":"same_origin","description":"`same-origin`: full isolation from cross-origin windows.","type":"string"}]},"CreateKey":{"additionalProperties":false,"description":"Create a key.","properties":{"labels":{"description":"Free-form `key: value` labels."},"name":{"description":"The key name (unique per ring).","type":"string"},"purpose":{"description":"Always `encrypt_decrypt`.","type":["string","null"]},"rotation_period":{"description":"Automatic rotation period such as `90d` (at least `1d`).","type":["string","null"]}},"required":["name"],"type":"object"},"CreateRing":{"additionalProperties":false,"description":"Create a key ring.","properties":{"name":{"description":"The ring name (unique per organization).","type":"string"}},"required":["name"],"type":"object"},"CspMode":{"description":"Whether the CSP is sent, and under which header.","oneOf":[{"const":"off","description":"No CSP header.","type":"string"},{"const":"report_only","description":"`Content-Security-Policy-Report-Only`: violations are reported, nothing is blocked.","type":"string"},{"const":"enforce","description":"`Content-Security-Policy`: violations are blocked.","type":"string"}]},"CspPreset":{"description":"Which CSP policy is sent.","oneOf":[{"const":"basic","description":"[`CSP_BASIC`].","type":"string"},{"const":"strict","description":"[`CSP_STRICT`].","type":"string"},{"const":"custom","description":"The app's own `csp_policy`.","type":"string"}]},"CsrfMode":{"description":"Whether cross-site browser writes are refused.","oneOf":[{"const":"off","description":"No check: every request reaches the app.","type":"string"},{"const":"report_only","description":"Requests that would be refused reach the app marked `X-Aline-Csrf: would-block`.","type":"string"},{"const":"enforce","description":"Cross-site browser writes get a plain 403.","type":"string"}]},"DataKeyBody":{"additionalProperties":false,"description":"Generate a data key.","properties":{"bytes":{"description":"Key size in bytes; only 32 is supported.","format":"uint32","minimum":0,"type":["integer","null"]},"context":{"additionalProperties":{"type":"string"},"description":"Additional authenticated data, bound to the wrapped key.","type":["object","null"]}},"type":"object"},"DataKeyOut":{"description":"A data key and its wrapped copy.","properties":{"key_version":{"description":"The key version that wrapped it.","format":"uint32","minimum":0,"type":"integer"},"plaintext_key":{"description":"Base64 data key; use it locally and never store it.","type":"string"},"wrapped_key":{"description":"Base64 data key wrapped by this key; store it next to the data.","type":"string"}},"required":["plaintext_key","wrapped_key","key_version"],"type":"object"},"DecryptBody":{"additionalProperties":false,"description":"Decrypt a ciphertext.","properties":{"ciphertext":{"description":"Base64 ciphertext from an encrypt call.","type":"string"},"context":{"additionalProperties":{"type":"string"},"description":"The additional authenticated data the ciphertext was bound to; must match.","type":["object","null"]}},"required":["ciphertext"],"type":"object"},"DecryptOut":{"description":"The plaintext of a decrypt call.","properties":{"key_version":{"description":"The key version that decrypted it.","format":"uint32","minimum":0,"type":"integer"},"plaintext":{"description":"Base64 plaintext.","type":"string"}},"required":["plaintext","key_version"],"type":"object"},"DependencyCreate":{"additionalProperties":false,"description":"The new service app of a `create` dependency.","properties":{"instances":{"description":"Its instances (default 1).","format":"int32","type":["integer","null"]},"name":{"description":"Its name (default `<app>-<dependency>`).","type":["string","null"]},"storage_class":{"description":"Its storage class (default the cluster's).","type":["string","null"]},"storage_size":{"description":"Its storage size, e.g. `10Gi` (default the template's).","type":["string","null"]},"version":{"description":"Its version (default the highest the dependency allows).","type":["string","null"]}},"type":"object"},"DependencyMode":{"description":"How a dependency is met.","oneOf":[{"const":"create","description":"Create a new service app for it.","type":"string"},{"const":"existing","description":"Use an existing service app of the same project.","type":"string"},{"const":"none","description":"Leave an optional dependency out.","type":"string"}]},"DependencyRequest":{"additionalProperties":false,"description":"One dependency of the template, as the create request meets it.","properties":{"confirm_admin":{"description":"Keep `admin` on a database that already exists (else `readwrite`).","type":"boolean"},"create":{"anyOf":[{"$ref":"#/components/schemas/DependencyCreate"},{"type":"null"}],"description":"`create`: the new service app's settings."},"database":{"description":"Postgres: the logical database (default the template's, else the\n app name); a new one is created when missing.","type":["string","null"]},"existing_app_id":{"description":"`existing`: the service app (same project).","format":"uuid","type":["string","null"]},"mode":{"allOf":[{"$ref":"#/components/schemas/DependencyMode"}],"description":"Create, use existing, or leave out."},"name":{"description":"The template dependency's `name`.","type":"string"},"role":{"description":"The role preset (default the template's).","type":["string","null"]}},"required":["name","mode"],"type":"object"},"DestroyBody":{"additionalProperties":false,"description":"Schedule destruction after a delay.","properties":{"delay":{"description":"Delay such as `7d`, between `1d` and `30d`; default `7d`.","type":["string","null"]}},"type":"object"},"EncryptBody":{"additionalProperties":false,"description":"Encrypt up to 64 KiB.","properties":{"context":{"additionalProperties":{"type":"string"},"description":"Additional authenticated data, bound to the ciphertext.","type":["object","null"]},"plaintext":{"description":"Base64 plaintext.","type":"string"}},"required":["plaintext"],"type":"object"},"EncryptOut":{"description":"The ciphertext of an encrypt call.","properties":{"algorithm":{"description":"Always `aes256_gcm`.","type":"string"},"ciphertext":{"description":"Base64 ciphertext; pass it to decrypt as is.","type":"string"},"key_version":{"description":"The key version that encrypted it.","format":"uint32","minimum":0,"type":"integer"}},"required":["ciphertext","key_version","algorithm"],"type":"object"},"EstimatedCost":{"description":"Keys charges for a month, in credits (4 decimals).","properties":{"month_to_date":{"description":"Charged so far for the month's closed hours.","type":"string"},"prices":{"allOf":[{"$ref":"#/components/schemas/KeyPrices"}],"description":"The prices in force now."},"projected_month":{"description":"The whole month at the current pace; a past month shows what it cost.","type":"string"}},"required":["month_to_date","projected_month","prices"],"type":"object"},"Grant":{"properties":{"api_key_id":{"description":"The API key the grant gives the permission to.","format":"uuid","type":"string"},"created_at":{"description":"When the grant was created.","format":"date-time","type":"string"},"id":{"description":"The grant id.","format":"uuid","type":"string"},"key_id":{"description":"The key it covers; null for a ring-wide grant.","format":"uuid","type":["string","null"]},"permission":{"description":"`encrypt`, `decrypt`, `generate_data_key` or `admin`.","type":"string"},"ring_id":{"description":"The ring it covers; null for a single-key grant.","format":"uuid","type":["string","null"]}},"required":["id","api_key_id","permission","created_at"],"type":"object"},"HeaderDto":{"description":"One custom response header.","properties":{"name":{"description":"Header name: 1-64 letters, digits or `-`.","type":"string"},"value":{"description":"Header value: up to 1024 visible ASCII characters, spaces and tabs.","type":"string"}},"required":["name","value"],"type":"object"},"HealthResponse":{"description":"Response body for health and readiness checks.","properties":{"status":{"description":"\"ok\" if the service is healthy/ready.","type":"string"},"version":{"description":"Service version (from Cargo.toml).","type":"string"}},"required":["status","version"],"type":"object"},"HttpSettingsResponse":{"description":"An app's HTTP settings.","properties":{"compression":{"description":"Compress responses (zstd, br or gzip, as the client accepts).","type":"boolean"},"content_negotiation":{"allOf":[{"$ref":"#/components/schemas/ContentNegotiation"}],"description":"Static sites: answer extensionless pages with their Markdown, JSON,\n YAML or text twin when `Accept` prefers it over HTML."},"coop":{"allOf":[{"$ref":"#/components/schemas/Coop"}],"description":"Cross-Origin-Opener-Policy."},"csp_mode":{"allOf":[{"$ref":"#/components/schemas/CspMode"}],"description":"Content-Security-Policy: off, report only or enforced."},"csp_policy":{"description":"The custom CSP (used with preset `custom`).","type":["string","null"]},"csp_preset":{"allOf":[{"$ref":"#/components/schemas/CspPreset"}],"description":"Which CSP is sent: the basic or strict preset, or `csp_policy`."},"csp_report_uri":{"description":"HTTPS URL appended to the CSP as `report-uri`.","type":["string","null"]},"csrf_exempt_paths":{"description":"Path prefixes that skip the check (webhooks, SAML ACS).","items":{"type":"string"},"type":"array"},"csrf_mode":{"allOf":[{"$ref":"#/components/schemas/CsrfMode"}],"description":"Cross-site request protection: off, report only (marks requests\n `X-Aline-Csrf: would-block`) or enforced (plain 403)."},"csrf_trusted_origins":{"description":"Exact origins whose browser writes are always let through.","items":{"type":"string"},"type":"array"},"custom_headers":{"description":"Extra response headers, at most 32.","items":{"$ref":"#/components/schemas/HeaderDto"},"type":"array"},"header_frame_options":{"description":"`X-Frame-Options: SAMEORIGIN`.","type":"boolean"},"header_nosniff":{"description":"`X-Content-Type-Options: nosniff`.","type":"boolean"},"header_referrer_policy":{"description":"`Referrer-Policy: strict-origin-when-cross-origin`.","type":"boolean"},"hsts":{"description":"Send `Strict-Transport-Security` on HTTPS responses.","type":"boolean"},"hsts_include_subdomains":{"description":"Add `includeSubDomains` to the HSTS header.","type":"boolean"},"hsts_max_age":{"description":"HSTS `max-age` in seconds.","format":"int64","type":"integer"},"https_redirect":{"description":"Redirect plain HTTP to HTTPS once a certificate is issued.","type":"boolean"},"max_body_bytes":{"description":"Largest accepted request body in bytes; `null` for no limit.","format":"int64","type":["integer","null"]},"permissions_policy":{"allOf":[{"$ref":"#/components/schemas/PermissionsPolicyMode"}],"description":"Permissions-Policy: off, a preset or `permissions_policy_custom`."},"permissions_policy_custom":{"description":"The custom Permissions-Policy (used with mode `custom`).","type":["string","null"]},"www_redirect":{"allOf":[{"$ref":"#/components/schemas/WwwRedirectMode"}],"description":"Redirect between a host and its `www.` form."}},"required":["compression","https_redirect","www_redirect","hsts","hsts_max_age","hsts_include_subdomains","header_nosniff","header_referrer_policy","header_frame_options","custom_headers","csp_mode","csp_preset","permissions_policy","coop","csrf_mode","csrf_trusted_origins","csrf_exempt_paths","content_negotiation"],"type":"object"},"KeyCostOut":{"description":"One key's charges for a month, in credits (4 decimals). The free\n operations are the organization's and are not split per key, so this is\n before them.","properties":{"month_to_date":{"description":"Stored versions plus operations in the month so far.","type":"string"},"prices":{"allOf":[{"$ref":"#/components/schemas/KeyPrices"}],"description":"The prices in force now."}},"required":["month_to_date","prices"],"type":"object"},"KeyDestroyOut":{"description":"A key just scheduled for destruction, with the versions that go.","properties":{"algorithm":{"description":"Always `aes256_gcm`.","type":"string"},"allow_destroy":{"description":"Whether API keys with the `admin` permission may schedule and cancel\n destruction. Only an org admin sets it, in the console.","type":"boolean"},"created_at":{"description":"When the key was created.","format":"date-time","type":"string"},"destroy_at":{"description":"When the whole key is scheduled for destruction, the time it goes.","format":"date-time","type":["string","null"]},"id":{"description":"The key id.","format":"uuid","type":"string"},"labels":true,"name":{"description":"The key name (unique per ring).","type":"string"},"next_rotation_at":{"description":"When the next automatic rotation runs; null when rotation is manual.","format":"date-time","type":["string","null"]},"primary_version":{"description":"The version new encryptions use; null when the version state could not\n be read, like `state_summary`.","format":"uint32","minimum":0,"type":["integer","null"]},"protection_level":{"description":"Always `software`.","type":"string"},"purpose":{"description":"Always `encrypt_decrypt`.","type":"string"},"ring":{"description":"The ring name.","type":"string"},"rotation_period":{"description":"Automatic rotation period such as `90d`; null when rotation is manual.","type":["string","null"]},"state_summary":{"additionalProperties":{"format":"uint32","minimum":0,"type":"integer"},"description":"Number of versions per state.","type":["object","null"]},"versions":{"description":"Every version now scheduled for destruction, oldest first.","items":{"$ref":"#/components/schemas/VersionOut"},"type":"array"}},"required":["id","name","ring","purpose","algorithm","protection_level","labels","created_at","allow_destroy","versions"],"type":"object"},"KeyOut":{"description":"A key.","properties":{"algorithm":{"description":"Always `aes256_gcm`.","type":"string"},"allow_destroy":{"description":"Whether API keys with the `admin` permission may schedule and cancel\n destruction. Only an org admin sets it, in the console.","type":"boolean"},"created_at":{"description":"When the key was created.","format":"date-time","type":"string"},"destroy_at":{"description":"When the whole key is scheduled for destruction, the time it goes.","format":"date-time","type":["string","null"]},"id":{"description":"The key id.","format":"uuid","type":"string"},"labels":true,"name":{"description":"The key name (unique per ring).","type":"string"},"next_rotation_at":{"description":"When the next automatic rotation runs; null when rotation is manual.","format":"date-time","type":["string","null"]},"primary_version":{"description":"The version new encryptions use; null when the version state could not\n be read, like `state_summary`.","format":"uint32","minimum":0,"type":["integer","null"]},"protection_level":{"description":"Always `software`.","type":"string"},"purpose":{"description":"Always `encrypt_decrypt`.","type":"string"},"ring":{"description":"The ring name.","type":"string"},"rotation_period":{"description":"Automatic rotation period such as `90d`; null when rotation is manual.","type":["string","null"]},"state_summary":{"additionalProperties":{"format":"uint32","minimum":0,"type":"integer"},"description":"Number of versions per state.","type":["object","null"]}},"required":["id","name","ring","purpose","algorithm","protection_level","labels","created_at","allow_destroy"],"type":"object"},"KeyPrices":{"description":"Keys prices and monthly free allowance. Key storage is priced like\n secrets; data-plane operations per 10 000 after the free ones.","properties":{"free_ops_month":{"description":"Operations free per organization per month.","format":"int64","type":"integer"},"key_version_month":{"description":"Credits per stored key version per month, billed per hour; \"0\" when\n versions carry no charge of their own.","type":"string"},"ops_10k":{"description":"Credits per 10 000 operations.","type":"string"},"storage_kb_hour":{"description":"Credits per KB-hour of stored key versions (each at least 1 KB), the\n secret storage price.","type":"string"}},"required":["storage_kb_hour","ops_10k","free_ops_month","key_version_month"],"type":"object"},"KeyQuery":{"description":"List query for keys.","properties":{"cursor":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"label":{"description":"Only keys with this label, as `name:value`.","type":["string","null"]},"limit":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]}},"type":"object"},"LastDeploy":{"description":"The latest deploy attempt of an app.","properties":{"at":{"description":"When it finished, or was created while still running.","format":"date-time","type":"string"},"build_id":{"description":"The build behind the deploy.","format":"uuid","type":"string"},"failure_stage":{"description":"Where it failed: `build`, `push` or `rollout`.","type":["string","null"]},"reason":{"description":"Why it failed.","type":["string","null"]},"status":{"description":"The build's status, e.g. `succeeded`, `failed`.","type":"string"}},"required":["build_id","status","at"],"type":"object"},"NegotiationType":{"description":"A representation a page can be negotiated into.","oneOf":[{"const":"markdown","description":"`text/markdown`, from `<page>.md`.","type":"string"},{"const":"json","description":"`application/json`, from `<page>.json`.","type":"string"},{"const":"yaml","description":"`application/yaml` (also `application/x-yaml`, `text/yaml`), from\n `<page>.yaml` then `<page>.yml`.","type":"string"},{"const":"text","description":"`text/plain`, from `<page>.txt`.","type":"string"}]},"PageQuery":{"description":"Query parameters every v1 list accepts.","properties":{"cursor":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"limit":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]}},"type":"object"},"PatchKey":{"additionalProperties":false,"description":"Change a key's rotation period or labels.","properties":{"labels":{"description":"Labels to merge in."},"rotation_period":{"description":"New rotation period such as `90d`.","type":["string","null"]}},"type":"object"},"PermissionsPolicyMode":{"description":"Which Permissions-Policy is sent.","oneOf":[{"const":"off","description":"No Permissions-Policy header.","type":"string"},{"const":"basic","description":"[`PERMISSIONS_BASIC`].","type":"string"},{"const":"strict","description":"[`PERMISSIONS_STRICT`].","type":"string"},{"const":"custom","description":"The app's own `permissions_policy_custom`.","type":"string"}]},"ProjectEgressResponse":{"description":"A project's outbound settings.","properties":{"mode":{"description":"`public` (any public address except TCP 25, plus the allowlist) or\n `isolated` (only the allowlist and the platform endpoints).","type":"string"},"rules":{"description":"The project's allowlist, which also applies to every app in it.","items":{"$ref":"#/components/schemas/RuleResponse"},"type":"array"}},"required":["mode","rules"],"type":"object"},"RecordSetKey":{"description":"Which record set to delete.","properties":{"name":{"description":"The owner name.","type":"string"},"type":{"description":"The record type.","type":"string"}},"required":["name","type"],"type":"object"},"RewrapBody":{"additionalProperties":false,"description":"Re-encrypt a wrapped data key under the current primary version (or under\n another key of the same organization).","properties":{"context":{"additionalProperties":{"type":"string"},"description":"The additional authenticated data the data key was wrapped with; must match.","type":["object","null"]},"destination_key":{"description":"Id or name (in the same ring) of the key to wrap under; default: this key.","type":["string","null"]},"wrapped_key":{"description":"Base64 wrapped key from a generate data key or rewrap call.","type":"string"}},"required":["wrapped_key"],"type":"object"},"RewrapOut":{"description":"A re-wrapped data key.","properties":{"key_version":{"description":"The destination key version that wrapped it.","format":"uint32","minimum":0,"type":"integer"},"wrapped_key":{"description":"Base64 data key wrapped by the destination key.","type":"string"}},"required":["wrapped_key","key_version"],"type":"object"},"Ring":{"properties":{"allow_destroy":{"description":"Whether API keys may destroy the versions of every key in this ring.","type":"boolean"},"created_at":{"description":"When the ring was created.","format":"date-time","type":"string"},"id":{"description":"The ring id.","format":"uuid","type":"string"},"name":{"description":"The ring name (unique per organization).","type":"string"}},"required":["id","name","allow_destroy","created_at"],"type":"object"},"RingDetail":{"properties":{"allow_destroy":{"description":"Whether API keys may destroy the versions of every key in this ring.","type":"boolean"},"created_at":{"description":"When the ring was created.","format":"date-time","type":"string"},"id":{"description":"The ring id.","format":"uuid","type":"string"},"key_count":{"description":"Number of keys in the ring.","format":"int64","type":"integer"},"name":{"description":"The ring name (unique per organization).","type":"string"}},"required":["id","name","key_count","allow_destroy","created_at"],"type":"object"},"RuleRequest":{"additionalProperties":false,"description":"A rule as sent.","properties":{"description":{"default":null,"description":"Free text shown next to the rule, at most 200 characters.","type":["string","null"]},"kind":{"description":"`fqdn` or `cidr`.","type":"string"},"port":{"default":null,"description":"1-65535; omit for all ports.","format":"int64","type":["integer","null"]},"protocol":{"default":null,"description":"`tcp` or `udp`; omit for both.","type":["string","null"]},"value":{"description":"Domain (`api.example.com`, `*.example.com`) or CIDR / bare IP.","type":"string"}},"required":["kind","value"],"type":"object"},"RuleResponse":{"description":"A stored rule.","properties":{"description":{"description":"Free text set with the rule.","type":["string","null"]},"id":{"description":"The rule's id.","format":"uuid","type":"string"},"kind":{"description":"`fqdn` or `cidr`.","type":"string"},"port":{"description":"The allowed port; `null` allows all ports.","format":"int32","type":["integer","null"]},"private":{"description":"The CIDR reaches private or otherwise non-public address space.","type":"boolean"},"protocol":{"description":"`tcp` or `udp`; `null` allows both.","type":["string","null"]},"value":{"description":"Domain or CIDR, as stored.","type":"string"}},"required":["id","kind","value","private"],"type":"object"},"RunProgress":{"description":"Where a manual backup run stands.","properties":{"error":{"description":"The first failure, when it failed.","type":["string","null"]},"run_id":{"description":"The run, as returned when it was requested.","format":"uuid","type":"string"},"runs":{"description":"One row per object and target the run wrote to.","items":{"$ref":"#/components/schemas/BackupRunInfo"},"type":"array"},"status":{"description":"`pending` (nothing recorded yet), `running`, `succeeded` or `failed`.","type":"string"}},"required":["run_id","status","runs"],"type":"object"},"SetPrimary":{"additionalProperties":false,"description":"Make a version the primary one.","properties":{"version":{"description":"The version number.","format":"uint32","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"SubjectSaltOut":{"description":"The organization's subject-key salt.","properties":{"salt":{"description":"32 random bytes, standard base64. Fixed for the organization's\n lifetime: SDKs derive subject key names as HMAC-SHA256(salt, subject).","type":"string"}},"required":["salt"],"type":"object"},"UnwrapBody":{"additionalProperties":false,"description":"Unwrap a data key.","properties":{"context":{"additionalProperties":{"type":"string"},"description":"The additional authenticated data the data key was wrapped with; must match.","type":["object","null"]},"wrapped_key":{"description":"Base64 wrapped key from a generate data key or rewrap call.","type":"string"}},"required":["wrapped_key"],"type":"object"},"UnwrapOut":{"description":"An unwrapped data key.","properties":{"key_version":{"description":"The key version that unwrapped it.","format":"uint32","minimum":0,"type":"integer"},"plaintext_key":{"description":"Base64 data key.","type":"string"}},"required":["plaintext_key","key_version"],"type":"object"},"UpdateEgressRequest":{"additionalProperties":false,"description":"The whole new setting of a scope.","properties":{"mode":{"default":null,"description":"`public` or `isolated`. An app may send `null` to follow its project.","type":["string","null"]},"rules":{"description":"Replaces the scope's allowlist.","items":{"$ref":"#/components/schemas/RuleRequest"},"type":"array"}},"type":"object"},"UpdateHttpSettingsRequest":{"additionalProperties":false,"description":"The settings to change; omitted fields keep their value.","properties":{"compression":{"description":"Compress responses.","type":["boolean","null"]},"content_negotiation":{"anyOf":[{"$ref":"#/components/schemas/ContentNegotiation"},{"type":"null"}],"description":"Replaces the content negotiation choice (static sites); omitted\n keys inside take their defaults."},"coop":{"anyOf":[{"$ref":"#/components/schemas/Coop"},{"type":"null"}],"description":"Cross-Origin-Opener-Policy."},"csp_mode":{"anyOf":[{"$ref":"#/components/schemas/CspMode"},{"type":"null"}],"description":"Content-Security-Policy: off, report only or enforced."},"csp_policy":{"default":null,"description":"`null` or blank clears it.","type":["string","null"]},"csp_preset":{"anyOf":[{"$ref":"#/components/schemas/CspPreset"},{"type":"null"}],"description":"Which CSP is sent: the basic or strict preset, or `csp_policy`."},"csp_report_uri":{"default":null,"description":"`null` or blank clears it.","type":["string","null"]},"csrf_exempt_paths":{"description":"Replaces the list: at most 20 path prefixes like `/hooks`, each up to\n 256 characters; `/` is refused.","items":{"type":"string"},"type":["array","null"]},"csrf_mode":{"anyOf":[{"$ref":"#/components/schemas/CsrfMode"},{"type":"null"}],"description":"Cross-site request protection: off, report only or enforced."},"csrf_trusted_origins":{"description":"Replaces the list: at most 20 exact origins like\n `https://www.example.com` (`http://` only when the app serves plain HTTP).","items":{"type":"string"},"type":["array","null"]},"custom_headers":{"description":"Replaces the whole list (at most 32 headers).","items":{"$ref":"#/components/schemas/HeaderDto"},"type":["array","null"]},"header_frame_options":{"description":"`X-Frame-Options: SAMEORIGIN`.","type":["boolean","null"]},"header_nosniff":{"description":"`X-Content-Type-Options: nosniff`.","type":["boolean","null"]},"header_referrer_policy":{"description":"`Referrer-Policy: strict-origin-when-cross-origin`.","type":["boolean","null"]},"hsts":{"description":"Send `Strict-Transport-Security` on HTTPS responses.","type":["boolean","null"]},"hsts_include_subdomains":{"description":"Add `includeSubDomains` to the HSTS header.","type":["boolean","null"]},"hsts_max_age":{"description":"HSTS `max-age` in seconds, 0 to 63072000 (two years).","format":"int64","type":["integer","null"]},"https_redirect":{"description":"Redirect plain HTTP to HTTPS once a certificate is issued.","type":["boolean","null"]},"max_body_bytes":{"default":null,"description":"`null` removes the limit.","format":"int64","type":["integer","null"]},"permissions_policy":{"anyOf":[{"$ref":"#/components/schemas/PermissionsPolicyMode"},{"type":"null"}],"description":"Permissions-Policy: off, a preset or `permissions_policy_custom`."},"permissions_policy_custom":{"default":null,"description":"`null` or blank clears it.","type":["string","null"]},"www_redirect":{"anyOf":[{"$ref":"#/components/schemas/WwwRedirectMode"},{"type":"null"}],"description":"Redirect between a host and its `www.` form."}},"type":"object"},"UsageOut":{"description":"Month usage of one key or all keys.","properties":{"estimated_cost":{"anyOf":[{"$ref":"#/components/schemas/EstimatedCost"},{"type":"null"}],"description":"The organization's month charges and projection; null for one key."},"key_cost":{"anyOf":[{"$ref":"#/components/schemas/KeyCostOut"},{"type":"null"}],"description":"One key's month so far at list price; null for the organization."},"key_versions_hours":{"description":"Stored key versions summed over the month's hours.","format":"int64","type":"integer"},"operations":{"additionalProperties":{"format":"int64","type":"integer"},"description":"Data-plane calls in the month per operation, such as `encrypt`.","type":"object"}},"required":["key_versions_hours","operations"],"type":"object"},"UsageQuery":{"description":"Usage filters.","properties":{"key":{"description":"Only this key id.","type":["string","null"]},"month":{"description":"The month as `YYYY-MM` (default: the current month).","type":["string","null"]}},"type":"object"},"V1AcmeDelegation":{"description":"An app domain's ACME challenge delegation.","properties":{"cname_target":{"description":"The CNAME's target.","type":"string"},"domain_id":{"description":"The organization domain it belongs to.","format":"uuid","type":"string"},"error":{"description":"What the last check found.","type":["string","null"]},"id":{"description":"The delegation's id.","format":"uuid","type":"string"},"last_checked_at":{"description":"When the CNAME was last checked (RFC 3339, UTC).","format":"date-time","type":["string","null"]},"record_name":{"description":"The record name (`_acme-challenge.<domain>`).","type":"string"},"status":{"description":"`verified`, `failed` (see `error`) or `pending`.","type":"string"}},"required":["id","domain_id","record_name","cname_target","status"],"type":"object"},"V1ActionsCache":{"description":"The org cache, as the public API shows it. Sizes in bytes (1 GB = 1e9),\n amounts in EUR.","properties":{"actions_bytes":{"description":"Bytes of `actions/cache` entries.","format":"int64","type":"integer"},"build_cache_bytes":{"description":"Bytes of the BuildKit layer cache of the org's builds.","format":"int64","type":"integer"},"custom_limit":{"description":"The org picked its own limit (otherwise the free amount).","type":"boolean"},"demo":{"description":"A demo organization: a fixed 1 GB limit, never billed.","type":"boolean"},"free_bytes":{"description":"Never billed.","format":"int64","type":"integer"},"limit_bytes":{"description":"What the cache is held to; unused for 7 days or over it, the oldest\n items are removed.","format":"int64","type":"integer"},"limit_monthly_estimate":{"description":"EUR a month with the cache filled to the limit.","type":"string"},"max_bytes":{"description":"The highest limit the org may pick.","format":"int64","type":"integer"},"monthly_estimate":{"description":"EUR a month at the current usage.","type":"string"},"price_per_gb_month":{"description":"EUR per GB-month above the free part; absent when unpriced.","type":["string","null"]},"total_bytes":{"description":"Both together: what the limit holds.","format":"int64","type":"integer"}},"required":["actions_bytes","build_cache_bytes","total_bytes","free_bytes","limit_bytes","max_bytes","custom_limit","demo","monthly_estimate","limit_monthly_estimate"],"type":"object"},"V1ActionsPricing":{"description":"GitHub Actions runners.","properties":{"billing":{"allOf":[{"$ref":"#/components/schemas/V1Billing"}],"description":"How a job's compute is metered."},"cache":{"allOf":[{"$ref":"#/components/schemas/V1CachePricing"}],"description":"The cache quota and its price."},"concurrency_tiers":{"description":"Per-organization caps by paid usage, lowest first.","items":{"$ref":"#/components/schemas/V1ConcurrencyTier"},"type":"array"},"custom_shapes":{"anyOf":[{"$ref":"#/components/schemas/V1CustomShapes"},{"type":"null"}],"description":"Custom shape bounds; `null`: only `sizes` are served."},"disk_add_ons":{"description":"The disk add-ons on offer.","items":{"$ref":"#/components/schemas/V1DiskAddOn"},"type":"array"},"extra_disk_billing":{"allOf":[{"$ref":"#/components/schemas/V1Billing"}],"description":"How the extra disk is metered."},"extra_disk_gb_hour":{"description":"Price per GB-hour of extra local disk (the disk add-ons).","type":"string"},"free_minutes_per_month":{"description":"Free vCPU-minutes per month; `null`: none.","format":"uint32","minimum":0,"type":["integer","null"]},"max_job_minutes":{"description":"The platform-wide cap on one job's billed minutes; `null`: none (an\n organization may set its own limit).","format":"int32","type":["integer","null"]},"memory_included_gb_per_vcpu":{"description":"Memory each vCPU comes with, GB (the price is per vCPU only).","format":"uint32","minimum":0,"type":["integer","null"]},"memory_supplement_gb_minute":{"description":"Price per GB-minute of memory beyond the included part; `null`: no\n memory supplement, memory is fixed per size.","type":["string","null"]},"sizes":{"description":"Every size a label can ask for, smallest first.","items":{"$ref":"#/components/schemas/V1ActionsSize"},"type":"array"},"vcpu_minute":{"description":"Price of one vCPU-minute.","type":"string"}},"required":["vcpu_minute","billing","sizes","extra_disk_gb_hour","extra_disk_billing","disk_add_ons","cache","concurrency_tiers"],"type":"object"},"V1ActionsSize":{"description":"One Actions runner size a `runs-on` label can ask for.","properties":{"arch":{"description":"CPU architectures served.","items":{"type":"string"},"type":"array"},"disk_gb":{"description":"Local disk included in the price, GB.","format":"uint32","minimum":0,"type":"integer"},"label":{"description":"The `runs-on` label (`a-line-2vcpu`).","type":"string"},"memory_gb":{"description":"Memory in GB.","format":"uint32","minimum":0,"type":"integer"},"price_per_minute":{"description":"Price of one minute of a job on this size (vCPUs x the vCPU-minute price).","type":"string"},"vcpu":{"description":"vCPUs.","format":"uint32","minimum":0,"type":"integer"}},"required":["label","vcpu","memory_gb","disk_gb","price_per_minute","arch"],"type":"object"},"V1AddDomain":{"additionalProperties":false,"description":"A domain to add to an app.","properties":{"behind_proxy":{"default":false,"description":"Served through a CDN or reverse proxy (HTTP and HTTPS routes only).\n Ownership is still proven by the TXT verification.","type":"boolean"},"dns_target":{"allOf":[{"$ref":"#/components/schemas/V1DnsTarget"}],"default":"a_records","description":"How DNS points at the cluster (default `a_records`)."},"domain":{"description":"The host name; an organization domain must cover it.","type":"string"},"external_port":{"default":443,"description":"The port the load balancer listens on (default 443).","format":"int32","type":"integer"},"path_prefix":{"default":"/","description":"The path prefix to route (default `/`).","type":"string"},"pending_verification":{"default":false,"description":"Accept a host only a domain still being verified covers; it routes once that verifies.","type":"boolean"},"port":{"description":"The container port to route to.","format":"int32","type":"integer"},"protocol":{"default":"https","description":"`http`, `https` (default), `tcp`, `udp` or `tls` (TLS passthrough by SNI on 443).","type":"string"},"proxy_protocol":{"default":false,"description":"Prefix each connection with a PROXY protocol header carrying the\n client address (TCP only; the app must expect the header).","type":"boolean"},"service_name":{"default":null,"description":"A Kubernetes service to target instead of the app's own.","type":["string","null"]},"strip_prefix":{"default":false,"description":"Strip the prefix before forwarding (default false).","type":"boolean"},"tls_enabled":{"default":true,"description":"Terminate TLS (default true).","type":"boolean"},"wildcard":{"default":false,"description":"Also route every subdomain (HTTP(S) only, needs a whole-domain verification).","type":"boolean"}},"required":["domain","port"],"type":"object"},"V1AddGroupMembers":{"additionalProperties":false,"description":"Secrets to add to a group. Secrets already in it are skipped.","properties":{"secret_ids":{"description":"Ids of secrets this environment may inject (its own or its clusters').","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["secret_ids"],"type":"object"},"V1Amount":{"anyOf":[{"description":"A JSON number.","type":"number"},{"description":"A decimal string.","type":"string"}],"description":"An amount in credits: a number or a decimal string (`\"12.50\"`), at least\n 0."},"V1App":{"description":"An app, as the public API shows it.","properties":{"cluster_id":{"description":"The cluster the app runs on.","format":"uuid","type":"string"},"created_at":{"description":"When the app was created (RFC 3339, UTC).","format":"date-time","type":"string"},"deploy_id":{"description":"The deploy a change started: set only in the response of an update\n that needed a redeploy (poll `GET .../deploys/{id}`), else null.","format":"uuid","type":["string","null"]},"expected_image":{"description":"For a release-pinned app, the image its file names (the repo the\n release roll fills in); null otherwise.","type":["string","null"]},"health_path":{"description":"HTTP health check path.","type":["string","null"]},"id":{"description":"The app id.","format":"uuid","type":"string"},"image":{"description":"The container image it runs; null until a git app's first build.","type":["string","null"]},"image_digest":{"description":"The content digest (`sha256:...`) the app's image is pinned to; null\n for an image given by tag. A deploy of a pinned image is verified\n by this digest once the deploy `succeeded`.","type":["string","null"]},"last_deploy":{"anyOf":[{"$ref":"#/components/schemas/LastDeploy"},{"type":"null"}],"description":"The latest deploy attempt. A failed rollout while the previous\n version serves keeps `state` at `running` and shows here."},"last_deployed_at":{"description":"When the app was last deployed.","format":"date-time","type":["string","null"]},"name":{"description":"The app's name, unique in its project.","type":"string"},"port":{"description":"The main container port.","format":"int32","type":["integer","null"]},"project_id":{"description":"The project the app belongs to.","format":"uuid","type":"string"},"release_pinned":{"description":"The app's linked IaC file pins its image to the release deploy\n (`source: {image, pin: release}`): a release roll sets the image, so\n the app is not deployed by hand.","type":"boolean"},"replicas":{"description":"Desired pods.","format":"int32","type":"integer"},"running_digest":{"description":"The content digest (`sha256:...`) the app's pods were last seen\n running, read from the ready pods' image IDs once a rollout is ready\n (also for an image given by tag). It can differ from `image_digest`:\n a multi-arch pin is the index, the pods run a platform manifest. Null\n before the first ready rollout or when no pod reported a digest.","type":["string","null"]},"serving_build_id":{"description":"The deploy whose image serves traffic; null when none does.","format":"uuid","type":["string","null"]},"state":{"description":"Lifecycle state, e.g. `pending`, `deploying`, `running`, `stopped`,\n `failed`. New states may be added.","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/AppStatus"}],"description":"Whether it actually runs: `state` checked against the live pods\n (ready vs desired) and the last deploy, e.g. `failed` with reason\n `FailedScheduling` when a rollout left nothing ready. New kinds may\n be added."},"template_slug":{"description":"The catalog template the app was created from, if any.","type":["string","null"]}},"required":["id","project_id","cluster_id","name","release_pinned","replicas","state","status","created_at"],"type":"object"},"V1AppDomain":{"description":"A domain routed to an app.","properties":{"acme_delegation":{"anyOf":[{"$ref":"#/components/schemas/V1AcmeDelegation"},{"type":"null"}],"description":"The name's ACME challenge delegation, when it has one: with\n `<record_name> CNAME <cname_target>` in place the certificate is\n issued over DNS-01. The CNAME lets the platform get certificates for\n the name while it exists: delete it once the delegation is removed."},"app_id":{"description":"The app it routes to.","format":"uuid","type":"string"},"behind_proxy":{"description":"Served through a CDN or reverse proxy: the DNS check fetches the\n domain end to end instead of matching load balancer addresses.","type":"boolean"},"client_ip_header":{"description":"The proxy header carrying the client IP, passed to the app only while\n the origin lock is on.","type":["string","null"]},"created_at":{"description":"When the domain was added (RFC 3339, UTC).","format":"date-time","type":"string"},"dns_records":{"description":"The records to create at the customer's DNS provider.","items":{"$ref":"#/components/schemas/V1DnsRecord"},"type":"array"},"dns_target":{"allOf":[{"$ref":"#/components/schemas/V1DnsTarget"}],"description":"How DNS points at the cluster."},"domain":{"description":"The host name.","type":"string"},"external_port":{"description":"The port the load balancer listens on.","format":"int32","type":"integer"},"id":{"description":"The domain id.","format":"uuid","type":"string"},"origin_lock":{"anyOf":[{"$ref":"#/components/schemas/V1OriginLock"},{"type":"null"}],"description":"While behind a proxy: the origin lock (fingerprints only); null when off."},"path_prefix":{"description":"The path prefix routed.","type":"string"},"platform":{"description":"A hostname the platform issued (temporary URL or generated host).","type":"boolean"},"port":{"description":"The container port traffic goes to.","format":"int32","type":"integer"},"protocol":{"description":"`http`, `https`, `tcp`, `udp` or `tls` (TLS passthrough by SNI on 443).","type":"string"},"proxy_protocol":{"description":"A TCP port whose connections start with a PROXY protocol header.","type":"boolean"},"route_error":{"description":"Why routing failed.","type":["string","null"]},"route_state":{"description":"Routing state: `pending`, `live`, `waiting_deploy`, `failed` or `unknown`.","type":"string"},"service_name":{"description":"The Kubernetes service targeted, when not the app's own.","type":["string","null"]},"strip_prefix":{"description":"Whether the prefix is stripped before forwarding.","type":"boolean"},"tls_enabled":{"description":"Whether TLS is terminated for the host.","type":"boolean"},"tls_error":{"description":"Why the certificate failed, or a plain line about a temporary URL's\n pending wildcard.","type":["string","null"]},"tls_expires_at":{"description":"When the certificate expires.","format":"date-time","type":["string","null"]},"tls_reason":{"description":"A temporary URL whose wildcard is pending: cert-manager's reason,\n one line without URLs.","type":["string","null"]},"tls_state":{"description":"Certificate state: `pending`, `issued`, `failed`, `not_applicable` or null.","type":["string","null"]},"verification":{"anyOf":[{"$ref":"#/components/schemas/V1PendingVerification"},{"type":"null"}],"description":"Set while the host waits on an organization domain to verify."},"wildcard":{"description":"Also routes every subdomain (`*.<domain>`).","type":"boolean"}},"required":["id","app_id","domain","port","external_port","path_prefix","strip_prefix","tls_enabled","protocol","wildcard","proxy_protocol","platform","route_state","created_at","dns_target","behind_proxy","dns_records"],"type":"object"},"V1AppLogLine":{"description":"One container log line of an app.","properties":{"container":{"description":"The container that logged it.","type":"string"},"message":{"description":"The line.","type":"string"},"pod":{"description":"The pod that logged it.","type":"string"},"severity":{"description":"The severity detected at ingestion (e.g. `info`, `warn`, `error`).","type":"string"},"timestamp":{"description":"When the line was logged (RFC 3339, UTC, second precision).","format":"date-time","type":"string"}},"required":["timestamp","pod","container","severity","message"],"type":"object"},"V1AppLogsPage":{"description":"A page of an app's log lines, oldest first.","properties":{"data":{"description":"The lines, oldest first.","items":{"$ref":"#/components/schemas/V1AppLogLine"},"type":"array"},"has_more":{"description":"More lines in the range follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` (with the same range) for the next page; null on the last page.","type":["string","null"]},"retained_from":{"description":"Lines older than this were removed (by ingest time, so approximate); null when the app lost none.","format":"date-time","type":["string","null"]},"retained_reason":{"anyOf":[{"$ref":"#/components/schemas/V1LogRetainedReason"},{"type":"null"}],"description":"Why lines before `retained_from` are gone; null with it."}},"required":["data","has_more"],"type":"object"},"V1AppLogsQuery":{"additionalProperties":false,"description":"Query parameters of an app log query.","properties":{"cursor":{"description":"`next_cursor` of the previous page.","type":["string","null"]},"limit":{"description":"Lines per page, 1 to 1000 (default 100).","format":"uint32","minimum":0,"type":["integer","null"]},"pod":{"description":"Only lines of this pod.","type":["string","null"]},"since":{"description":"Start of the range (RFC 3339, inclusive). Default: an hour before `until`.","format":"date-time","type":["string","null"]},"until":{"description":"End of the range (RFC 3339, exclusive). Default: now. Pass it when\n paging, so every page reads the same range. At most 31 days after `since`.","format":"date-time","type":["string","null"]}},"type":"object"},"V1BackupRunQueued":{"description":"A backup run that was queued.","properties":{"run_id":{"description":"Follow it at `GET .../backups/runs/{run_id}`.","format":"uuid","type":"string"}},"required":["run_id"],"type":"object"},"V1Billing":{"description":"How a usage line is metered and rounded, as the billing code does it.","properties":{"rounding":{"description":"How a run is rounded to that unit and the charge to the cent.","type":"string"},"unit":{"allOf":[{"$ref":"#/components/schemas/V1BillingUnit"}],"description":"The unit time is counted in."}},"required":["unit","rounding"],"type":"object"},"V1BillingUnit":{"description":"How a usage line is metered.","oneOf":[{"const":"second","description":"Whole seconds.","type":"string"},{"const":"minute","description":"Whole minutes.","type":"string"},{"const":"hour","description":"Whole hours.","type":"string"}]},"V1BuildLogsPage":{"description":"A page of a build's log lines, in order.","properties":{"complete":{"description":"The build has ended, so its log is final.","type":"boolean"},"data":{"description":"Complete lines, in order. A running build's unfinished last line is held back.","items":{"type":"string"},"type":"array"},"has_more":{"description":"More lines follow, or the build is still running (poll `next_cursor`).","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` for the next page; null once the log is fully read.","type":["string","null"]}},"required":["data","has_more","complete"],"type":"object"},"V1BuildLogsQuery":{"additionalProperties":false,"description":"Query parameters of a build log query.","properties":{"cursor":{"description":"`next_cursor` of the previous page.","type":["string","null"]},"limit":{"description":"Lines per page, 1 to 5000 (default 500).","format":"uint32","minimum":0,"type":["integer","null"]}},"type":"object"},"V1BuildTier":{"description":"One image build size tier.","properties":{"cpu_millis":{"description":"CPU a build reserves, in millicores.","format":"int32","type":"integer"},"id":{"description":"Tier id (`small`, `medium`, ...).","type":"string"},"is_default":{"description":"Whether apps without a choice build with this tier.","type":"boolean"},"label":{"description":"Display name.","type":"string"},"memory_mib":{"description":"Memory a build reserves, in MiB.","format":"int32","type":"integer"},"price_per_minute":{"description":"Price of one build minute of this tier.","type":"string"}},"required":["id","label","cpu_millis","memory_mib","is_default","price_per_minute"],"type":"object"},"V1BuildsPricing":{"description":"Image builds.","properties":{"billing":{"allOf":[{"$ref":"#/components/schemas/V1Billing"}],"description":"How a build is metered."},"tiers":{"description":"Active tiers, smallest first.","items":{"$ref":"#/components/schemas/V1BuildTier"},"type":"array"},"vcpu_minute":{"description":"Price of one vCPU-minute.","type":"string"}},"required":["vcpu_minute","billing","tiers"],"type":"object"},"V1CachePricing":{"description":"The Actions cache (shared with the BuildKit build cache).","properties":{"free_gb":{"description":"GB every organization stores for free.","format":"int64","type":"integer"},"gb_month":{"description":"Price per GB-month above the free part (730 hours a month, metered\n hourly); `null` while no price is set and the cache is not billed.","type":["string","null"]}},"required":["free_gb"],"type":"object"},"V1CapacityWait":{"description":"Servers of one pool waiting for the same reason.","properties":{"alternatives":{"description":"Machine types or locations with stock now (suggestions only).","items":{"type":"string"},"type":"array"},"checked_at":{"description":"When the stock was last checked; `null` before the first check.","format":"date-time","type":["string","null"]},"count":{"description":"How many servers wait.","format":"int64","type":"integer"},"location":{"description":"The provider location waited in.","type":"string"},"next_check_at":{"description":"When the stock is checked again; `null` when no check is scheduled.","format":"date-time","type":["string","null"]},"node_type":{"description":"The machine type waited for.","type":"string"},"pool":{"description":"The pool's name.","type":"string"},"role":{"description":"The pool's role (`control_plane`, `worker`, ...).","type":"string"},"since":{"description":"When the oldest of them started waiting (RFC 3339, UTC).","format":"date-time","type":"string"},"status":{"description":"`waiting_capacity`, `awaiting_delivery`, `blocked_by_control_plane` or `quota_reached`\n (the provider account quota refused the type: raise it or pick another type). New values may appear.","type":"string"}},"required":["pool","role","node_type","location","count","status","since","alternatives"],"type":"object"},"V1Cluster":{"description":"A cluster, as the public API shows it.","properties":{"capacity_wait":{"description":"Servers not created yet, grouped per pool and reason; empty when none wait.","items":{"$ref":"#/components/schemas/V1CapacityWait"},"type":"array"},"created_at":{"description":"When the cluster was created (RFC 3339, UTC).","format":"date-time","type":"string"},"environment_id":{"description":"The environment the cluster belongs to.","format":"uuid","type":"string"},"id":{"description":"The cluster id.","format":"uuid","type":"string"},"name":{"description":"The cluster's name.","type":"string"},"price_confirmation":{"description":"Servers held because the price went above the pool's caps.","items":{"$ref":"#/components/schemas/V1PriceConfirmation"},"type":"array"},"provider":{"description":"The provider (`hetzner`, ...). New values may appear.","type":"string"},"region":{"description":"The provider region.","type":"string"},"state":{"description":"The lifecycle state (`provisioning`, `running`, ...). New values may appear.","type":"string"}},"required":["id","name","region","provider","state","environment_id","created_at","capacity_wait","price_confirmation"],"type":"object"},"V1ClusterNetwork":{"additionalProperties":false,"description":"Custom address ranges of a new cluster, fixed for its life.","properties":{"node_cidr":{"default":null,"description":"Node network, Hetzner only: `10.X.0.0/16` (X 1-255) unused by other\n clusters. Allocated when omitted.","type":["string","null"]},"pod_cidr":{"default":null,"description":"Pod network: a private (RFC 1918) IPv4 CIDR, /12 to /20. Default\n `10.244.0.0/16`.","type":["string","null"]},"service_cidr":{"default":null,"description":"Service network: a private IPv4 CIDR, /12 to /24. Default\n `10.96.0.0/12`.","type":["string","null"]}},"type":"object"},"V1ConcurrencyTier":{"description":"One trust tier of per-organization runner caps: an organization's\n paid usage over the last 12 months decides which sizes it can run at\n once.","properties":{"admin_raisable":{"description":"An admin can raise an organization's caps above its tier on request.","type":"boolean"},"max_jobs":{"description":"Runners at once; `null`: no per-organization cap.","format":"int64","type":["integer","null"]},"max_vcpus":{"description":"vCPUs of those runners at once; `null`: no per-organization cap.","format":"int64","type":["integer","null"]},"min_paid_eur":{"description":"Paid usage over the last 12 months, whole EUR, from which on the tier\n applies.","type":"string"}},"required":["min_paid_eur","admin_raisable"],"type":"object"},"V1CreateApp":{"additionalProperties":false,"description":"An app to create from a container image or a catalog template.","properties":{"dependencies":{"description":"How each dependency of the template is met (a new service app, an\n existing one of the project, or none for an optional one).","items":{"$ref":"#/components/schemas/DependencyRequest"},"type":"array"},"env":{"additionalProperties":{"type":"string"},"default":{},"description":"Environment variables.","type":"object"},"health_path":{"default":null,"description":"HTTP health check path.","type":["string","null"]},"image":{"default":null,"description":"The container image to run. A template app without one gets the\n template's catalog image.","type":["string","null"]},"name":{"description":"The app's name: 1-63 lowercase letters, digits or hyphens, starting\n and ending with a letter or digit. Unique in the project.","type":"string"},"port":{"default":null,"description":"The main container port.","format":"int32","type":["integer","null"]},"project_id":{"description":"The project to create the app in.","format":"uuid","type":"string"},"replicas":{"default":null,"description":"Desired pods, default 1.","format":"int32","type":["integer","null"]},"template_slug":{"default":null,"description":"A catalog template to create the app from.","type":["string","null"]}},"required":["project_id","name"],"type":"object"},"V1CreateCluster":{"additionalProperties":false,"description":"A cluster to create.","properties":{"environment_id":{"description":"The environment the cluster belongs to.","format":"uuid","type":"string"},"load_balancers":{"default":[],"description":"Load balancer type ids for ingress load balancers.","items":{"type":"string"},"type":"array"},"name":{"description":"The cluster's name: 1-64 lowercase letters, digits or hyphens, not\n reserved. Unique in the organization.","type":"string"},"network":{"anyOf":[{"$ref":"#/components/schemas/V1ClusterNetwork"},{"type":"null"}],"default":null,"description":"Custom address ranges; omitted ranges take the defaults."},"pools":{"description":"The node pools; one must have the `control_plane` role.","items":{"$ref":"#/components/schemas/V1NewPool"},"type":"array"},"provider":{"description":"The provider (`hetzner`, ...).","type":"string"},"region":{"description":"The provider region (`fsn1`, ...).","type":"string"},"tos_acceptance":{"anyOf":[{"$ref":"#/components/schemas/V1TosAcceptance"},{"type":"null"}],"default":null,"description":"Acceptance of the provider's current terms of service; required on\n providers with terms."}},"required":["name","region","provider","environment_id","pools"],"type":"object"},"V1CreateProject":{"additionalProperties":false,"description":"A project to create.","properties":{"display_name":{"description":"The name shown in the dashboard, 1-255 characters.","type":"string"},"isolated":{"default":false,"description":"Only explicit app connections may reach an app. Default false; can\n be switched later. A hosted organization's projects are always\n isolated.","type":"boolean"},"name":{"description":"The project's name, its Kubernetes namespace: lowercase letters,\n digits and hyphens, 3-63 characters. Unique in the cluster and its\n environment.","type":"string"}},"required":["name","display_name"],"type":"object"},"V1CreateSecret":{"additionalProperties":false,"description":"Create a secret. The value is stored encrypted and never returned.","properties":{"description":{"description":"Free text.","type":["string","null"]},"injection_mode":{"description":"`env` (default), `file` or `both`.","type":["string","null"]},"mount_path":{"description":"Where to mount a `file`/`both` secret.","type":["string","null"]},"name":{"description":"The name, unique within the cluster or environment.","type":"string"},"secret_type":{"description":"`opaque` (default), `database`, `registry` or `tls`.","type":["string","null"]},"value":{"description":"The value (write-only).","type":"string"},"write_only":{"default":false,"description":"Make the key write-only: nobody can read its value back, in the\n console or the API (apps still receive it). One-way.","type":"boolean"}},"required":["name","value"],"type":"object"},"V1CreateSecretGroup":{"additionalProperties":false,"description":"A new secret group (empty; add members afterwards).","properties":{"description":{"description":"Free text.","type":["string","null"]},"name":{"description":"The name, unique within the environment.","type":"string"}},"required":["name"],"type":"object"},"V1CustomShapes":{"description":"Bounds of custom runner shapes. Not offered today (always `null`): a\n label must name one of `sizes` exactly.","properties":{"max_vcpu":{"description":"Most vCPUs.","format":"uint32","minimum":0,"type":"integer"},"min_vcpu":{"description":"Fewest vCPUs.","format":"uint32","minimum":0,"type":"integer"}},"required":["min_vcpu","max_vcpu"],"type":"object"},"V1DeleteClusterQuery":{"additionalProperties":false,"description":"The confirmations a cluster delete may need.","properties":{"acknowledge_commitment":{"default":false,"description":"Remove committed monthly machines although they stay billed to the\n end of their term.","type":"boolean"},"acknowledge_iac":{"default":false,"description":"Delete although a file of the infra link still defines the cluster\n (the link then proposes creating it again).","type":"boolean"},"confirm":{"default":null,"description":"The cluster's name, required when volumes go with it. Deleting\n volumes needs a signed-in user's step-up: an API key sending it gets\n 403 `step_up_unavailable`.","type":["string","null"]}},"type":"object"},"V1DeletedCluster":{"description":"A cluster accepted for deletion.","properties":{"id":{"description":"The cluster id.","format":"uuid","type":"string"},"state":{"description":"Always `deleting`: the servers are removed in the background.","type":"string"},"warnings":{"description":"What to know about the delete (an infra link file that still defines it, ...).","items":{"type":"string"},"type":"array"}},"required":["id","state","warnings"],"type":"object"},"V1Deploy":{"description":"A deploy (or build) of an app.","properties":{"app_id":{"description":"The app it deploys.","format":"uuid","type":"string"},"created_at":{"description":"When it was created (RFC 3339, UTC).","format":"date-time","type":"string"},"error":{"description":"Why it failed.","type":["string","null"]},"failure_stage":{"description":"Where a failed deploy stopped: `build`, `push` or `rollout`.","type":["string","null"]},"finished_at":{"description":"When it finished.","format":"date-time","type":["string","null"]},"id":{"description":"The deploy id.","format":"uuid","type":"string"},"image":{"description":"The image it deploys; null while a build has not produced one.","type":["string","null"]},"image_digest":{"description":"Digest of the pushed image.","type":["string","null"]},"refusal_code":{"description":"For a refused build: `BILLING_ACCOUNT_BLOCKED` (top up the billing\n account) or `SPEND_CAP_REACHED` (raise the spend cap).","type":["string","null"]},"rollback_reason":{"description":"Why it was rolled back.","type":["string","null"]},"rolled_back_at":{"description":"When it was rolled back.","format":"date-time","type":["string","null"]},"serving":{"description":"True while this deploy's image is the one serving traffic.","type":"boolean"},"started_at":{"description":"When it started.","format":"date-time","type":["string","null"]},"status":{"description":"e.g. `pending`, `waiting_for_capacity` (no build VM free\n yet), `waiting_for_image` (the platform's build image is not\n published yet), `booting` (its build VM is starting), `building`,\n `pushed` (image pushed, the deploy not started yet),\n `waiting_for_pool` (a deploy held until its pinned node pool has a\n ready node; nothing is applied meanwhile), `deploying`,\n `succeeded`, `failed`, `cancelled`, `refused` (an automatic build\n the org could not pay for; see `refusal_code`). New statuses may be\n added.","type":"string"}},"required":["id","app_id","status","created_at","serving"],"type":"object"},"V1DeployListQuery":{"description":"Query of the deploy list.","properties":{"cursor":{"description":"Cursor from the previous page.","type":["string","null"]},"limit":{"description":"Page size (1 to 100).","format":"uint","minimum":0,"type":["integer","null"]},"status":{"description":"Keep only deploys in this status, e.g. `failed`.","type":["string","null"]}},"type":"object"},"V1DiskAddOn":{"description":"The extra-storage add-on of one size: a bigger local disk.","properties":{"disk_gb":{"description":"The local disk with the add-on, GB.","format":"uint32","minimum":0,"type":"integer"},"extra_gb":{"description":"GB over the included disk, billed at `extra_disk_gb_hour`.","format":"uint32","minimum":0,"type":"integer"},"label":{"description":"The `runs-on` label asking for it (`a-line-4vcpu-100gb`).","type":"string"},"vcpu":{"description":"The size it applies to, in vCPUs.","format":"uint32","minimum":0,"type":"integer"}},"required":["vcpu","label","disk_gb","extra_gb"],"type":"object"},"V1DnsRecord":{"description":"A record to create at the customer's DNS provider.","properties":{"name":{"description":"The owner name.","type":"string"},"type":{"description":"`A`, `AAAA` or `CNAME`.","type":"string"},"value":{"description":"The address, or the CNAME target.","type":"string"}},"required":["type","name","value"],"type":"object"},"V1DnsTarget":{"description":"How the customer's DNS points the domain at the cluster.","oneOf":[{"const":"a_records","description":"A/AAAA records naming every active load balancer address.","type":"string"},{"const":"cname","description":"One CNAME to the app's CNAME target (not allowed at a zone apex).","type":"string"}]},"V1Env":{"additionalProperties":false,"description":"An app's environment variables.","properties":{"env":{"additionalProperties":{"type":"string"},"description":"Variable name to value. Replacing sets exactly these variables.","type":"object"}},"required":["env"],"type":"object"},"V1Error":{"description":"The error envelope of every non-2xx v1 response.","properties":{"error":{"description":"What went wrong.","properties":{"code":{"description":"Stable machine-readable code.","type":"string"},"details":{"description":"Extra fields of the refusal, if any.","type":"object"},"message":{"description":"Human-readable text, not for matching.","type":"string"},"request_id":{"description":"The x-request-id of the request.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"},"V1GroupMember":{"description":"A secret in a group: its metadata only.","properties":{"has_value":{"description":"False for a key a secret-group file added that has no value yet.","type":"boolean"},"id":{"description":"The secret id.","format":"uuid","type":"string"},"injection_mode":{"description":"`env`, `file` or `both`.","type":"string"},"mount_path":{"description":"The file path (`file`/`both`).","type":["string","null"]},"name":{"description":"The secret name.","type":"string"},"secret_type":{"description":"`opaque`, `database`, `registry` or `tls`.","type":"string"}},"required":["id","name","secret_type","injection_mode","has_value"],"type":"object"},"V1GroupMembersAdded":{"description":"How many of the given secrets were not in the group yet.","properties":{"added":{"description":"Secrets added by this request (0 when all were members already).","format":"int64","type":"integer"}},"required":["added"],"type":"object"},"V1HostedZone":{"description":"A hosted zone (or a claim on one still being verified).","properties":{"created_at":{"description":"When the claim was made (RFC 3339, UTC).","format":"date-time","type":"string"},"delegated":{"description":"Whether the zone is delegated to them (null before the first check).","type":["boolean","null"]},"id":{"description":"The zone id.","format":"uuid","type":"string"},"name":{"description":"The zone name (`example.com`).","type":"string"},"nameservers":{"description":"The nameservers to delegate the zone to.","items":{"type":"string"},"type":"array"},"status":{"description":"`pending`, `verified` or `failed`.","type":"string"},"txt_name":{"description":"The TXT record name proving ownership.","type":"string"},"txt_value":{"description":"The TXT record value.","type":"string"},"verified_at":{"description":"When the zone verified.","format":"date-time","type":["string","null"]}},"required":["id","name","status","txt_name","txt_value","nameservers","created_at"],"type":"object"},"V1IacCommit":{"additionalProperties":false,"description":"The commit a plan or sync is for.","properties":{"sha":{"description":"The full commit id (40 lowercase hex characters).","type":"string"}},"required":["sha"],"type":"object"},"V1IacHeldAction":{"description":"A change a sync held until someone confirms it in the console.","properties":{"console_url":{"description":"Where to confirm it.","type":"string"},"id":{"description":"The held action.","format":"uuid","type":"string"},"kind":{"description":"What it does (`infra_billable_increase`, ...). New values may appear.","type":"string"},"reason":{"description":"Why it was held.","type":"string"},"requires":{"description":"What confirming it takes (`step_up`, `confirm_name`, ...).","items":{"type":"string"},"type":"array"},"sha":{"description":"The commit that asked for it.","type":"string"},"target":{"description":"What it acts on."}},"required":["id","kind","target","requires","reason","sha","console_url"],"type":"object"},"V1IacLink":{"description":"An IaC link as a listing shows it.","properties":{"branch":{"description":"The branch it follows.","type":"string"},"id":{"description":"The link.","format":"uuid","type":"string"},"path":{"description":"The directory it reads, relative to the repository root.","type":"string"},"repository":{"description":"The repository's `owner/name`.","type":"string"},"status":{"description":"`active` or `broken`.","type":"string"}},"required":["id","path","branch","repository","status"],"type":"object"},"V1IacLinkQuery":{"additionalProperties":false,"description":"`GET /v1/iac/{infra,project}-links` query.","properties":{"cursor":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"limit":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"path":{"description":"Only the links reading exactly this repository directory (one\n trailing slash ignored).","type":["string","null"]}},"type":"object"},"V1IacPlan":{"description":"A dry-run plan of a link's files at one commit.","properties":{"additions":{"description":"Resources a sync would add.","format":"int32","type":"integer"},"diff":{"description":"The changes, shaped as the console's plan view and the stored sync\n diffs show them."},"errors":{"description":"Declarations a sync would refuse (`file: message`).","items":{"type":"string"},"type":"array"},"held":{"description":"Changes a sync would hold for confirmation in the console.","format":"int32","type":"integer"},"modifications":{"description":"Resources a sync would change.","format":"int32","type":"integer"},"removals":{"description":"Resources a sync would remove.","format":"int32","type":"integer"},"sha":{"description":"The planned commit.","type":"string"},"warnings":{"description":"What a sync would apply but should be known first (`file: key: message`).","items":{"type":"string"},"type":"array"}},"required":["sha","diff","additions","modifications","removals","held","errors","warnings"],"type":"object"},"V1IacStatus":{"description":"A link's sync state at one commit.","properties":{"console_url":{"description":"The link's page in the console.","type":"string"},"held_actions":{"description":"Every change of the link still waiting for confirmation.","items":{"$ref":"#/components/schemas/V1IacHeldAction"},"type":"array"},"last_applied_sha":{"description":"The commit the link last applied.","type":["string","null"]},"last_checked_sha":{"description":"The commit the link last checked.","type":["string","null"]},"last_sync_error":{"description":"Why the last sync failed.","type":["string","null"]},"last_sync_status":{"description":"The last sync's outcome (`synced` or `failed`).","type":["string","null"]},"link_id":{"description":"The link.","format":"uuid","type":"string"},"sha":{"description":"The commit reported on; null before the first sync.","type":["string","null"]},"state":{"description":"`pending` (not synced yet), `applying`, `applied`, `failed` or `held`\n (applied, with changes waiting for confirmation). New values may\n appear.","type":"string"}},"required":["link_id","state","console_url","held_actions"],"type":"object"},"V1IacStatusQuery":{"additionalProperties":false,"description":"`GET .../status` query.","properties":{"sha":{"description":"The commit to report on. Default: the commit synced last.","type":["string","null"]}},"type":"object"},"V1IacSyncQueued":{"description":"A queued sync.","properties":{"link_id":{"description":"The link.","format":"uuid","type":"string"},"sha":{"description":"The commit the sync applies.","type":"string"},"status_url":{"description":"Poll this (`GET`) for the sync's outcome.","type":"string"}},"required":["link_id","sha","status_url"],"type":"object"},"V1KeyScope":{"description":"An API key's scope: `read` allows GETs, `write` also mutations, `admin`\n everything a key may do.","oneOf":[{"const":"read","description":"GET requests only.","type":"string"},{"const":"write","description":"Reads and mutations.","type":"string"},{"const":"admin","description":"Everything a key may do.","type":"string"}]},"V1LogRetainedReason":{"description":"Why an app's older log lines were removed.","oneOf":[{"const":"size","description":"The cluster's size window keeps only its newest lines.","type":"string"},{"const":"time","description":"The lines passed the cluster's retention period.","type":"string"}]},"V1LogsPricing":{"description":"Container logs.","properties":{"free_gib_per_cluster_month":{"description":"GiB every cluster ingests for free per UTC calendar month.","type":"string"},"included_retention_days":{"description":"Retention included in the ingest price, days.","format":"uint32","minimum":0,"type":"integer"},"ingest_gib":{"description":"Price per GiB ingested above the free allowance.","type":"string"},"storage_gib_month":{"description":"Price per GiB-month of logs kept past the included retention.","type":"string"}},"required":["ingest_gib","storage_gib_month","included_retention_days","free_gib_per_cluster_month"],"type":"object"},"V1MachineOrder":{"additionalProperties":false,"description":"A machine configuration: a catalog family and the options picked in it.","properties":{"selections":{"additionalProperties":{"type":"string"},"default":{},"description":"The option value key per option group key; groups left out take\n their default.","type":"object"},"slug":{"description":"The family's slug.","type":"string"}},"required":["slug"],"type":"object"},"V1ManagedInGit":{"description":"Where a group managed in git is described.","properties":{"branch":{"description":"The branch.","type":"string"},"file":{"description":"The file, relative to the repository root.","type":"string"}},"required":["file","branch"],"type":"object"},"V1NewPool":{"additionalProperties":false,"description":"A node pool of a new cluster.","properties":{"block_volume_gb":{"default":null,"description":"A block volume per node, in GB (VPS providers only).","format":"int32","type":["integer","null"]},"count":{"description":"The number of nodes (at least 1).","format":"int32","type":"integer"},"labels":{"additionalProperties":{"type":"string"},"default":{},"description":"Kubernetes node labels.","type":"object"},"machine":{"anyOf":[{"$ref":"#/components/schemas/V1MachineOrder"},{"type":"null"}],"description":"The machine configuration picked from the family `node_type_id` is\n sold as; the pool is built and charged as it. Omitted: the node type."},"max_hourly_price":{"anyOf":[{"$ref":"#/components/schemas/V1Amount"},{"type":"null"}],"description":"The highest hourly price per node, in credits. Omitted: the node\n type's current price."},"max_monthly_price":{"anyOf":[{"$ref":"#/components/schemas/V1Amount"},{"type":"null"}],"description":"The highest monthly price per node, in credits. Omitted: the node\n type's current price."},"max_setup_fee":{"anyOf":[{"$ref":"#/components/schemas/V1Amount"},{"type":"null"}],"description":"The highest one-off setup fee per node, in credits. Omitted: the node\n type's current fee. A node whose price goes above a cap waits for a\n confirmation."},"name":{"description":"The pool's name, unique in the cluster.","type":"string"},"node_type_id":{"description":"The node type id (see the node type catalog).","type":"string"},"public_ipv4":{"default":false,"description":"Give the nodes a public IPv4 address (charged per node). Default: IPv6 only.","type":"boolean"},"reserved":{"default":false,"description":"Reserve the pool for apps bound to it (worker and storage pools).","type":"boolean"},"role":{"allOf":[{"$ref":"#/components/schemas/V1PoolRole"}],"description":"`control_plane`, `worker`, `storage` or `hybrid`."},"storage_config":{"default":null,"description":"The storage configuration; its shape depends on the strategy."},"storage_strategy":{"default":null,"description":"The storage strategy (`none`, `zfs_local`, `longhorn`, `local_path`). Default `none`.","type":["string","null"]},"system_extensions":{"default":[],"description":"Talos system extensions for the pool's nodes.","items":{"type":"string"},"type":"array"}},"required":["name","role","node_type_id","count"],"type":"object"},"V1Node":{"description":"A node of a cluster, as the public API shows it.","properties":{"id":{"description":"The node id.","format":"uuid","type":"string"},"kubernetes_name":{"description":"The Kubernetes node name; `null` until the node joins.","type":["string","null"]},"pool":{"description":"The node pool's name; `null` when the node has no pool.","type":["string","null"]},"private_ip":{"description":"The private network address; `null` until known.","type":["string","null"]},"public_ip":{"description":"The public IPv4 address; `null` until the provider assigns one.","type":["string","null"]},"public_ipv6":{"description":"The public IPv6 address; `null` until the provider assigns one.","type":["string","null"]},"role":{"description":"The node's role (`control_plane`, `worker`, ...). New values may appear.","type":"string"},"state":{"description":"The lifecycle state (`provisioning`, `running`, ...). New values may appear.","type":"string"},"static_address":{"description":"Whether the public address is one of the pool's static addresses.","type":"boolean"}},"required":["id","role","state","static_address"],"type":"object"},"V1OrgDomain":{"description":"An organization domain and the TXT record that proves it.","properties":{"created_at":{"description":"When it was added.","format":"date-time","type":"string"},"error":{"description":"Why the last check failed.","type":["string","null"]},"id":{"description":"The domain id.","format":"uuid","type":"string"},"last_checked_at":{"description":"When it was last checked.","format":"date-time","type":["string","null"]},"name":{"description":"The domain name.","type":"string"},"scope":{"description":"`domain` (the name and its subdomains) or `host` (the name only).","type":"string"},"status":{"description":"`pending`, `verified` or `failed`.","type":"string"},"txt_name":{"description":"Name of the TXT record to publish.","type":"string"},"txt_value":{"description":"Value of that TXT record.","type":"string"},"verified_at":{"description":"When the domain verified (RFC 3339, UTC).","format":"date-time","type":["string","null"]}},"required":["id","name","scope","status","txt_name","txt_value","created_at"],"type":"object"},"V1OriginKey":{"description":"A new origin key, answered this once.","properties":{"domain":{"allOf":[{"$ref":"#/components/schemas/V1AppDomain"}],"description":"The domain with its lock."},"header":{"description":"The request header to send it in (`X-Aline-Origin-Key`).","type":"string"},"key":{"description":"The key for the proxy to send.","type":"string"}},"required":["key","header","domain"],"type":"object"},"V1OriginLock":{"description":"A domain's origin lock: fingerprints, never a key.","properties":{"created_at":{"description":"When the current key was made (RFC 3339, UTC).","format":"date-time","type":"string"},"fingerprint":{"description":"The current key's fingerprint: the first 16 hex digits of its SHA-256.","type":"string"},"previous_expires_at":{"description":"When the previous key stops working.","format":"date-time","type":["string","null"]},"previous_fingerprint":{"description":"After a rotation: the previous key's fingerprint, accepted until\n `previous_expires_at`.","type":["string","null"]},"unlocked_hosts":{"description":"The app's platform hostnames (its temporary URLs). They are other\n hosts, so they still reach the app without the key, and the CDN's\n protections do not apply there.","items":{"type":"string"},"type":"array"}},"required":["fingerprint","created_at","unlocked_hosts"],"type":"object"},"V1Page_for_AuditOut":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/AuditOut"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_Grant":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_KeyOut":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/KeyOut"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_Ring":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/Ring"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1App":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1App"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1AppDomain":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1AppDomain"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1Cluster":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1Cluster"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1Deploy":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1Deploy"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1HostedZone":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1HostedZone"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1IacLink":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1IacLink"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1Node":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1Node"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1OrgDomain":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1OrgDomain"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1Project":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1Project"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1RecordSet":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1RecordSet"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1Secret":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1Secret"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_V1SecretGroup":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/V1SecretGroup"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1Page_for_VersionOut":{"description":"One page of a v1 list.","properties":{"data":{"description":"The items, in the documented order.","items":{"$ref":"#/components/schemas/VersionOut"},"type":"array"},"has_more":{"description":"Whether more items follow this page.","type":"boolean"},"next_cursor":{"description":"Pass as `cursor` to get the next page; null on the last page.","type":["string","null"]}},"required":["data","has_more"],"type":"object"},"V1PendingVerification":{"description":"The organization domain (not verified yet) a host waits on.","properties":{"domain_id":{"description":"The organization domain id (see `GET /v1/domains/{domain_id}`).","format":"uuid","type":"string"},"name":{"description":"Its name.","type":"string"},"scope":{"description":"`domain` or `host`.","type":"string"},"status":{"description":"Its verification status.","type":"string"}},"required":["domain_id","name","scope","status"],"type":"object"},"V1PoolRole":{"description":"The role of a node pool.","oneOf":[{"const":"control_plane","description":"Kubernetes control plane nodes.","type":"string"},{"const":"worker","description":"Worker nodes.","type":"string"},{"const":"storage","description":"Storage nodes.","type":"string"},{"const":"hybrid","description":"Worker and storage nodes.","type":"string"}]},"V1PriceCaps":{"description":"A pool's price caps in credits (`null` = no cap).","properties":{"max_hourly_price":{"description":"Highest hourly price per server.","type":["string","null"]},"max_monthly_price":{"description":"Highest monthly price per server.","type":["string","null"]},"max_setup_fee":{"description":"Highest setup fee per server.","type":["string","null"]}},"type":"object"},"V1PriceConfirmation":{"description":"Servers of one pool held until the new price is confirmed.","properties":{"count":{"description":"How many servers are held.","format":"int64","type":"integer"},"location":{"description":"The provider location.","type":"string"},"new":{"allOf":[{"$ref":"#/components/schemas/V1PriceQuote"}],"description":"The current price."},"node_type":{"description":"The machine type.","type":"string"},"old":{"allOf":[{"$ref":"#/components/schemas/V1PriceCaps"}],"description":"The caps the price went above."},"pool":{"description":"The pool's name.","type":"string"},"pool_id":{"description":"The pool's id.","format":"uuid","type":"string"},"role":{"description":"The pool's role.","type":"string"},"since":{"description":"When the oldest of them started waiting (RFC 3339, UTC).","format":"date-time","type":"string"}},"required":["pool_id","pool","role","node_type","location","count","since","old","new"],"type":"object"},"V1PriceQuote":{"description":"A machine type's current price in credits.","properties":{"hourly_price":{"description":"Hourly price per server.","type":"string"},"monthly_price":{"description":"Monthly price per server (hourly x 730).","type":"string"},"setup_fee":{"description":"Setup fee per server.","type":"string"}},"required":["setup_fee","monthly_price","hourly_price"],"type":"object"},"V1Pricing":{"description":"The public list prices.","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/V1ActionsPricing"}],"description":"GitHub Actions runners."},"builds":{"allOf":[{"$ref":"#/components/schemas/V1BuildsPricing"}],"description":"Image builds."},"currency":{"description":"Currency of every price.","type":"string"},"logs":{"allOf":[{"$ref":"#/components/schemas/V1LogsPricing"}],"description":"Container logs."},"updated_at":{"description":"When a price on this list last changed; `null` when every value is\n at its built-in default.","format":"date-time","type":["string","null"]},"vat_included":{"description":"Whether prices include VAT.","type":"boolean"},"version":{"description":"Document version (1).","format":"uint32","minimum":0,"type":"integer"}},"required":["version","currency","vat_included","actions","builds","logs"],"type":"object"},"V1Project":{"description":"A project, as the public API shows it.","properties":{"cluster_id":{"description":"The cluster the project belongs to.","format":"uuid","type":"string"},"created_at":{"description":"When the project was created (RFC 3339, UTC).","format":"date-time","type":"string"},"display_name":{"description":"The name shown in the dashboard.","type":"string"},"egress_mode":{"description":"Outbound traffic of its apps: `public` (any public address) or\n `isolated` (only the allowlist). See the project's `egress` route.","type":"string"},"id":{"description":"The project id.","format":"uuid","type":"string"},"isolated":{"description":"Whether apps in the project cannot reach each other unless connected.","type":"boolean"},"name":{"description":"The project's name (its Kubernetes namespace).","type":"string"}},"required":["id","cluster_id","name","display_name","isolated","egress_mode","created_at"],"type":"object"},"V1ProjectQuotas":{"description":"A project's quota limits with its current usage.","properties":{"can_edit":{"description":"Whether the key's user may change the limits (tenant owners and admins).","type":"boolean"},"limits":{"allOf":[{"$ref":"#/components/schemas/V1QuotaLimits"}],"description":"The limits as set."},"usage":{"allOf":[{"$ref":"#/components/schemas/V1QuotaUsage"}],"description":"What the project's apps use now."}},"required":["limits","usage","can_edit"],"type":"object"},"V1QuotaLimits":{"description":"A project's quota limits. A missing limit (null) means unlimited.","properties":{"cpu":{"description":"Maximum total CPU requests, as a Kubernetes quantity (`4`, `2500m`).","type":["string","null"]},"memory":{"description":"Maximum total memory requests, as a Kubernetes quantity (`8Gi`).","type":["string","null"]},"pods":{"description":"Maximum pods.","format":"int32","type":["integer","null"]},"pvcs":{"description":"Maximum persistent volume claims.","format":"int32","type":["integer","null"]},"storage":{"description":"Maximum total claimed storage, as a Kubernetes quantity (`100Gi`).","type":["string","null"]}},"type":"object"},"V1QuotaUsage":{"description":"What a project's apps use now.","properties":{"cpu_millis":{"description":"CPU requests in millicores.","format":"uint64","minimum":0,"type":"integer"},"memory_bytes":{"description":"Memory requests in bytes.","format":"uint64","minimum":0,"type":"integer"},"pods":{"description":"Pods.","format":"int64","type":"integer"},"pvcs":{"description":"Persistent volume claims.","format":"int64","type":"integer"},"storage_bytes":{"description":"Claimed storage in bytes.","format":"uint64","minimum":0,"type":"integer"}},"required":["pods","pvcs","storage_bytes","cpu_millis","memory_bytes"],"type":"object"},"V1RecordSet":{"additionalProperties":false,"description":"A record set: every record of one name and type.","properties":{"name":{"description":"The owner name, fully qualified without the trailing dot (`www.example.com`).","type":"string"},"records":{"description":"The record values, in zone-file presentation format.","items":{"type":"string"},"type":"array"},"ttl":{"description":"Time to live in seconds.","format":"uint32","minimum":0,"type":"integer"},"type":{"description":"The record type (`A`, `AAAA`, `CNAME`, `TXT`, `MX`, ...).","type":"string"}},"required":["name","type","ttl","records"],"type":"object"},"V1Scale":{"additionalProperties":false,"description":"How many pods an app runs.","properties":{"replicas":{"description":"Desired pods.","format":"int32","type":"integer"}},"required":["replicas"],"type":"object"},"V1Secret":{"description":"A secret's metadata, as the public API shows it. The value is never part of it.","properties":{"created_at":{"description":"When the secret was created (RFC 3339, UTC).","format":"date-time","type":"string"},"description":{"description":"Free text.","type":["string","null"]},"expires_at":{"description":"When the value expires (RFC 3339, UTC).","format":"date-time","type":["string","null"]},"has_value":{"description":"False for a secret declared without a value (in IaC) until one is set;\n apps do not receive it until then.","type":"boolean"},"id":{"description":"The secret id.","format":"uuid","type":"string"},"injection_mode":{"description":"How apps receive it: `env`, `file` or `both`.","type":"string"},"keep_versions":{"description":"How many replaced versions the secret keeps (1 to 100, each billed\n like the current value); `null` = the default, 10. Older ones are\n destroyed.","format":"int32","type":["integer","null"]},"mount_path":{"description":"Where a file secret is mounted.","type":["string","null"]},"name":{"description":"The name, unique within its scope (the environment variable name for env injection).","type":"string"},"rotated_at":{"description":"When the value was last rotated (RFC 3339, UTC).","format":"date-time","type":["string","null"]},"scope_id":{"description":"The id of that cluster, environment, project or app.","format":"uuid","type":"string"},"scope_type":{"description":"What the secret belongs to: `cluster`, `environment`, `project` or `app`.","type":"string"},"secret_type":{"description":"`opaque`, `database`, `registry` or `tls` (new values may be added).","type":"string"},"updated_at":{"description":"When the secret last changed (RFC 3339, UTC).","format":"date-time","type":"string"},"value_origin":{"description":"Who set the value: `user`, `generated` or `app_credential`.","type":"string"},"version":{"description":"The current version; every value change adds one.","format":"int32","type":"integer"},"write_only":{"description":"The value can be replaced or deleted but never read back by anyone\n (apps still receive it). One-way.","type":"boolean"}},"required":["id","name","secret_type","injection_mode","scope_type","scope_id","value_origin","has_value","write_only","version","created_at","updated_at"],"type":"object"},"V1SecretGroup":{"description":"A secret group, as the public API shows it.","properties":{"created_at":{"description":"When the group was created (RFC 3339, UTC).","format":"date-time","type":"string"},"description":{"description":"Free text.","type":["string","null"]},"id":{"description":"The group id.","format":"uuid","type":"string"},"member_count":{"description":"How many secrets the group holds.","format":"int64","type":"integer"},"name":{"description":"The name, unique within the environment.","type":"string"},"updated_at":{"description":"When the group last changed (RFC 3339, UTC).","format":"date-time","type":"string"}},"required":["id","name","member_count","created_at","updated_at"],"type":"object"},"V1SecretGroupDetail":{"description":"A secret group with its members.","properties":{"created_at":{"description":"When the group was created (RFC 3339, UTC).","format":"date-time","type":"string"},"description":{"description":"Free text.","type":["string","null"]},"id":{"description":"The group id.","format":"uuid","type":"string"},"keys_without_value":{"description":"Member keys without a value yet.","items":{"type":"string"},"type":"array"},"managed_in_git":{"anyOf":[{"$ref":"#/components/schemas/V1ManagedInGit"},{"type":"null"}],"description":"The infra link file describing the group, null when it is not\n managed in git."},"members":{"description":"The secrets in the group.","items":{"$ref":"#/components/schemas/V1GroupMember"},"type":"array"},"name":{"description":"The name, unique within the environment.","type":"string"},"updated_at":{"description":"When the group last changed (RFC 3339, UTC).","format":"date-time","type":"string"}},"required":["id","name","members","keys_without_value","created_at","updated_at"],"type":"object"},"V1SetActionsCacheLimit":{"additionalProperties":false,"description":"A new org cache limit.","properties":{"cache_limit_gb":{"description":"Whole GB, at least the free amount and at most the max.","format":"int64","type":"integer"}},"required":["cache_limit_gb"],"type":"object"},"V1SetClientIpHeader":{"additionalProperties":false,"description":"The client-IP header of a domain behind a proxy.","properties":{"header":{"default":null,"description":"`CF-Connecting-IP`, `True-Client-IP`, `Fastly-Client-IP` or another\n header name; null or empty clears it.","type":["string","null"]}},"type":"object"},"V1SetSecretValue":{"additionalProperties":false,"description":"A new value for a secret (write-only). It becomes the next version.","properties":{"value":{"description":"The new value.","type":"string"}},"required":["value"],"type":"object"},"V1TosAcceptance":{"additionalProperties":false,"description":"The terms of service the customer accepted.","properties":{"crypto_prohibition_acknowledged":{"default":false,"description":"The provider's crypto prohibition was acknowledged (required on\n providers that prohibit crypto).","type":"boolean"},"tos_version":{"description":"The terms version accepted; must be the current one.","type":"string"}},"required":["tos_version"],"type":"object"},"V1TriggerBackup":{"additionalProperties":false,"description":"A backup to run now.","properties":{"target_ids":{"default":null,"description":"Targets to back up to; the app's primary target when left out.","items":{"format":"uuid","type":"string"},"type":["array","null"]}},"type":"object"},"V1TriggerDeploy":{"additionalProperties":false,"description":"A deploy to start.","properties":{"strategy":{"default":null,"description":"`rolling` (default), `recreate` or `surge` (templates that support it).","type":["string","null"]}},"type":"object"},"V1UpdateApp":{"additionalProperties":false,"description":"App settings to change; omitted fields stay as they are.","properties":{"batch":{"default":null,"description":"Groups the redeploy with others sent under the same name (for\n example a release version), so their notices arrive together.\n 1-64 letters, digits or `. _ - + :`.","type":["string","null"]},"health_path":{"default":null,"description":"A new HTTP health check path.","type":["string","null"]},"image":{"default":null,"description":"A new container image; redeploys the app.","type":["string","null"]},"port":{"default":null,"description":"A new main container port.","format":"int32","type":["integer","null"]}},"type":"object"},"V1UpdateDomain":{"additionalProperties":false,"description":"The fields to change; a field left out keeps its value.","properties":{"behind_proxy":{"default":null,"description":"Served through a CDN or reverse proxy (HTTP and HTTPS routes only).\n Turning it off also turns the origin lock off and clears the client\n IP header.","type":["boolean","null"]}},"type":"object"},"V1UpdateProject":{"additionalProperties":false,"description":"Changes to a project; at least one field. The name is fixed at creation;\n `isolated` switches the app network.","properties":{"display_name":{"default":null,"description":"The new name shown in the dashboard, 1-255 characters.","type":["string","null"]},"isolated":{"default":null,"description":"Switch isolation. Turning it on blocks traffic between the project's\n apps that are not declared as connections; the namespace's network\n policies follow within a minute. A hosted organization's projects\n stay isolated.","type":["boolean","null"]}},"type":"object"},"V1Whoami":{"description":"The calling API key.","properties":{"key_id":{"description":"The key's id.","format":"uuid","type":["string","null"]},"scope":{"allOf":[{"$ref":"#/components/schemas/V1KeyScope"}],"description":"The key's scope."},"tenant_id":{"description":"The organization the key acts on.","format":"uuid","type":["string","null"]}},"required":["scope"],"type":"object"},"V1ZoneSerial":{"description":"The zone serial after a write.","properties":{"serial":{"description":"The zone's SOA serial including the change.","format":"uint32","minimum":0,"type":"integer"}},"required":["serial"],"type":"object"},"VersionOut":{"description":"One version of a key.","properties":{"created_at":{"description":"When the version was created.","format":"date-time","type":"string"},"destroy_at":{"description":"When a scheduled destruction runs; null unless `destroy_scheduled`.","format":"date-time","type":["string","null"]},"state":{"description":"`enabled`, `disabled`, `destroy_scheduled` or `destroyed`.","type":"string"},"version":{"description":"The version number, counting up from 1.","format":"uint32","minimum":0,"type":"integer"}},"required":["version","state","created_at"],"type":"object"},"VersionQuery":{"description":"List query for versions.","properties":{"cursor":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"limit":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"state":{"description":"Only versions in this state: `enabled`, `disabled`, `destroy_scheduled` or `destroyed`.","type":["string","null"]}},"type":"object"},"WwwRedirectMode":{"description":"Redirect between a host and its `www.` form.","enum":["off","to_www","to_apex"],"type":"string"}},"securitySchemes":{"api_key":{"bearerFormat":"alc_ API key","description":"An A-Line.cloud API key, sent as `Authorization: Bearer alc_...`. Create keys in the dashboard; sessions are not accepted on /v1.","scheme":"bearer","type":"http"}}},"info":{"description":"The public A-Line.cloud API. Authenticate with `Authorization: Bearer alc_...`. Additive changes only within v1; see the deprecation policy.","title":"A-Line.cloud Public API","version":"1"},"openapi":"3.1.0","paths":{"/v1/actions/cache":{"get":{"description":"the limit and the monthly estimate. Only usage above the free part is\nbilled.","operationId":"get_actions_cache","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ActionsCache"}}},"description":"Usage, limit and cost","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"Not a member of the organization"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"The org cache: Actions cache and BuildKit cache usage, the free part,","tags":["v1_actions"]},"patch":{"description":"","operationId":"set_actions_cache_limit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SetActionsCacheLimit"}}},"description":"A new org cache limit.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ActionsCache"}}},"description":"The cache at the new limit","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body, below the free amount or above the max"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope or the caller's role does not allow this, or a demo organization (DEMO_CACHE_FIXED)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Change the org cache limit. Lowering it evicts the oldest items at once.","tags":["v1_actions"]}},"/v1/clusters":{"get":{"description":"Organization owners and admins see every cluster of the organization,\nother members the clusters of their environments. Deleted clusters are\nleft out. Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_clusters","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Cluster"}}},"description":"A page of clusters","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the clusters the key can open.","tags":["v1_clusters"]},"post":{"description":"The cluster starts in `provisioning`; its servers are ordered in the\nbackground. The balance must cover the first hours of the order. Send an\n`Idempotency-Key` to make a retry safe.","operationId":"create_cluster","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateCluster"}}},"description":"A cluster to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Cluster"}}},"description":"The created cluster","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid name, region, provider, environment, pool or system extension, or terms of service not accepted"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (`billing_account_blocked`: negative balance, low balance, grace period or suspended), or the balance does not cover the order"},"403":{"description":"The key is read-only"},"409":{"description":"The name is taken, the quoted price or availability changed, or a request with the same Idempotency-Key is in progress"},"422":{"description":"Missing or unknown body fields, invalid storage copies, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The extension catalog is unreachable"}},"security":[{"api_key":[]}],"summary":"Create a cluster.","tags":["v1_clusters"]}},"/v1/clusters/{cluster_id}":{"delete":{"description":"The cluster moves to `deleting` and its servers are removed in the\nbackground; deleting a cluster already `deleting` answers the same.\nDeletes stay open on a blocked billing account.","operationId":"delete_cluster","parameters":[{"description":"Remove committed monthly machines although they stay billed to the\n end of their term.","in":"query","name":"acknowledge_commitment","schema":{"default":false,"description":"Remove committed monthly machines although they stay billed to the\n end of their term.","type":"boolean"},"style":"form"},{"description":"Delete although a file of the infra link still defines the cluster\n (the link then proposes creating it again).","in":"query","name":"acknowledge_iac","schema":{"default":false,"description":"Delete although a file of the infra link still defines the cluster\n (the link then proposes creating it again).","type":"boolean"},"style":"form"},{"description":"The cluster's name, required when volumes go with it. Deleting\n volumes needs a signed-in user's step-up: an API key sending it gets\n 403 `step_up_unavailable`.","in":"query","name":"confirm","schema":{"default":null,"description":"The cluster's name, required when volumes go with it. Deleting\n volumes needs a signed-in user's step-up: an API key sending it gets\n 403 `step_up_unavailable`.","type":["string","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1DeletedCluster"}}},"description":"The cluster is being deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster id or unknown query parameters"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, its user is not an admin of the cluster's environment, or the request has `confirm` (`step_up_unavailable`: deleting volumes needs a signed-in user's step-up)"},"404":{"description":"Cluster not found"},"409":{"description":"The cluster has volumes (delete them in the dashboard, which confirms with the cluster name), committed monthly machines (`?acknowledge_commitment=true`) or a file of the infra link defines it (`cluster_managed_in_git`; `?acknowledge_iac=true`)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete a cluster.","tags":["v1_clusters"]},"get":{"description":"","operationId":"get_cluster","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Cluster"}}},"description":"The cluster","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"Cluster not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one cluster.","tags":["v1_clusters"]}},"/v1/clusters/{cluster_id}/apps":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_apps","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1App"}}},"description":"A page of apps","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor, or a malformed cluster id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's user cannot read this cluster"},"404":{"description":"Cluster not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the apps of a cluster.","tags":["v1_apps"]},"post":{"description":"The app is deployed right away. Send an `Idempotency-Key` to make a retry\nsafe.","operationId":"create_app","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateApp"}}},"description":"An app to create from a container image or a catalog template.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1App"}}},"description":"The created app","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid name, image, port or environment, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the project's environment"},"404":{"description":"Cluster, project or template not found"},"409":{"description":"The name is taken in the project, or a request with the same Idempotency-Key is in progress"},"422":{"description":"Missing or unknown body fields, an invalid setting, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create an app in a cluster from a container image or a catalog template.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}":{"delete":{"description":"Undeploys the app. Its backups are kept until their retention runs out\nand its buckets are kept.","operationId":"delete_app","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"App deletion started","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found or already being deleted"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete an app.","tags":["v1_apps"]},"get":{"description":"","operationId":"get_app","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1App"}}},"description":"The app","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one app.","tags":["v1_apps"]},"patch":{"description":"A new image redeploys the app.","operationId":"update_app","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateApp"}}},"description":"App settings to change; omitted fields stay as they are.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1App"}}},"description":"The updated app","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid image, port or health path, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"A field is managed in git"},"422":{"description":"Unknown body fields, or an invalid setting"},"423":{"description":"The cluster is suspended"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Update an app's image, port or health check path.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/backups":{"post":{"description":"Backs up with the app's enabled backup policies. Send an\n`Idempotency-Key` to make a retry safe.","operationId":"trigger_backup","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1TriggerBackup"}}},"description":"A backup to run now."},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BackupRunQueued"}}},"description":"The run that was queued","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id or JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"Backups are not enabled for the app, it has no backup target, or a request with the same Idempotency-Key is in progress"},"422":{"description":"Unknown body fields, a target that is not the app's, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Run a backup of the app now.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/backups/runs/{run_id}":{"get":{"description":"`pending` until the worker records the run, then `running`, `succeeded`\nor `failed` (any target failing fails the run). A run that stays\n`pending` never started.","operationId":"get_backup_run","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The run UUID","in":"path","name":"run_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunProgress"}}},"description":"The run","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get where an on-demand backup run stands.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/builds/{build_id}/logs":{"get":{"description":"Cursor paginated: pass `next_cursor` back as `cursor` until it is null.\nWhile the build runs, `has_more` stays true and the cursor can be polled\nfor new lines. Build log lines carry no timestamps.","operationId":"get_build_logs","parameters":[{"description":"`next_cursor` of the previous page.","in":"query","name":"cursor","schema":{"description":"`next_cursor` of the previous page.","type":["string","null"]},"style":"form"},{"description":"Lines per page, 1 to 5000 (default 500).","in":"query","name":"limit","schema":{"description":"Lines per page, 1 to 5000 (default 500).","format":"uint32","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The application UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The build UUID","in":"path","name":"build_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BuildLogsPage"}}},"description":"A page of build log lines","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Cluster, application or build not found"},"422":{"description":"Unknown or malformed query parameter or cursor"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Read a build's log by line.","tags":["v1_logs"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/deploys":{"get":{"description":"Newest first. Cursor paginated. `status` keeps only deploys in that stored\nstatus.","operationId":"list_deploys","parameters":[{"description":"Cursor from the previous page.","in":"query","name":"cursor","schema":{"description":"Cursor from the previous page.","type":["string","null"]},"style":"form"},{"description":"Page size (1 to 100).","in":"query","name":"limit","schema":{"description":"Page size (1 to 100).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Keep only deploys in this status, e.g. `failed`.","in":"query","name":"status","schema":{"description":"Keep only deploys in this status, e.g. `failed`.","type":["string","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Deploy"}}},"description":"A page of deploys","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit, cursor or status, or a malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List an app's deploys.","tags":["v1_apps"]},"post":{"description":"Send an `Idempotency-Key` to make a retry safe.","operationId":"trigger_deploy","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1TriggerDeploy"}}},"description":"A deploy to start.","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Deploy"}}},"description":"The deploy that started","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Unknown strategy, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"The app is stopped, or a request with the same Idempotency-Key is in progress"},"422":{"description":"Unknown body fields, a strategy the app does not support, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Deploy the app's current image again.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/deploys/cancel":{"post":{"description":"The worker stops it and rolls the app back to what ran before.","operationId":"cancel_deploy","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Deploy"}}},"description":"The cancelled deploy","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"No deploy is in progress"},"422":{"description":"Deploys of managed templates can't be cancelled"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Cancel the app's running deploy.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/deploys/{deploy_id}":{"get":{"description":"","operationId":"get_deploy","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The deploy UUID","in":"path","name":"deploy_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Deploy"}}},"description":"The deploy","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App or deploy not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one deploy of an app.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/deploys/{deploy_id}/rollback":{"post":{"description":"Redeploys that deploy's image by digest. Send an `Idempotency-Key` to make\na retry safe.","operationId":"rollback_deploy","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The past deploy UUID","in":"path","name":"deploy_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Deploy"}}},"description":"The rollback deploy that started","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App or deploy not found, or the deploy released nothing to roll back to"},"409":{"description":"The image is gone from the registry, the app is stopped or busy, or a request with the same Idempotency-Key is in progress"},"422":{"description":"An Idempotency-Key reused with a different request"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Roll the app back to what a past deploy released.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/domains":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_domains","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1AppDomain"}}},"description":"A page of domains","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List an app's domains.","tags":["v1_domains"]},"post":{"description":"An organization domain must cover the host (or one being verified, with\n`pending_verification`).","operationId":"add_domain","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AddDomain"}}},"description":"A domain to add to an app.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppDomain"}}},"description":"The domain was added","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid input"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App not found"},"409":{"description":"Another route in the cluster has the same host, port and path"},"422":{"description":"Invalid host, ports, path or protocol or not covered by a verified domain (`details` names the field), malformed body or unknown field"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Add a domain to an app.","tags":["v1_domains"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}":{"delete":{"description":"","operationId":"remove_domain","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"The domain was removed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope, or the domain is a read-only platform host"},"404":{"description":"App or domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Remove a domain from an app.","tags":["v1_domains"]},"get":{"description":"","operationId":"get_domain","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppDomain"}}},"description":"The domain","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App or domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one app domain, with the DNS records it needs.","tags":["v1_domains"]},"patch":{"description":"","operationId":"update_domain","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateDomain"}}},"description":"The fields to change; a field left out keeps its value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppDomain"}}},"description":"The changed domain","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid input"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App or domain not found"},"409":{"description":"The domain is a temporary URL, or the field is managed in git"},"422":{"description":"Behind a proxy on a route that is not HTTP or HTTPS (`details` names the field), malformed body or unknown field"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Change an app domain.","tags":["v1_domains"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/client-ip-header":{"put":{"description":"only while the origin lock is on.","operationId":"set_client_ip_header","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SetClientIpHeader"}}},"description":"The client-IP header of a domain behind a proxy.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppDomain"}}},"description":"The domain with its client IP header","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"An invalid header name, or a domain not behind a CDN or proxy"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App or domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Set the header a domain's proxy puts the client IP in; passed to the app","tags":["v1_domains"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/origin-lock":{"delete":{"description":"","operationId":"disable_origin_lock","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppDomain"}}},"description":"The domain, unlocked","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App or domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Turn off a domain's origin lock; every key stops working.","tags":["v1_domains"]},"post":{"description":"Requests without the key in `X-Aline-Origin-Key` are refused with 403,\nand the proxy's client-IP header reaches the app only while locked. The\nkey is answered this once.","operationId":"enable_origin_lock","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1OriginKey"}}},"description":"The new key, shown once, and the domain","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The domain is not behind a CDN or proxy"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App or domain not found"},"409":{"description":"The lock is on already"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Turn on a domain's origin lock.","tags":["v1_domains"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/origin-lock/rotate":{"post":{"description":"The new key is answered this once; the previous one keeps working for 24\nhours.","operationId":"rotate_origin_lock","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1OriginKey"}}},"description":"The new key, shown once, and the domain","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The lock is off, or the domain is not behind a CDN or proxy"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope"},"404":{"description":"App or domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Rotate a domain's origin key.","tags":["v1_domains"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/egress":{"get":{"description":"inherits from its project.","operationId":"get_app_egress","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppEgressResponse"}}},"description":"The app's outbound settings","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get an app's outbound settings: its own mode and rules plus what it","tags":["v1_apps"]},"put":{"description":"Re-applies the app's network policies.","operationId":"update_app_egress","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEgressRequest"}}},"description":"The whole new setting of a scope.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppEgressResponse"}}},"description":"The app's outbound settings now","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed ids or JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only"},"404":{"description":"App not found"},"409":{"description":"The app's egress is managed in git"},"422":{"description":"Invalid settings; `details.errors` lists every problem"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Replace an app's own outbound mode (`null` follows the project) and rules.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/egress/blocked":{"get":{"description":"hours, most recent first (at most 20).\n\nBuilt from the app's blocked-connection log lines, so it follows the\ncluster's log retention and the app's log access.","operationId":"get_app_blocked_egress","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedEgressResponse"}}},"description":"The recently blocked destinations","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the destinations an app's egress policy blocked in the last 24","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/env":{"get":{"description":"","operationId":"get_app_env","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Env"}}},"description":"The app's environment variables","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get an app's environment variables.","tags":["v1_apps"]},"put":{"description":"Sets exactly the given variables (others are removed) and redeploys the\napp.","operationId":"replace_app_env","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Env"}}},"description":"An app's environment variables.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Env"}}},"description":"The app's environment variables now","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"An invalid variable name or value, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"The environment is managed in git"},"422":{"description":"Missing or unknown body fields"},"423":{"description":"The cluster is suspended"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Replace an app's environment variables.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/http-settings":{"get":{"description":"","operationId":"get_app_http_settings","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpSettingsResponse"}}},"description":"The app's HTTP settings","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or app id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"App not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get an app's HTTP settings (defaults until changed).","tags":["v1_apps"]},"patch":{"description":"A deployed app's HTTP routes are re-applied right away (no redeploy).","operationId":"update_app_http_settings","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHttpSettingsRequest"}}},"description":"The settings to change; omitted fields keep their value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpSettingsResponse"}}},"description":"The app's HTTP settings now","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed ids or JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only"},"404":{"description":"App not found"},"422":{"description":"Invalid settings"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Change some of an app's HTTP settings; omitted fields keep their value.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/logs":{"get":{"description":"Cursor paginated: pass `next_cursor` back as `cursor`, with the same\n`since` and `until`, until `has_more` is false. Lines are kept for the\ncluster's log retention. There is no live tail on this API.","operationId":"get_app_logs","parameters":[{"description":"`next_cursor` of the previous page.","in":"query","name":"cursor","schema":{"description":"`next_cursor` of the previous page.","type":["string","null"]},"style":"form"},{"description":"Lines per page, 1 to 1000 (default 100).","in":"query","name":"limit","schema":{"description":"Lines per page, 1 to 1000 (default 100).","format":"uint32","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Only lines of this pod.","in":"query","name":"pod","schema":{"description":"Only lines of this pod.","type":["string","null"]},"style":"form"},{"description":"Start of the range (RFC 3339, inclusive). Default: an hour before `until`.","in":"query","name":"since","schema":{"description":"Start of the range (RFC 3339, inclusive). Default: an hour before `until`.","format":"date-time","type":["string","null"]},"style":"form"},{"description":"End of the range (RFC 3339, exclusive). Default: now. Pass it when\n paging, so every page reads the same range. At most 31 days after `since`.","in":"query","name":"until","schema":{"description":"End of the range (RFC 3339, exclusive). Default: now. Pass it when\n paging, so every page reads the same range. At most 31 days after `since`.","format":"date-time","type":["string","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The application UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AppLogsPage"}}},"description":"A page of log lines","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid range or limit"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Cluster or application not found"},"422":{"description":"Unknown or malformed query parameter or cursor"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Query an app's container logs over a time range, oldest first.","tags":["v1_logs"]}},"/v1/clusters/{cluster_id}/apps/{app_id}/scale":{"put":{"description":"","operationId":"scale_app","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The app UUID","in":"path","name":"app_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Scale"}}},"description":"How many pods an app runs.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1App"}}},"description":"The scaled app","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the app's environment"},"404":{"description":"App not found"},"409":{"description":"The scale is managed in git"},"422":{"description":"Missing or unknown body fields, or replicas out of range"},"423":{"description":"The cluster is suspended (it can only scale down)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Scale an app to a number of pods.","tags":["v1_apps"]}},"/v1/clusters/{cluster_id}/nodes":{"get":{"description":"The nodes that are not deleted, with their pool's name and addresses.\nOrdered by creation time, oldest first. Cursor paginated.","operationId":"list_cluster_nodes","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Node"}}},"description":"A page of nodes","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster id, invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"Cluster not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List a cluster's nodes.","tags":["v1_clusters"]}},"/v1/clusters/{cluster_id}/projects":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_projects","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Project"}}},"description":"A page of projects","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor, or a malformed cluster id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's user cannot read this cluster"},"404":{"description":"Cluster not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the projects of a cluster.","tags":["v1_projects"]},"post":{"description":"Send an `Idempotency-Key` to make a retry safe.","operationId":"create_project","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateProject"}}},"description":"A project to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Project"}}},"description":"The created project","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid or reserved name, invalid display name, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the cluster's environment"},"404":{"description":"Cluster not found"},"409":{"description":"The name is already taken in the cluster or its environment, or a request with the same Idempotency-Key is in progress"},"422":{"description":"Missing or unknown body fields, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create a project in a cluster.","tags":["v1_projects"]}},"/v1/clusters/{cluster_id}/projects/{project_id}":{"delete":{"description":"A hard delete: the project cannot be recovered.","operationId":"delete_project","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"Project deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or project id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the project's environment"},"404":{"description":"Project not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete a project.","tags":["v1_projects"]},"get":{"description":"","operationId":"get_project","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Project"}}},"description":"The project","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or project id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read this cluster"},"404":{"description":"Project not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one project.","tags":["v1_projects"]},"patch":{"description":"","operationId":"update_project","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateProject"}}},"description":"Changes to a project; at least one field. The name is fixed at creation;\n `isolated` switches the app network.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Project"}}},"description":"The updated project","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid display name, no fields, opening a hosted project, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, its user is not a member of the project's environment, or the field is managed by IaC"},"404":{"description":"Project not found"},"422":{"description":"Unknown body fields (the name cannot change)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Update a project's display name or isolation.","tags":["v1_projects"]}},"/v1/clusters/{cluster_id}/projects/{project_id}/egress":{"get":{"description":"","operationId":"get_project_egress","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectEgressResponse"}}},"description":"The project's outbound settings","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or project id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's user cannot read this project"},"404":{"description":"Cluster or project not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a project's outbound mode and allowlist.","tags":["v1_projects"]},"put":{"description":"Re-applies the network policies of the project's deployed apps. API keys\nneed the write scope; no second-factor check applies to them.","operationId":"update_project_egress","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEgressRequest"}}},"description":"The whole new setting of a scope.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectEgressResponse"}}},"description":"The project's outbound settings now","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed ids or JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a member of the project's environment"},"404":{"description":"Cluster or project not found"},"409":{"description":"The project's egress is managed in git"},"422":{"description":"Invalid settings; `details.errors` lists every problem"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Replace a project's outbound mode and allowlist.","tags":["v1_projects"]}},"/v1/clusters/{cluster_id}/projects/{project_id}/quotas":{"get":{"description":"","operationId":"get_project_quotas","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The project UUID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ProjectQuotas"}}},"description":"The limits and usage","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed cluster or project id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's user cannot read this cluster"},"404":{"description":"Cluster or project not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a project's quota limits and current usage.","tags":["v1_projects"]}},"/v1/clusters/{cluster_id}/secrets":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_cluster_secrets","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Secret"}}},"description":"A page of secrets","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Cluster not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List a cluster's secrets (metadata only, never values).","tags":["v1_secrets"]},"post":{"description":"","operationId":"create_cluster_secret","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateSecret"}}},"description":"Create a secret. The value is stored encrypted and never returned.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The created secret","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body or field"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (BILLING_ACCOUNT_BLOCKED): top up to create"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Cluster not found"},"409":{"description":"A secret with this name already exists in the cluster"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create a cluster secret. The value is write-only: it is never returned.","tags":["v1_secrets"]}},"/v1/clusters/{cluster_id}/secrets/{secret_id}":{"delete":{"description":"","operationId":"delete_cluster_secret","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"Deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Cluster or secret not found"},"409":{"description":"The app the secret was created from is still running"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete a cluster secret.","tags":["v1_secrets"]},"get":{"description":"","operationId":"get_cluster_secret","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The secret","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Cluster or secret not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a cluster secret's metadata (never its value).","tags":["v1_secrets"]}},"/v1/clusters/{cluster_id}/secrets/{secret_id}/value":{"put":{"description":"write-only: it is never returned.","operationId":"set_cluster_secret_value","parameters":[{"description":"The cluster UUID","in":"path","name":"cluster_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SetSecretValue"}}},"description":"A new value for a secret (write-only). It becomes the next version.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The secret with its new version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body, or the value does not fit the secret's file mounts"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (BILLING_ACCOUNT_BLOCKED): top up to create"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Cluster or secret not found"},"409":{"description":"The value conflicts with the secret's file mounts"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Set a cluster secret's value: it becomes the next version. The value is","tags":["v1_secrets"]}},"/v1/domains":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_org_domains","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1OrgDomain"}}},"description":"A page of domains","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read the organization"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the organization's domains.","tags":["v1_domains"]}},"/v1/domains/{domain_id}":{"get":{"description":"","operationId":"get_org_domain","parameters":[{"description":"The domain UUID","in":"path","name":"domain_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1OrgDomain"}}},"description":"The domain","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read the organization"},"404":{"description":"Domain not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get one organization domain and its verification state.","tags":["v1_domains"]}},"/v1/environments/{environment_id}/secret-groups":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated.","operationId":"list_secret_groups","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1SecretGroup"}}},"description":"A page of secret groups","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Environment not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List an environment's secret groups.","tags":["v1_secrets"]},"post":{"description":"","operationId":"create_secret_group","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateSecretGroup"}}},"description":"A new secret group (empty; add members afterwards).","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SecretGroup"}}},"description":"The created group","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body or name"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (BILLING_ACCOUNT_BLOCKED): top up to create"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Environment not found"},"409":{"description":"A group with this name already exists in the environment"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create an empty secret group in the environment.","tags":["v1_secrets"]}},"/v1/environments/{environment_id}/secret-groups/{group_id}":{"get":{"description":"","operationId":"get_secret_group","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret group UUID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SecretGroupDetail"}}},"description":"The group and its members","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Environment or group not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a secret group with its member secrets (metadata only, never values).","tags":["v1_secrets"]}},"/v1/environments/{environment_id}/secret-groups/{group_id}/members":{"post":{"description":"call is safe to repeat.","operationId":"add_secret_group_members","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret group UUID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1AddGroupMembers"}}},"description":"Secrets to add to a group. Secrets already in it are skipped.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GroupMembersAdded"}}},"description":"How many secrets were added","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body, empty list, or a secret this environment cannot inject"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Environment or group not found"},"409":{"description":"A linked app would get two files on one path"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Add secrets to a group. Secrets already in the group are skipped, so the","tags":["v1_secrets"]}},"/v1/environments/{environment_id}/secrets":{"get":{"description":"never values).\n\nOrdered by creation time, oldest first. Cursor paginated.","operationId":"list_environment_secrets","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1Secret"}}},"description":"A page of secrets","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Environment not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List an environment's secrets and those of its clusters (metadata only,","tags":["v1_secrets"]},"post":{"description":"","operationId":"create_environment_secret","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateSecret"}}},"description":"Create a secret. The value is stored encrypted and never returned.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The created secret","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body or field"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (BILLING_ACCOUNT_BLOCKED): top up to create"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Environment not found"},"409":{"description":"A secret with this name already exists in the environment"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create an environment secret. The value is write-only: it is never returned.","tags":["v1_secrets"]}},"/v1/environments/{environment_id}/secrets/{secret_id}":{"delete":{"description":"","operationId":"delete_environment_secret","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"Deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Environment or secret not found (cluster secrets are changed through their cluster)"},"409":{"description":"The app the secret was created from is still running"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete an environment secret.","tags":["v1_secrets"]},"get":{"description":"","operationId":"get_environment_secret","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The secret","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key's scope does not allow this"},"404":{"description":"Environment or secret not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get the metadata of an environment secret or one of its clusters' secrets (never its value).","tags":["v1_secrets"]}},"/v1/environments/{environment_id}/secrets/{secret_id}/value":{"put":{"description":"write-only: it is never returned.","operationId":"set_environment_secret_value","parameters":[{"description":"The environment UUID","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"},{"description":"The secret UUID","in":"path","name":"secret_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SetSecretValue"}}},"description":"A new value for a secret (write-only). It becomes the next version.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Secret"}}},"description":"The secret with its new version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid body, or the value does not fit the secret's file mounts"},"401":{"description":"Missing, invalid or revoked API key"},"402":{"description":"The billing account is blocked (BILLING_ACCOUNT_BLOCKED): top up to create"},"403":{"description":"The key's scope or the caller's role does not allow this"},"404":{"description":"Environment or secret not found (cluster secrets are changed through their cluster)"},"409":{"description":"The value conflicts with the secret's file mounts"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Set an environment secret's value: it becomes the next version. The value is","tags":["v1_secrets"]}},"/v1/hosted-zones":{"get":{"description":"Ordered by creation time, oldest first. Cursor paginated. Empty on an\ninstallation without hosted DNS.","operationId":"list_zones","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1HostedZone"}}},"description":"A page of zones","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read the organization"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"description":"The DNS service failed"}},"security":[{"api_key":[]}],"summary":"List the organization's hosted zones.","tags":["v1_domains"]}},"/v1/hosted-zones/{zone_id}":{"get":{"description":"","operationId":"get_zone","parameters":[{"description":"The zone UUID","in":"path","name":"zone_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1HostedZone"}}},"description":"The zone","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read the organization"},"404":{"description":"Hosted zone not found"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"description":"The DNS service failed"}},"security":[{"api_key":[]}],"summary":"Get one hosted zone.","tags":["v1_domains"]}},"/v1/hosted-zones/{zone_id}/records":{"delete":{"description":"","operationId":"delete_record","parameters":[{"description":"The owner name.","in":"query","name":"name","required":true,"schema":{"description":"The owner name.","type":"string"},"style":"form"},{"description":"The record type.","in":"query","name":"type","required":true,"schema":{"description":"The record type.","type":"string"},"style":"form"},{"description":"The zone UUID","in":"path","name":"zone_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"204":{"description":"The record set was deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`name` or `type` missing"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope, or its owner is not an organization admin"},"404":{"description":"Hosted zone or record set not found"},"409":{"description":"The zone is not verified yet"},"422":{"description":"The record set cannot be deleted"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"description":"The DNS service failed"}},"security":[{"api_key":[]}],"summary":"Delete one record set of a verified hosted zone.","tags":["v1_domains"]},"get":{"description":"Ordered by name, then type. Cursor paginated.","operationId":"list_records","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The zone UUID","in":"path","name":"zone_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1RecordSet"}}},"description":"A page of record sets","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key cannot read the organization"},"404":{"description":"Hosted zone not found"},"409":{"description":"The zone is not verified yet"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"description":"The DNS service failed"}},"security":[{"api_key":[]}],"summary":"List the record sets of a verified hosted zone.","tags":["v1_domains"]},"put":{"description":"","operationId":"put_record","parameters":[{"description":"The zone UUID","in":"path","name":"zone_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1RecordSet"}}},"description":"A record set: every record of one name and type.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ZoneSerial"}}},"description":"The record set was written","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks write scope, or its owner is not an organization admin"},"404":{"description":"Hosted zone not found"},"409":{"description":"The zone is not verified yet, or the set conflicts with another (a CNAME beside other records)"},"422":{"description":"Invalid record set, malformed body or unknown field"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"description":"The DNS service failed"}},"security":[{"api_key":[]}],"summary":"Create or replace one record set of a verified hosted zone.","tags":["v1_domains"]}},"/v1/iac/infra-links":{"get":{"description":"the ones reading exactly that repository directory.","operationId":"list_infra_links","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Only the links reading exactly this repository directory (one\n trailing slash ignored).","in":"query","name":"path","schema":{"description":"Only the links reading exactly this repository directory (one\n trailing slash ignored).","type":["string","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1IacLink"}}},"description":"The links","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid path, limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"422":{"description":"Unknown query parameter"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the organization's infra links, oldest first; with `path`, only","tags":["v1_iac"]}},"/v1/iac/infra-links/{link_id}/plan":{"post":{"description":"that commit would make, computed as the sync computes them, without\napplying or holding anything.","operationId":"plan_infra_link","parameters":[{"description":"The infra link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacCommit"}}},"description":"The commit a plan or sync is for.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacPlan"}}},"description":"The plan","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id, JSON or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only"},"404":{"description":"Link not found"},"422":{"description":"The commit cannot be applied (invalid files, or not descending from the applied commit)"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The repository or the planner is unavailable"},"504":{"description":"Planning timed out"}},"security":[{"api_key":[]}],"summary":"Plan an infra link's `clusters/*.yaml` at a commit: the changes a sync of","tags":["v1_iac"]}},"/v1/iac/infra-links/{link_id}/status":{"get":{"description":"synced last), and every change still held for confirmation.","operationId":"infra_link_status","parameters":[{"description":"The commit to report on. Default: the commit synced last.","in":"query","name":"sha","schema":{"description":"The commit to report on. Default: the commit synced last.","type":["string","null"]},"style":"form"},{"description":"The infra link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacStatus"}}},"description":"The link's state","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"Link not found"},"422":{"description":"Unknown query parameter"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Report an infra link's sync state at a commit (default: the commit","tags":["v1_iac"]}},"/v1/iac/infra-links/{link_id}/sync":{"post":{"description":"that commit (never the branch tip), holding changes that need\nconfirmation. Poll `status_url` for the outcome.\n\nThe commit must be on the linked branch and descend from the commit the\nlink applied last, or the sync fails.","operationId":"sync_infra_link","parameters":[{"description":"The infra link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacCommit"}}},"description":"The commit a plan or sync is for.","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacSyncQueued"}}},"description":"The sync is queued","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id, JSON or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user is not a team admin"},"404":{"description":"Link not found"},"409":{"description":"The link is broken (its repository is gone or unreadable)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Sync an infra link to a commit: applies `clusters/*.yaml` exactly as of","tags":["v1_iac"]}},"/v1/iac/project-links":{"get":{"description":"with `path`, only the ones reading exactly that repository directory.","operationId":"list_project_links","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Only the links reading exactly this repository directory (one\n trailing slash ignored).","in":"query","name":"path","schema":{"description":"Only the links reading exactly this repository directory (one\n trailing slash ignored).","type":["string","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_V1IacLink"}}},"description":"The links","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid path, limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"422":{"description":"Unknown query parameter"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the organization's project links the key may read, oldest first;","tags":["v1_iac"]}},"/v1/iac/project-links/{link_id}/plan":{"post":{"description":"a sync of that commit would make, computed as the sync computes them,\nwithout applying anything.","operationId":"plan_project_link","parameters":[{"description":"The project link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacCommit"}}},"description":"The commit a plan or sync is for.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacPlan"}}},"description":"The plan","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id, JSON or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only"},"404":{"description":"Link not found"},"422":{"description":"The commit cannot be applied (invalid files, or not descending from the applied commit)"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The repository or the planner is unavailable"},"504":{"description":"Planning timed out"}},"security":[{"api_key":[]}],"summary":"Plan a project link's `project.yaml` and `apps/` at a commit: the changes","tags":["v1_iac"]}},"/v1/iac/project-links/{link_id}/status":{"get":{"description":"synced last), and every change still held for confirmation.","operationId":"project_link_status","parameters":[{"description":"The commit to report on. Default: the commit synced last.","in":"query","name":"sha","schema":{"description":"The commit to report on. Default: the commit synced last.","type":["string","null"]},"style":"form"},{"description":"The project link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacStatus"}}},"description":"The link's state","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"404":{"description":"Link not found"},"422":{"description":"Unknown query parameter"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Report a project link's sync state at a commit (default: the commit","tags":["v1_iac"]}},"/v1/iac/project-links/{link_id}/sync":{"post":{"description":"exactly as of that commit (never the branch tip). Poll `status_url` for\nthe outcome.\n\nThe commit must be on the linked branch and descend from the commit the\nlink applied last, or the sync fails.","operationId":"sync_project_link","parameters":[{"description":"The project link UUID","in":"path","name":"link_id","required":true,"schema":{"format":"uuid","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacCommit"}}},"description":"The commit a plan or sync is for.","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1IacSyncQueued"}}},"description":"The sync is queued","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed id, JSON or commit id"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or its user cannot deploy to the environment"},"404":{"description":"Link not found"},"409":{"description":"The link is broken (its repository is gone or unreadable)"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Sync a project link to a commit: applies `project.yaml` and `apps/`","tags":["v1_iac"]}},"/v1/key-audit-events":{"get":{"description":"call the key service handled (with its result, never its payload).\n\nNeeds the `admin` permission.","operationId":"list_key_audit_events","parameters":[{"description":"Only events of this actor: `user:<id>`, `apikey:<id>` or\n `system:<name>` (`system:kms-scheduler` and `system:kms-sweeper` are\n the scheduled rotations and destroys).","in":"query","name":"actor","schema":{"description":"Only events of this actor: `user:<id>`, `apikey:<id>` or\n `system:<name>` (`system:kms-scheduler` and `system:kms-sweeper` are\n the scheduled rotations and destroys).","type":["string","null"]},"style":"form"},{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Only events of this key id.","in":"query","name":"key","schema":{"description":"Only events of this key id.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Only this operation, such as `key.rotate` or `decrypt`.","in":"query","name":"op","schema":{"description":"Only this operation, such as `key.rotate` or `decrypt`.","type":["string","null"]},"style":"form"},{"description":"Only events at or after this time.","in":"query","name":"since","schema":{"description":"Only events at or after this time.","format":"date-time","type":["string","null"]},"style":"form"},{"description":"Only events before this time.","in":"query","name":"until","schema":{"description":"Only events before this time.","format":"date-time","type":["string","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_AuditOut"}}},"description":"A page of events","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid filter, limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the admin permission"},"404":{"description":"Key not found"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail cannot be read right now"}},"security":[{"api_key":[]}],"summary":"List audit events, newest first: control changes and every data-plane","tags":["v1_keys"]}},"/v1/key-grants":{"get":{"description":"A grant lets an API key use a key or a whole ring for one permission.\nWithout a grant a key is denied. Managed in the dashboard only.","operationId":"list_key_grants","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_Grant"}}},"description":"A page of grants","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List the organization's key grants.","tags":["v1_keys"]}},"/v1/key-rings":{"get":{"description":"","operationId":"list_key_rings","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_Ring"}}},"description":"A page of rings","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit or cursor"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List key rings.","tags":["v1_keys"]},"post":{"description":"Needs the `create` permission, or `admin`. Takes an `Idempotency-Key`.","operationId":"create_key_ring","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRing"}}},"description":"Create a key ring.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ring"}}},"description":"The created ring","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid name or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the permission"},"409":{"description":"The name is taken, or a request with the same Idempotency-Key is in progress"},"422":{"description":"The ring quota is reached, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create a key ring.","tags":["v1_keys"]}},"/v1/key-rings/{ring}":{"delete":{"description":"","operationId":"delete_key_ring","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Deleted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the admin permission"},"404":{"description":"Ring not found"},"409":{"description":"The ring still has keys"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Delete an empty key ring.","tags":["v1_keys"]},"get":{"description":"","operationId":"get_key_ring","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RingDetail"}}},"description":"The ring","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"404":{"description":"Ring not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a key ring by id or name.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys":{"get":{"description":"","operationId":"list_keys","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Only keys with this label, as `name:value`.","in":"query","name":"label","schema":{"description":"Only keys with this label, as `name:value`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_KeyOut"}}},"description":"A page of keys","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit, cursor or label"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"404":{"description":"Ring not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List a ring's keys.","tags":["v1_keys"]},"post":{"description":"The key starts with one enabled version, the primary. Needs the `admin`\npermission, or `create` plus an `admin` grant on the ring. Takes an\n`Idempotency-Key`.","operationId":"create_key","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKey"}}},"description":"Create a key.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyOut"}}},"description":"The created key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid name, rotation period or labels, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the permission"},"404":{"description":"Ring not found"},"409":{"description":"The name is taken, or a request with the same Idempotency-Key is in progress"},"422":{"description":"The key quota is reached, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Create a key in a ring.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}":{"get":{"description":"","operationId":"get_key","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyOut"}}},"description":"The key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"404":{"description":"Ring or key not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Get a key with its versions' summary.","tags":["v1_keys"]},"patch":{"description":"Needs the `admin` permission. The destroy switch is changed in the\ndashboard only.","operationId":"patch_key","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchKey"}}},"description":"Change a key's rotation period or labels.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyOut"}}},"description":"The updated key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid rotation period or labels, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring or key not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Change a key's rotation period or labels.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/cancel-destroy":{"post":{"description":"Every version goes back to the state it had before the key was scheduled.","operationId":"cancel_destroy_key","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyOut"}}},"description":"The key, with `destroy_at` cleared","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, lacks the admin permission, or the key does not allow destruction"},"404":{"description":"Ring or key not found"},"409":{"description":"`key_not_pending_destroy`: the key is not scheduled for destruction, or its destruction is already due"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Cancel a key's scheduled destruction.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/decrypt":{"post":{"description":"Needs the `decrypt` permission and a grant. Uses whichever version made\nthe ciphertext, if it is still enabled.","operationId":"decrypt","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptBody"}}},"description":"Decrypt a ciphertext.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptOut"}}},"description":"The plaintext","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid base64 or context, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or lacks the permission or a grant"},"404":{"description":"Ring or key not found"},"409":{"description":"The version is disabled or destroyed"},"413":{"description":"The ciphertext is too large"},"422":{"description":"The ciphertext or context does not match"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail is unavailable"}},"security":[{"api_key":[]}],"summary":"Decrypt a ciphertext made by `encrypt`.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/decrypt-data-key":{"post":{"description":"Needs the `decrypt` permission and a grant.","operationId":"decrypt_data_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnwrapBody"}}},"description":"Unwrap a data key.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnwrapOut"}}},"description":"The plaintext data key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid base64 or context, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or lacks the permission or a grant"},"404":{"description":"Ring or key not found"},"409":{"description":"The version is disabled or destroyed"},"422":{"description":"The wrapped key or context does not match"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail is unavailable"}},"security":[{"api_key":[]}],"summary":"Unwrap a data key made by `generate-data-key`.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/encrypt":{"post":{"description":"Needs the `encrypt` permission and a grant. `plaintext` and the\nreturned `ciphertext` are base64. `context` is authenticated and must be\nthe same when decrypting.","operationId":"encrypt","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncryptBody"}}},"description":"Encrypt up to 64 KiB.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncryptOut"}}},"description":"The ciphertext","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid base64 or context, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or lacks the permission or a grant"},"404":{"description":"Ring or key not found"},"409":{"description":"The key is pending destruction"},"413":{"description":"The plaintext is larger than 64 KiB"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail is unavailable"}},"security":[{"api_key":[]}],"summary":"Encrypt up to 64 KiB with the key's primary version.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/generate-data-key":{"post":{"description":"Needs the `generate_data_key` permission and a grant.","operationId":"generate_data_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataKeyBody"}}},"description":"Generate a data key.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataKeyOut"}}},"description":"The plaintext and wrapped data key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid context, `bytes` other than 32, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or lacks the permission or a grant"},"404":{"description":"Ring or key not found"},"409":{"description":"The key is pending destruction"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail is unavailable"}},"security":[{"api_key":[]}],"summary":"Make a 32-byte data key and its wrapped form (envelope encryption).","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/rewrap":{"post":{"description":"Needs `decrypt` on this key and, with `destination_key`, `encrypt` on\nthe destination, each with a grant. The plaintext never leaves the\nservice.","operationId":"rewrap","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewrapBody"}}},"description":"Re-encrypt a wrapped data key under the current primary version (or under\n another key of the same organization).","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewrapOut"}}},"description":"The new wrapped key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid base64 or context, or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, or lacks the permission or a grant"},"404":{"description":"Ring, key or destination not found"},"409":{"description":"The version is disabled or destroyed"},"422":{"description":"The wrapped key or context does not match"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The audit trail is unavailable"}},"security":[{"api_key":[]}],"summary":"Wrap a data key again under the primary version, or `destination_key`.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/rotate":{"post":{"description":"Needs the `admin` permission. Takes an `Idempotency-Key`.","operationId":"rotate_key","parameters":[{"description":"Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.","in":"header","name":"Idempotency-Key","schema":{"type":"string"},"style":"simple"},{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"The new version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring or key not found"},"409":{"description":"The key is pending destruction, or a request with the same Idempotency-Key is in progress"},"422":{"description":"The version quota is reached, or an Idempotency-Key reused with a different body"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Rotate a key: a new primary version.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/schedule-destroy":{"post":{"description":"Every version, the primary included, is scheduled in one step and the key\nstops encrypting and decrypting. The delay is 24 h to 30 d (7 d by\ndefault); until then the destruction can be cancelled.","operationId":"schedule_destroy_key","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestroyBody"}}},"description":"Schedule destruction after a delay.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyDestroyOut"}}},"description":"The key, with `destroy_at` set, and the versions now scheduled","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid delay or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, lacks the admin permission, or the key does not allow destruction"},"404":{"description":"Ring or key not found"},"409":{"description":"`key_pending_destroy`: the key is already scheduled for destruction"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Schedule the destruction of a key.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/set-primary":{"post":{"description":"","operationId":"set_primary","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPrimary"}}},"description":"Make a version the primary one.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyOut"}}},"description":"The updated key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring, key or version not found"},"409":{"description":"The version is not enabled"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Make another version the primary one.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/versions":{"get":{"description":"","operationId":"list_versions","parameters":[{"description":"Opaque cursor from the previous page's `next_cursor`.","in":"query","name":"cursor","schema":{"description":"Opaque cursor from the previous page's `next_cursor`.","type":["string","null"]},"style":"form"},{"description":"Page size, 1 to 100 (default 25).","in":"query","name":"limit","schema":{"description":"Page size, 1 to 100 (default 25).","format":"uint","minimum":0,"type":["integer","null"]},"style":"form"},{"description":"Only versions in this state: `enabled`, `disabled`, `destroy_scheduled` or `destroyed`.","in":"query","name":"state","schema":{"description":"Only versions in this state: `enabled`, `disabled`, `destroy_scheduled` or `destroyed`.","type":["string","null"]},"style":"form"},{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Page_for_VersionOut"}}},"description":"A page of versions","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid limit, cursor or state"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"404":{"description":"Ring or key not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"List a key's versions, newest first.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/versions/{version}/cancel-destroy":{"post":{"description":"","operationId":"cancel_destroy","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The version number","in":"path","name":"version","required":true,"schema":{"format":"uint32","minimum":0,"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"The version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring, key or version not found"},"409":{"description":"The version is not scheduled for destruction"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Cancel a scheduled destruction; the version returns as disabled.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/versions/{version}/disable":{"post":{"description":"The primary version cannot be disabled; rotate first.","operationId":"disable_version","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The version number","in":"path","name":"version","required":true,"schema":{"format":"uint32","minimum":0,"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"The version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring, key or version not found"},"409":{"description":"The version is the primary or cannot change state"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Disable a version: it can no longer encrypt or decrypt, until enabled.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/versions/{version}/enable":{"post":{"description":"","operationId":"enable_version","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The version number","in":"path","name":"version","required":true,"schema":{"format":"uint32","minimum":0,"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"The version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only or lacks the admin permission"},"404":{"description":"Ring, key or version not found"},"409":{"description":"The version cannot change state"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Enable a disabled version.","tags":["v1_keys"]}},"/v1/key-rings/{ring}/keys/{key}/versions/{version}/schedule-destroy":{"post":{"description":"The delay is 1 to 30 days (default 7). Needs the `admin` permission and\n`allow_destroy` on the key. Destroyed key material cannot be recovered.","operationId":"schedule_destroy","parameters":[{"description":"The ring id or name","in":"path","name":"ring","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The key id or name","in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The version number","in":"path","name":"version","required":true,"schema":{"format":"uint32","minimum":0,"type":"integer"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestroyBody"}}},"description":"Schedule destruction after a delay.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"The version","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid delay or malformed JSON"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key is read-only, lacks the admin permission, or the key does not allow destruction"},"404":{"description":"Ring, key or version not found"},"409":{"description":"The version cannot be destroyed in its state"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Schedule a version's destruction after a delay.","tags":["v1_keys"]}},"/v1/key-subject-salt":{"get":{"description":"organization's lifetime. SDKs name a per-subject key\n`HMAC-SHA256(salt, subject)` so end-user ids never reach Keys in clear.\nNeeds any Keys permission; never cached.","operationId":"get_key_subject_salt","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubjectSaltOut"}}},"description":"The salt","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key holds no Keys permission"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"The organization's subject-key salt: 32 random bytes, fixed for the","tags":["v1_keys"]}},"/v1/key-usage":{"get":{"description":"","operationId":"get_key_usage","parameters":[{"description":"Only this key id.","in":"query","name":"key","schema":{"description":"Only this key id.","type":["string","null"]},"style":"form"},{"description":"The month as `YYYY-MM` (default: the current month).","in":"query","name":"month","schema":{"description":"The month as `YYYY-MM` (default: the current month).","type":["string","null"]},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}},"description":"The usage","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid month"},"401":{"description":"Missing, invalid or revoked API key"},"403":{"description":"The key lacks the permission"},"404":{"description":"Key not found"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"A month's Keys usage: version-hours and operations.","tags":["v1_keys"]}},"/v1/pricing":{"get":{"description":"No API key: the list holds no organization data. Every amount is a\ndecimal string in EUR, excluding VAT. Cached for a minute.","operationId":"get_pricing","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Pricing"}}},"description":"The list prices in force"},"429":{"$ref":"#/components/responses/AddressRateLimited"},"500":{"description":"The prices could not be read"}},"security":[],"summary":"The public list prices of Actions runners, image builds and logs.","tags":["v1_pricing"]}},"/v1/whoami":{"get":{"description":"Read-only and allowed for every scope, so automation can check that its\nkey may write before it starts a change.","operationId":"whoami","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Whoami"}}},"description":"The calling key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Missing, invalid or revoked API key"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"api_key":[]}],"summary":"Describe the calling API key: its id, organization and scope.","tags":["v1_whoami"]}}},"security":[{"api_key":[]}],"servers":[{"description":"A-Line.cloud API","url":"https://api.a-line.cloud"}]}