Skip to Content

Schemas

Request and response bodies of the v1 API.

Request and response bodies, in name order.

AppEgressResponse

An app's outbound settings.

effective_mode

Type: string, required.

The mode in force: mode, or else inherited_mode.

inherited_mode

Type: string, required.

The project's mode, used while mode is null.

inherited_rules

Type: list of RuleResponse, required.

The project's rules, which also apply to the app.

mode

Type: string, optional.

null follows the project.

rules

Type: list of RuleResponse, required.

The app's own allowlist rules.

AppStatus

The derived app status.

desired

Type: integer, optional, format int32.

Desired pods, when known.

detail

Type: string, optional.

A human detail (scheduler message, deploy error).

kind

Type: AppStatusKind, required.

What the app is doing.

ready

Type: integer, optional, format int32.

Ready pods, when observed.

reason

Type: string, optional.

A short machine reason, e.g. FailedScheduling, CrashLoopBackOff, ImagePullBackOff, OOMKilled.

AppStatusKind

What the app is doing, for display.

Type: "pending" or "setup" or "building" or "deploying" or "starting" or "running" or "running_previous" or "failed" or "scaled_to_zero" or "stopping" or "stopped" or "deleting".

BackupRunInfo

The last recorded backup run, for the app or for one target.

Without it "backups are on" was the only thing the platform could say: a CronJob whose pod never started looked exactly like a healthy schedule.

error

Type: string, optional.

Failure message when it failed.

finished_at

Type: string, optional, format date-time.

When it ended, while running null.

kind

Type: string, required.

backup or mirror.

started_at

Type: string, required, format date-time.

When it started.

status

Type: string, required.

running, succeeded or failed.

storage_id

Type: string, optional, format uuid.

Target the run wrote to, when it is still known.

trigger

Type: string, required.

manual or scheduled.

BlockedDestinationResponse

A destination the app's egress policy recently blocked.

count

Type: integer, required, format uint64.

Logged blocks in the last 24 hours (at most one per destination per 5 minutes per node).

fqdn

Type: string, optional.

DNS name the app looked up for ip, when known.

ip

Type: string, required.

Destination IP address.

last_seen

Type: string, required, format date-time.

Last logged block.

port

Type: integer, required, format uint16.

Destination port.

protocol

Type: string, required.

tcp or udp.

BlockedEgressResponse

The app's recently blocked destinations, most recent first.

destinations

Type: list of BlockedDestinationResponse, required.

At most 20, from the last 24 hours.

ContentNegotiation

The http.content_negotiation settings.

enabled

Type: boolean, optional, default false.

Answer Accept-preferred twins of extensionless pages (default off).

markdown_tokens

Type: boolean, optional, default true.

Send x-markdown-tokens (a token estimate made at deploy) on Markdown twins (default on).

types

Type: list of NegotiationType, optional, default ["markdown","json","yaml","text"].

The types served (default all of them).

Coop

Cross-Origin-Opener-Policy.

Type: "off" or "same_origin_allow_popups" or "same_origin".

CspMode

Whether the CSP is sent, and under which header.

Type: "off" or "report_only" or "enforce".

CspPreset

Which CSP policy is sent.

Type: "basic" or "strict" or "custom".

CsrfMode

Whether cross-site browser writes are refused.

Type: "off" or "report_only" or "enforce".

DependencyCreate

The new service app of a create dependency.

instances

Type: integer, optional, format int32.

Its instances (default 1).

name

Type: string, optional.

Its name (default <app>-<dependency>).

storage_class

Type: string, optional.

Its storage class (default the cluster's).

storage_size

Type: string, optional.

Its storage size, e.g. 10Gi (default the template's).

version

Type: string, optional.

Its version (default the highest the dependency allows).

DependencyMode

How a dependency is met.

Type: "create" or "existing" or "none".

DependencyRequest

One dependency of the template, as the create request meets it.

confirm_admin

Type: boolean, optional.

Keep admin on a database that already exists (else readwrite).

create

Type: DependencyCreate, optional.

create: the new service app's settings.

database

Type: string, optional.

Postgres: the logical database (default the template's, else the app name); a new one is created when missing.

existing_app_id

Type: string, optional, format uuid.

existing: the service app (same project).

mode

Type: DependencyMode, required.

Create, use existing, or leave out.

name

Type: string, required.

The template dependency's name.

role

Type: string, optional.

The role preset (default the template's).

HeaderDto

One custom response header.

name

Type: string, required.

Header name: 1-64 letters, digits or -.

value

Type: string, required.

Header value: up to 1024 visible ASCII characters, spaces and tabs.

HttpSettingsResponse

An app's HTTP settings.

compression

Type: boolean, required.

Compress responses (zstd, br or gzip, as the client accepts).

content_negotiation

Type: ContentNegotiation, required.

Static sites: answer extensionless pages with their Markdown, JSON, YAML or text twin when Accept prefers it over HTML.

coop

Type: Coop, required.

Cross-Origin-Opener-Policy.

csp_mode

Type: CspMode, required.

Content-Security-Policy: off, report only or enforced.

csp_policy

Type: string, optional.

The custom CSP (used with preset custom).

csp_preset

Type: CspPreset, required.

Which CSP is sent: the basic or strict preset, or csp_policy.

csp_report_uri

Type: string, optional.

HTTPS URL appended to the CSP as report-uri.

csrf_exempt_paths

Type: list of string, required.

Path prefixes that skip the check (webhooks, SAML ACS).

csrf_mode

Type: CsrfMode, required.

Cross-site request protection: off, report only (marks requests X-Aline-Csrf: would-block) or enforced (plain 403).

csrf_trusted_origins

Type: list of string, required.

Exact origins whose browser writes are always let through.

custom_headers

Type: list of HeaderDto, required.

Extra response headers, at most 32.

header_frame_options

Type: boolean, required.

X-Frame-Options: SAMEORIGIN.

header_nosniff

Type: boolean, required.

X-Content-Type-Options: nosniff.

header_referrer_policy

Type: boolean, required.

Referrer-Policy: strict-origin-when-cross-origin.

hsts

Type: boolean, required.

Send Strict-Transport-Security on HTTPS responses.

hsts_include_subdomains

Type: boolean, required.

Add includeSubDomains to the HSTS header.

hsts_max_age

Type: integer, required, format int64.

HSTS max-age in seconds.

https_redirect

Type: boolean, required.

Redirect plain HTTP to HTTPS once a certificate is issued.

max_body_bytes

Type: integer, optional, format int64.

Largest accepted request body in bytes; null for no limit.

permissions_policy

Type: PermissionsPolicyMode, required.

Permissions-Policy: off, a preset or permissions_policy_custom.

permissions_policy_custom

Type: string, optional.

The custom Permissions-Policy (used with mode custom).

www_redirect

Type: WwwRedirectMode, required.

Redirect between a host and its www. form.

LastDeploy

The latest deploy attempt of an app.

at

Type: string, required, format date-time.

When it finished, or was created while still running.

build_id

Type: string, required, format uuid.

The build behind the deploy.

failure_stage

Type: string, optional.

Where it failed: build, push or rollout.

reason

Type: string, optional.

Why it failed.

status

Type: string, required.

The build's status, e.g. succeeded, failed.

NegotiationType

A representation a page can be negotiated into.

Type: "markdown" or "json" or "yaml" or "text".

PageQuery

Query parameters every v1 list accepts.

cursor

Type: string, optional.

Opaque cursor from the previous page's next_cursor.

limit

Type: integer, optional, format uint.

Page size, 1 to 100 (default 25).

PermissionsPolicyMode

Which Permissions-Policy is sent.

Type: "off" or "basic" or "strict" or "custom".

ProjectEgressResponse

A project's outbound settings.

mode

Type: string, required.

public (any public address except TCP 25, plus the allowlist) or isolated (only the allowlist and the platform endpoints).

rules

Type: list of RuleResponse, required.

The project's allowlist, which also applies to every app in it.

RecordSetKey

Which record set to delete.

name

Type: string, required.

The owner name.

type

Type: string, required.

The record type.

RuleRequest

A rule as sent.

description

Type: string, optional, default null.

Free text shown next to the rule, at most 200 characters.

kind

Type: string, required.

fqdn or cidr.

port

Type: integer, optional, default null, format int64.

1-65535; omit for all ports.

protocol

Type: string, optional, default null.

tcp or udp; omit for both.

value

Type: string, required.

Domain (api.example.com, *.example.com) or CIDR / bare IP.

RuleResponse

A stored rule.

description

Type: string, optional.

Free text set with the rule.

id

Type: string, required, format uuid.

The rule's id.

kind

Type: string, required.

fqdn or cidr.

port

Type: integer, optional, format int32.

The allowed port; null allows all ports.

private

Type: boolean, required.

The CIDR reaches private or otherwise non-public address space.

protocol

Type: string, optional.

tcp or udp; null allows both.

value

Type: string, required.

Domain or CIDR, as stored.

RunProgress

Where a manual backup run stands.

error

Type: string, optional.

The first failure, when it failed.

run_id

Type: string, required, format uuid.

The run, as returned when it was requested.

runs

Type: list of BackupRunInfo, required.

One row per object and target the run wrote to.

status

Type: string, required.

pending (nothing recorded yet), running, succeeded or failed.

UpdateEgressRequest

The whole new setting of a scope.

mode

Type: string, optional, default null.

public or isolated. An app may send null to follow its project.

rules

Type: list of RuleRequest, optional.

Replaces the scope's allowlist.

UpdateHttpSettingsRequest

The settings to change; omitted fields keep their value.

compression

Type: boolean, optional.

Compress responses.

content_negotiation

Type: ContentNegotiation, optional.

Replaces the content negotiation choice (static sites); omitted keys inside take their defaults.

coop

Type: Coop, optional.

Cross-Origin-Opener-Policy.

csp_mode

Type: CspMode, optional.

Content-Security-Policy: off, report only or enforced.

csp_policy

Type: string, optional, default null.

null or blank clears it.

csp_preset

Type: CspPreset, optional.

Which CSP is sent: the basic or strict preset, or csp_policy.

csp_report_uri

Type: string, optional, default null.

null or blank clears it.

csrf_exempt_paths

Type: list of string, optional.

Replaces the list: at most 20 path prefixes like /hooks, each up to 256 characters; / is refused.

csrf_mode

Type: CsrfMode, optional.

Cross-site request protection: off, report only or enforced.

csrf_trusted_origins

Type: list of string, optional.

Replaces the list: at most 20 exact origins like https://www.example.com (http:// only when the app serves plain HTTP).

custom_headers

Type: list of HeaderDto, optional.

Replaces the whole list (at most 32 headers).

header_frame_options

Type: boolean, optional.

X-Frame-Options: SAMEORIGIN.

header_nosniff

Type: boolean, optional.

X-Content-Type-Options: nosniff.

header_referrer_policy

Type: boolean, optional.

Referrer-Policy: strict-origin-when-cross-origin.

hsts

Type: boolean, optional.

Send Strict-Transport-Security on HTTPS responses.

hsts_include_subdomains

Type: boolean, optional.

Add includeSubDomains to the HSTS header.

hsts_max_age

Type: integer, optional, format int64.

HSTS max-age in seconds, 0 to 63072000 (two years).

https_redirect

Type: boolean, optional.

Redirect plain HTTP to HTTPS once a certificate is issued.

max_body_bytes

Type: integer, optional, default null, format int64.

null removes the limit.

permissions_policy

Type: PermissionsPolicyMode, optional.

Permissions-Policy: off, a preset or permissions_policy_custom.

permissions_policy_custom

Type: string, optional, default null.

null or blank clears it.

www_redirect

Type: WwwRedirectMode, optional.

Redirect between a host and its www. form.

V1AcmeDelegation

An app domain's ACME challenge delegation.

cname_target

Type: string, required.

The CNAME's target.

domain_id

Type: string, required, format uuid.

The organization domain it belongs to.

error

Type: string, optional.

What the last check found.

id

Type: string, required, format uuid.

The delegation's id.

last_checked_at

Type: string, optional, format date-time.

When the CNAME was last checked (RFC 3339, UTC).

record_name

Type: string, required.

The record name (_acme-challenge.<domain>).

status

Type: string, required.

verified, failed (see error) or pending.

V1ActionsCache

The org cache, as the public API shows it. Sizes in bytes (1 GB = 1e9), amounts in EUR.

actions_bytes

Type: integer, required, format int64.

Bytes of actions/cache entries.

build_cache_bytes

Type: integer, required, format int64.

Bytes of the BuildKit layer cache of the org's builds.

custom_limit

Type: boolean, required.

The org picked its own limit (otherwise the free amount).

demo

Type: boolean, required.

A demo organization: a fixed 1 GB limit, never billed.

free_bytes

Type: integer, required, format int64.

Never billed.

limit_bytes

Type: integer, required, format int64.

What the cache is held to; unused for 7 days or over it, the oldest items are removed.

limit_monthly_estimate

Type: string, required.

EUR a month with the cache filled to the limit.

max_bytes

Type: integer, required, format int64.

The highest limit the org may pick.

monthly_estimate

Type: string, required.

EUR a month at the current usage.

price_per_gb_month

Type: string, optional.

EUR per GB-month above the free part; absent when unpriced.

total_bytes

Type: integer, required, format int64.

Both together: what the limit holds.

V1ActionsPricing

GitHub Actions runners.

billing

Type: V1Billing, required.

How a job's compute is metered.

cache

Type: V1CachePricing, required.

The cache quota and its price.

concurrency_tiers

Type: list of V1ConcurrencyTier, required.

Per-organization caps by paid usage, lowest first.

custom_shapes

Type: V1CustomShapes, optional.

Custom shape bounds; null: only sizes are served.

disk_add_ons

Type: list of V1DiskAddOn, required.

The disk add-ons on offer.

extra_disk_billing

Type: V1Billing, required.

How the extra disk is metered.

extra_disk_gb_hour

Type: string, required.

Price per GB-hour of extra local disk (the disk add-ons).

free_minutes_per_month

Type: integer, optional, format uint32.

Free vCPU-minutes per month; null: none.

max_job_minutes

Type: integer, optional, format int32.

The platform-wide cap on one job's billed minutes; null: none (an organization may set its own limit).

memory_included_gb_per_vcpu

Type: integer, optional, format uint32.

Memory each vCPU comes with, GB (the price is per vCPU only).

memory_supplement_gb_minute

Type: string, optional.

Price per GB-minute of memory beyond the included part; null: no memory supplement, memory is fixed per size.

sizes

Type: list of V1ActionsSize, required.

Every size a label can ask for, smallest first.

vcpu_minute

Type: string, required.

Price of one vCPU-minute.

V1ActionsSize

One Actions runner size a runs-on label can ask for.

arch

Type: list of string, required.

CPU architectures served.

disk_gb

Type: integer, required, format uint32.

Local disk included in the price, GB.

label

Type: string, required.

The runs-on label (a-line-2vcpu).

memory_gb

Type: integer, required, format uint32.

Memory in GB.

price_per_minute

Type: string, required.

Price of one minute of a job on this size (vCPUs x the vCPU-minute price).

vcpu

Type: integer, required, format uint32.

vCPUs.

V1AddDomain

A domain to add to an app.

behind_proxy

Type: boolean, optional, default false.

Served through a CDN or reverse proxy (HTTP and HTTPS routes only). Ownership is still proven by the TXT verification.

dns_target

Type: V1DnsTarget, optional, default "a_records".

How DNS points at the cluster (default a_records).

domain

Type: string, required.

The host name; an organization domain must cover it.

external_port

Type: integer, optional, default 443, format int32.

The port the load balancer listens on (default 443).

path_prefix

Type: string, optional, default "/".

The path prefix to route (default /).

pending_verification

Type: boolean, optional, default false.

Accept a host only a domain still being verified covers; it routes once that verifies.

port

Type: integer, required, format int32.

The container port to route to.

protocol

Type: string, optional, default "https".

http, https (default), tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol

Type: boolean, optional, default false.

Prefix each connection with a PROXY protocol header carrying the client address (TCP only; the app must expect the header).

service_name

Type: string, optional, default null.

A Kubernetes service to target instead of the app's own.

strip_prefix

Type: boolean, optional, default false.

Strip the prefix before forwarding (default false).

tls_enabled

Type: boolean, optional, default true.

Terminate TLS (default true).

wildcard

Type: boolean, optional, default false.

Also route every subdomain (HTTP(S) only, needs a whole-domain verification).

V1AddGroupMembers

Secrets to add to a group. Secrets already in it are skipped.

secret_ids

Type: list of string, required.

Ids of secrets this environment may inject (its own or its clusters').

V1Amount

An amount in credits: a number or a decimal string ("12.50"), at least 0.

Type: number or string.

V1App

An app, as the public API shows it.

cluster_id

Type: string, required, format uuid.

The cluster the app runs on.

created_at

Type: string, required, format date-time.

When the app was created (RFC 3339, UTC).

deploy_id

Type: string, optional, format uuid.

The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.

expected_image

Type: string, optional.

For a release-pinned app, the image its file names (the repo the release roll fills in); null otherwise.

health_path

Type: string, optional.

HTTP health check path.

id

Type: string, required, format uuid.

The app id.

image

Type: string, optional.

The container image it runs; null until a git app's first build.

image_digest

Type: string, optional.

The content digest (sha256:...) the app's image is pinned to; null for an image given by tag. A deploy of a pinned image is verified by this digest once the deploy succeeded.

last_deploy

Type: LastDeploy, optional.

The latest deploy attempt. A failed rollout while the previous version serves keeps state at running and shows here.

last_deployed_at

Type: string, optional, format date-time.

When the app was last deployed.

name

Type: string, required.

The app's name, unique in its project.

port

Type: integer, optional, format int32.

The main container port.

project_id

Type: string, required, format uuid.

The project the app belongs to.

release_pinned

Type: boolean, required.

The app's linked IaC file pins its image to the release deploy (source: {image, pin: release}): a release roll sets the image, so the app is not deployed by hand.

replicas

Type: integer, required, format int32.

Desired pods.

running_digest

Type: string, optional.

The content digest (sha256:...) the app's pods were last seen running, read from the ready pods' image IDs once a rollout is ready (also for an image given by tag). It can differ from image_digest: a multi-arch pin is the index, the pods run a platform manifest. Null before the first ready rollout or when no pod reported a digest.

serving_build_id

Type: string, optional, format uuid.

The deploy whose image serves traffic; null when none does.

state

Type: string, required.

Lifecycle state, e.g. pending, deploying, running, stopped, failed. New states may be added.

status

Type: AppStatus, required.

Whether it actually runs: state checked against the live pods (ready vs desired) and the last deploy, e.g. failed with reason FailedScheduling when a rollout left nothing ready. New kinds may be added.

template_slug

Type: string, optional.

The catalog template the app was created from, if any.

V1AppDomain

A domain routed to an app.

acme_delegation

Type: V1AcmeDelegation, optional.

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id

Type: string, required, format uuid.

The app it routes to.

behind_proxy

Type: boolean, required.

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header

Type: string, optional.

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at

Type: string, required, format date-time.

When the domain was added (RFC 3339, UTC).

dns_records

Type: list of V1DnsRecord, required.

The records to create at the customer's DNS provider.

dns_target

Type: V1DnsTarget, required.

How DNS points at the cluster.

domain

Type: string, required.

The host name.

external_port

Type: integer, required, format int32.

The port the load balancer listens on.

id

Type: string, required, format uuid.

The domain id.

origin_lock

Type: V1OriginLock, optional.

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix

Type: string, required.

The path prefix routed.

platform

Type: boolean, required.

A hostname the platform issued (temporary URL or generated host).

port

Type: integer, required, format int32.

The container port traffic goes to.

protocol

Type: string, required.

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol

Type: boolean, required.

A TCP port whose connections start with a PROXY protocol header.

route_error

Type: string, optional.

Why routing failed.

route_state

Type: string, required.

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name

Type: string, optional.

The Kubernetes service targeted, when not the app's own.

strip_prefix

Type: boolean, required.

Whether the prefix is stripped before forwarding.

tls_enabled

Type: boolean, required.

Whether TLS is terminated for the host.

tls_error

Type: string, optional.

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at

Type: string, optional, format date-time.

When the certificate expires.

tls_reason

Type: string, optional.

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state

Type: string, optional.

Certificate state: pending, issued, failed, not_applicable or null.

verification

Type: V1PendingVerification, optional.

Set while the host waits on an organization domain to verify.

wildcard

Type: boolean, required.

Also routes every subdomain (*.<domain>).

V1AppLogLine

One container log line of an app.

container

Type: string, required.

The container that logged it.

message

Type: string, required.

The line.

pod

Type: string, required.

The pod that logged it.

severity

Type: string, required.

The severity detected at ingestion (e.g. info, warn, error).

timestamp

Type: string, required, format date-time.

When the line was logged (RFC 3339, UTC, second precision).

V1AppLogsPage

A page of an app's log lines, oldest first.

data

Type: list of V1AppLogLine, required.

The lines, oldest first.

has_more

Type: boolean, required.

More lines in the range follow this page.

next_cursor

Type: string, optional.

Pass as cursor (with the same range) for the next page; null on the last page.

retained_from

Type: string, optional, format date-time.

Lines older than this were removed (by ingest time, so approximate); null when the app lost none.

retained_reason

Type: V1LogRetainedReason, optional.

Why lines before retained_from are gone; null with it.

V1AppLogsQuery

Query parameters of an app log query.

cursor

Type: string, optional.

next_cursor of the previous page.

limit

Type: integer, optional, format uint32.

Lines per page, 1 to 1000 (default 100).

pod

Type: string, optional.

Only lines of this pod.

since

Type: string, optional, format date-time.

Start of the range (RFC 3339, inclusive). Default: an hour before until.

until

Type: string, optional, format date-time.

End of the range (RFC 3339, exclusive). Default: now. Pass it when paging, so every page reads the same range. At most 31 days after since.

V1BackupRunQueued

A backup run that was queued.

run_id

Type: string, required, format uuid.

Follow it at GET .../backups/runs/{run_id}.

V1Billing

How a usage line is metered and rounded, as the billing code does it.

rounding

Type: string, required.

How a run is rounded to that unit and the charge to the cent.

unit

Type: V1BillingUnit, required.

The unit time is counted in.

V1BillingUnit

How a usage line is metered.

Type: "second" or "minute" or "hour".

V1BuildLogsPage

A page of a build's log lines, in order.

complete

Type: boolean, required.

The build has ended, so its log is final.

data

Type: list of string, required.

Complete lines, in order. A running build's unfinished last line is held back.

has_more

Type: boolean, required.

More lines follow, or the build is still running (poll next_cursor).

next_cursor

Type: string, optional.

Pass as cursor for the next page; null once the log is fully read.

V1BuildLogsQuery

Query parameters of a build log query.

cursor

Type: string, optional.

next_cursor of the previous page.

limit

Type: integer, optional, format uint32.

Lines per page, 1 to 5000 (default 500).

V1BuildTier

One image build size tier.

cpu_millis

Type: integer, required, format int32.

CPU a build reserves, in millicores.

id

Type: string, required.

Tier id (small, medium, ...).

is_default

Type: boolean, required.

Whether apps without a choice build with this tier.

label

Type: string, required.

Display name.

memory_mib

Type: integer, required, format int32.

Memory a build reserves, in MiB.

price_per_minute

Type: string, required.

Price of one build minute of this tier.

V1BuildsPricing

Image builds.

billing

Type: V1Billing, required.

How a build is metered.

tiers

Type: list of V1BuildTier, required.

Active tiers, smallest first.

vcpu_minute

Type: string, required.

Price of one vCPU-minute.

V1CachePricing

The Actions cache (shared with the BuildKit build cache).

free_gb

Type: integer, required, format int64.

GB every organization stores for free.

gb_month

Type: string, optional.

Price per GB-month above the free part (730 hours a month, metered hourly); null while no price is set and the cache is not billed.

V1CapacityWait

Servers of one pool waiting for the same reason.

alternatives

Type: list of string, required.

Machine types or locations with stock now (suggestions only).

checked_at

Type: string, optional, format date-time.

When the stock was last checked; null before the first check.

count

Type: integer, required, format int64.

How many servers wait.

location

Type: string, required.

The provider location waited in.

next_check_at

Type: string, optional, format date-time.

When the stock is checked again; null when no check is scheduled.

node_type

Type: string, required.

The machine type waited for.

pool

Type: string, required.

The pool's name.

role

Type: string, required.

The pool's role (control_plane, worker, ...).

since

Type: string, required, format date-time.

When the oldest of them started waiting (RFC 3339, UTC).

status

Type: string, required.

waiting_capacity, awaiting_delivery, blocked_by_control_plane or quota_reached (the provider account quota refused the type: raise it or pick another type). New values may appear.

V1Cluster

A cluster, as the public API shows it.

capacity_wait

Type: list of V1CapacityWait, required.

Servers not created yet, grouped per pool and reason; empty when none wait.

created_at

Type: string, required, format date-time.

When the cluster was created (RFC 3339, UTC).

environment_id

Type: string, required, format uuid.

The environment the cluster belongs to.

id

Type: string, required, format uuid.

The cluster id.

name

Type: string, required.

The cluster's name.

price_confirmation

Type: list of V1PriceConfirmation, required.

Servers held because the price went above the pool's caps.

provider

Type: string, required.

The provider (hetzner, ...). New values may appear.

region

Type: string, required.

The provider region.

state

Type: string, required.

The lifecycle state (provisioning, running, ...). New values may appear.

V1ClusterNetwork

Custom address ranges of a new cluster, fixed for its life.

node_cidr

Type: string, optional, default null.

Node network, Hetzner only: 10.X.0.0/16 (X 1-255) unused by other clusters. Allocated when omitted.

pod_cidr

Type: string, optional, default null.

Pod network: a private (RFC 1918) IPv4 CIDR, /12 to /20. Default 10.244.0.0/16.

service_cidr

Type: string, optional, default null.

Service network: a private IPv4 CIDR, /12 to /24. Default 10.96.0.0/12.

V1ConcurrencyTier

One trust tier of per-organization runner caps: an organization's paid usage over the last 12 months decides which sizes it can run at once.

admin_raisable

Type: boolean, required.

An admin can raise an organization's caps above its tier on request.

max_jobs

Type: integer, optional, format int64.

Runners at once; null: no per-organization cap.

max_vcpus

Type: integer, optional, format int64.

vCPUs of those runners at once; null: no per-organization cap.

min_paid_eur

Type: string, required.

Paid usage over the last 12 months, whole EUR, from which on the tier applies.

V1CreateApp

An app to create from a container image or a catalog template.

dependencies

Type: list of DependencyRequest, optional.

How each dependency of the template is met (a new service app, an existing one of the project, or none for an optional one).

env

Type: map of string, optional, default {}.

Environment variables.

health_path

Type: string, optional, default null.

HTTP health check path.

image

Type: string, optional, default null.

The container image to run. A template app without one gets the template's catalog image.

name

Type: string, required.

The app's name: 1-63 lowercase letters, digits or hyphens, starting and ending with a letter or digit. Unique in the project.

port

Type: integer, optional, default null, format int32.

The main container port.

project_id

Type: string, required, format uuid.

The project to create the app in.

replicas

Type: integer, optional, default null, format int32.

Desired pods, default 1.

template_slug

Type: string, optional, default null.

A catalog template to create the app from.

V1CreateCluster

A cluster to create.

environment_id

Type: string, required, format uuid.

The environment the cluster belongs to.

load_balancers

Type: list of string, optional, default [].

Load balancer type ids for ingress load balancers.

name

Type: string, required.

The cluster's name: 1-64 lowercase letters, digits or hyphens, not reserved. Unique in the organization.

network

Type: V1ClusterNetwork, optional, default null.

Custom address ranges; omitted ranges take the defaults.

pools

Type: list of V1NewPool, required.

The node pools; one must have the control_plane role.

provider

Type: string, required.

The provider (hetzner, ...).

region

Type: string, required.

The provider region (fsn1, ...).

tos_acceptance

Type: V1TosAcceptance, optional, default null.

Acceptance of the provider's current terms of service; required on providers with terms.

V1CreateProject

A project to create.

display_name

Type: string, required.

The name shown in the dashboard, 1-255 characters.

isolated

Type: boolean, optional, default false.

Only explicit app connections may reach an app. Default false; can be switched later. A hosted organization's projects are always isolated.

name

Type: string, required.

The project's name, its Kubernetes namespace: lowercase letters, digits and hyphens, 3-63 characters. Unique in the cluster and its environment.

V1CreateSecret

Create a secret. The value is stored encrypted and never returned.

description

Type: string, optional.

Free text.

injection_mode

Type: string, optional.

env (default), file or both.

mount_path

Type: string, optional.

Where to mount a file/both secret.

name

Type: string, required.

The name, unique within the cluster or environment.

secret_type

Type: string, optional.

opaque (default), database, registry or tls.

value

Type: string, required.

The value (write-only).

write_only

Type: boolean, optional, default false.

Make the key write-only: nobody can read its value back, in the console or the API (apps still receive it). One-way.

V1CreateSecretGroup

A new secret group (empty; add members afterwards).

description

Type: string, optional.

Free text.

name

Type: string, required.

The name, unique within the environment.

V1CustomShapes

Bounds of custom runner shapes. Not offered today (always null): a label must name one of sizes exactly.

max_vcpu

Type: integer, required, format uint32.

Most vCPUs.

min_vcpu

Type: integer, required, format uint32.

Fewest vCPUs.

V1DeleteClusterQuery

The confirmations a cluster delete may need.

acknowledge_commitment

Type: boolean, optional, default false.

Remove committed monthly machines although they stay billed to the end of their term.

acknowledge_iac

Type: boolean, optional, default false.

Delete although a file of the infra link still defines the cluster (the link then proposes creating it again).

confirm

Type: string, optional, default null.

The cluster's name, required when volumes go with it. Deleting volumes needs a signed-in user's step-up: an API key sending it gets 403 step_up_unavailable.

V1DeletedCluster

A cluster accepted for deletion.

id

Type: string, required, format uuid.

The cluster id.

state

Type: string, required.

Always deleting: the servers are removed in the background.

warnings

Type: list of string, required.

What to know about the delete (an infra link file that still defines it, ...).

V1Deploy

A deploy (or build) of an app.

app_id

Type: string, required, format uuid.

The app it deploys.

created_at

Type: string, required, format date-time.

When it was created (RFC 3339, UTC).

error

Type: string, optional.

Why it failed.

failure_stage

Type: string, optional.

Where a failed deploy stopped: build, push or rollout.

finished_at

Type: string, optional, format date-time.

When it finished.

id

Type: string, required, format uuid.

The deploy id.

image

Type: string, optional.

The image it deploys; null while a build has not produced one.

image_digest

Type: string, optional.

Digest of the pushed image.

refusal_code

Type: string, optional.

For a refused build: BILLING_ACCOUNT_BLOCKED (top up the billing account) or SPEND_CAP_REACHED (raise the spend cap).

rollback_reason

Type: string, optional.

Why it was rolled back.

rolled_back_at

Type: string, optional, format date-time.

When it was rolled back.

serving

Type: boolean, required.

True while this deploy's image is the one serving traffic.

started_at

Type: string, optional, format date-time.

When it started.

status

Type: string, required.

e.g. pending, waiting_for_capacity (no build VM free yet), waiting_for_image (the platform's build image is not published yet), booting (its build VM is starting), building, pushed (image pushed, the deploy not started yet), waiting_for_pool (a deploy held until its pinned node pool has a ready node; nothing is applied meanwhile), deploying, succeeded, failed, cancelled, refused (an automatic build the org could not pay for; see refusal_code). New statuses may be added.

V1DeployListQuery

Query of the deploy list.

cursor

Type: string, optional.

Cursor from the previous page.

limit

Type: integer, optional, format uint.

Page size (1 to 100).

status

Type: string, optional.

Keep only deploys in this status, e.g. failed.

V1DiskAddOn

The extra-storage add-on of one size: a bigger local disk.

disk_gb

Type: integer, required, format uint32.

The local disk with the add-on, GB.

extra_gb

Type: integer, required, format uint32.

GB over the included disk, billed at extra_disk_gb_hour.

label

Type: string, required.

The runs-on label asking for it (a-line-4vcpu-100gb).

vcpu

Type: integer, required, format uint32.

The size it applies to, in vCPUs.

V1DnsRecord

A record to create at the customer's DNS provider.

name

Type: string, required.

The owner name.

type

Type: string, required.

A, AAAA or CNAME.

value

Type: string, required.

The address, or the CNAME target.

V1DnsTarget

How the customer's DNS points the domain at the cluster.

Type: "a_records" or "cname".

V1Env

An app's environment variables.

env

Type: map of string, required.

Variable name to value. Replacing sets exactly these variables.

V1Error

The error envelope of every non-2xx v1 response.

error

Type: object, required.

What went wrong.

V1GroupMember

A secret in a group: its metadata only.

has_value

Type: boolean, required.

False for a key a secret-group file added that has no value yet.

id

Type: string, required, format uuid.

The secret id.

injection_mode

Type: string, required.

env, file or both.

mount_path

Type: string, optional.

The file path (file/both).

name

Type: string, required.

The secret name.

secret_type

Type: string, required.

opaque, database, registry or tls.

V1GroupMembersAdded

How many of the given secrets were not in the group yet.

added

Type: integer, required, format int64.

Secrets added by this request (0 when all were members already).

V1HostedZone

A hosted zone (or a claim on one still being verified).

created_at

Type: string, required, format date-time.

When the claim was made (RFC 3339, UTC).

delegated

Type: boolean, optional.

Whether the zone is delegated to them (null before the first check).

id

Type: string, required, format uuid.

The zone id.

name

Type: string, required.

The zone name (example.com).

nameservers

Type: list of string, required.

The nameservers to delegate the zone to.

status

Type: string, required.

pending, verified or failed.

txt_name

Type: string, required.

The TXT record name proving ownership.

txt_value

Type: string, required.

The TXT record value.

verified_at

Type: string, optional, format date-time.

When the zone verified.

V1IacCommit

The commit a plan or sync is for.

sha

Type: string, required.

The full commit id (40 lowercase hex characters).

V1IacHeldAction

A change a sync held until someone confirms it in the console.

console_url

Type: string, required.

Where to confirm it.

id

Type: string, required, format uuid.

The held action.

kind

Type: string, required.

What it does (infra_billable_increase, ...). New values may appear.

reason

Type: string, required.

Why it was held.

requires

Type: list of string, required.

What confirming it takes (step_up, confirm_name, ...).

sha

Type: string, required.

The commit that asked for it.

target

Type: any, required.

What it acts on.

An IaC link as a listing shows it.

Type: string, required.

The branch it follows.

Type: string, required, format uuid.

The link.

Type: string, required.

The directory it reads, relative to the repository root.

Type: string, required.

The repository's owner/name.

Type: string, required.

active or broken.

V1IacLinkQuery

GET /v1/iac/{infra,project}-links query.

cursor

Type: string, optional.

Opaque cursor from the previous page's next_cursor.

limit

Type: integer, optional, format uint.

Page size, 1 to 100 (default 25).

path

Type: string, optional.

Only the links reading exactly this repository directory (one trailing slash ignored).

V1IacPlan

A dry-run plan of a link's files at one commit.

additions

Type: integer, required, format int32.

Resources a sync would add.

diff

Type: any, required.

The changes, shaped as the console's plan view and the stored sync diffs show them.

errors

Type: list of string, required.

Declarations a sync would refuse (file: message).

held

Type: integer, required, format int32.

Changes a sync would hold for confirmation in the console.

modifications

Type: integer, required, format int32.

Resources a sync would change.

removals

Type: integer, required, format int32.

Resources a sync would remove.

sha

Type: string, required.

The planned commit.

warnings

Type: list of string, required.

What a sync would apply but should be known first (file: key: message).

V1IacStatus

A link's sync state at one commit.

console_url

Type: string, required.

The link's page in the console.

held_actions

Type: list of V1IacHeldAction, required.

Every change of the link still waiting for confirmation.

last_applied_sha

Type: string, optional.

The commit the link last applied.

last_checked_sha

Type: string, optional.

The commit the link last checked.

last_sync_error

Type: string, optional.

Why the last sync failed.

last_sync_status

Type: string, optional.

The last sync's outcome (synced or failed).

Type: string, required, format uuid.

The link.

sha

Type: string, optional.

The commit reported on; null before the first sync.

state

Type: string, required.

pending (not synced yet), applying, applied, failed or held (applied, with changes waiting for confirmation). New values may appear.

V1IacStatusQuery

GET .../status query.

sha

Type: string, optional.

The commit to report on. Default: the commit synced last.

V1IacSyncQueued

A queued sync.

Type: string, required, format uuid.

The link.

sha

Type: string, required.

The commit the sync applies.

status_url

Type: string, required.

Poll this (GET) for the sync's outcome.

V1KeyScope

An API key's scope: read allows GETs, write also mutations, admin everything a key may do.

Type: "read" or "write" or "admin".

V1LogRetainedReason

Why an app's older log lines were removed.

Type: "size" or "time".

V1LogsPricing

Container logs.

free_gib_per_cluster_month

Type: string, required.

GiB every cluster ingests for free per UTC calendar month.

included_retention_days

Type: integer, required, format uint32.

Retention included in the ingest price, days.

ingest_gib

Type: string, required.

Price per GiB ingested above the free allowance.

storage_gib_month

Type: string, required.

Price per GiB-month of logs kept past the included retention.

V1MachineOrder

A machine configuration: a catalog family and the options picked in it.

selections

Type: map of string, optional, default {}.

The option value key per option group key; groups left out take their default.

slug

Type: string, required.

The family's slug.

V1ManagedInGit

Where a group managed in git is described.

branch

Type: string, required.

The branch.

file

Type: string, required.

The file, relative to the repository root.

V1NewPool

A node pool of a new cluster.

block_volume_gb

Type: integer, optional, default null, format int32.

A block volume per node, in GB (VPS providers only).

count

Type: integer, required, format int32.

The number of nodes (at least 1).

labels

Type: map of string, optional, default {}.

Kubernetes node labels.

machine

Type: V1MachineOrder, optional.

The machine configuration picked from the family node_type_id is sold as; the pool is built and charged as it. Omitted: the node type.

max_hourly_price

Type: V1Amount, optional.

The highest hourly price per node, in credits. Omitted: the node type's current price.

max_monthly_price

Type: V1Amount, optional.

The highest monthly price per node, in credits. Omitted: the node type's current price.

max_setup_fee

Type: V1Amount, optional.

The highest one-off setup fee per node, in credits. Omitted: the node type's current fee. A node whose price goes above a cap waits for a confirmation.

name

Type: string, required.

The pool's name, unique in the cluster.

node_type_id

Type: string, required.

The node type id (see the node type catalog).

public_ipv4

Type: boolean, optional, default false.

Give the nodes a public IPv4 address (charged per node). Default: IPv6 only.

reserved

Type: boolean, optional, default false.

Reserve the pool for apps bound to it (worker and storage pools).

role

Type: V1PoolRole, required.

control_plane, worker, storage or hybrid.

storage_config

Type: any, optional, default null.

The storage configuration; its shape depends on the strategy.

storage_strategy

Type: string, optional, default null.

The storage strategy (none, zfs_local, longhorn, local_path). Default none.

system_extensions

Type: list of string, optional, default [].

Talos system extensions for the pool's nodes.

V1Node

A node of a cluster, as the public API shows it.

id

Type: string, required, format uuid.

The node id.

kubernetes_name

Type: string, optional.

The Kubernetes node name; null until the node joins.

pool

Type: string, optional.

The node pool's name; null when the node has no pool.

private_ip

Type: string, optional.

The private network address; null until known.

public_ip

Type: string, optional.

The public IPv4 address; null until the provider assigns one.

public_ipv6

Type: string, optional.

The public IPv6 address; null until the provider assigns one.

role

Type: string, required.

The node's role (control_plane, worker, ...). New values may appear.

state

Type: string, required.

The lifecycle state (provisioning, running, ...). New values may appear.

static_address

Type: boolean, required.

Whether the public address is one of the pool's static addresses.

V1OrgDomain

An organization domain and the TXT record that proves it.

created_at

Type: string, required, format date-time.

When it was added.

error

Type: string, optional.

Why the last check failed.

id

Type: string, required, format uuid.

The domain id.

last_checked_at

Type: string, optional, format date-time.

When it was last checked.

name

Type: string, required.

The domain name.

scope

Type: string, required.

domain (the name and its subdomains) or host (the name only).

status

Type: string, required.

pending, verified or failed.

txt_name

Type: string, required.

Name of the TXT record to publish.

txt_value

Type: string, required.

Value of that TXT record.

verified_at

Type: string, optional, format date-time.

When the domain verified (RFC 3339, UTC).

V1OriginKey

A new origin key, answered this once.

domain

Type: V1AppDomain, required.

The domain with its lock.

header

Type: string, required.

The request header to send it in (X-Aline-Origin-Key).

key

Type: string, required.

The key for the proxy to send.

V1OriginLock

A domain's origin lock: fingerprints, never a key.

created_at

Type: string, required, format date-time.

When the current key was made (RFC 3339, UTC).

fingerprint

Type: string, required.

The current key's fingerprint: the first 16 hex digits of its SHA-256.

previous_expires_at

Type: string, optional, format date-time.

When the previous key stops working.

previous_fingerprint

Type: string, optional.

After a rotation: the previous key's fingerprint, accepted until previous_expires_at.

unlocked_hosts

Type: list of string, required.

The app's platform hostnames (its temporary URLs). They are other hosts, so they still reach the app without the key, and the CDN's protections do not apply there.

V1Page_for_V1App

One page of a v1 list.

data

Type: list of V1App, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1AppDomain

One page of a v1 list.

data

Type: list of V1AppDomain, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1Cluster

One page of a v1 list.

data

Type: list of V1Cluster, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1Deploy

One page of a v1 list.

data

Type: list of V1Deploy, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1HostedZone

One page of a v1 list.

data

Type: list of V1HostedZone, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

One page of a v1 list.

Type: list of V1IacLink, required.

The items, in the documented order.

Type: boolean, required.

Whether more items follow this page.

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1Node

One page of a v1 list.

data

Type: list of V1Node, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1OrgDomain

One page of a v1 list.

data

Type: list of V1OrgDomain, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1Project

One page of a v1 list.

data

Type: list of V1Project, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1RecordSet

One page of a v1 list.

data

Type: list of V1RecordSet, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1Secret

One page of a v1 list.

data

Type: list of V1Secret, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1Page_for_V1SecretGroup

One page of a v1 list.

data

Type: list of V1SecretGroup, required.

The items, in the documented order.

has_more

Type: boolean, required.

Whether more items follow this page.

next_cursor

Type: string, optional.

Pass as cursor to get the next page; null on the last page.

V1PendingVerification

The organization domain (not verified yet) a host waits on.

domain_id

Type: string, required, format uuid.

The organization domain id (see GET /v1/domains/{domain_id}).

name

Type: string, required.

Its name.

scope

Type: string, required.

domain or host.

status

Type: string, required.

Its verification status.

V1PoolRole

The role of a node pool.

Type: "control_plane" or "worker" or "storage" or "hybrid".

V1PriceCaps

A pool's price caps in credits (null = no cap).

max_hourly_price

Type: string, optional.

Highest hourly price per server.

max_monthly_price

Type: string, optional.

Highest monthly price per server.

max_setup_fee

Type: string, optional.

Highest setup fee per server.

V1PriceConfirmation

Servers of one pool held until the new price is confirmed.

count

Type: integer, required, format int64.

How many servers are held.

location

Type: string, required.

The provider location.

new

Type: V1PriceQuote, required.

The current price.

node_type

Type: string, required.

The machine type.

old

Type: V1PriceCaps, required.

The caps the price went above.

pool

Type: string, required.

The pool's name.

pool_id

Type: string, required, format uuid.

The pool's id.

role

Type: string, required.

The pool's role.

since

Type: string, required, format date-time.

When the oldest of them started waiting (RFC 3339, UTC).

V1PriceQuote

A machine type's current price in credits.

hourly_price

Type: string, required.

Hourly price per server.

monthly_price

Type: string, required.

Monthly price per server (hourly x 730).

setup_fee

Type: string, required.

Setup fee per server.

V1Pricing

The public list prices.

actions

Type: V1ActionsPricing, required.

GitHub Actions runners.

builds

Type: V1BuildsPricing, required.

Image builds.

currency

Type: string, required.

Currency of every price.

logs

Type: V1LogsPricing, required.

Container logs.

updated_at

Type: string, optional, format date-time.

When a price on this list last changed; null when every value is at its built-in default.

vat_included

Type: boolean, required.

Whether prices include VAT.

version

Type: integer, required, format uint32.

Document version (1).

V1Project

A project, as the public API shows it.

cluster_id

Type: string, required, format uuid.

The cluster the project belongs to.

created_at

Type: string, required, format date-time.

When the project was created (RFC 3339, UTC).

display_name

Type: string, required.

The name shown in the dashboard.

egress_mode

Type: string, required.

Outbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.

id

Type: string, required, format uuid.

The project id.

isolated

Type: boolean, required.

Whether apps in the project cannot reach each other unless connected.

name

Type: string, required.

The project's name (its Kubernetes namespace).

V1ProjectQuotas

A project's quota limits with its current usage.

can_edit

Type: boolean, required.

Whether the key's user may change the limits (tenant owners and admins).

limits

Type: V1QuotaLimits, required.

The limits as set.

usage

Type: V1QuotaUsage, required.

What the project's apps use now.

V1QuotaLimits

A project's quota limits. A missing limit (null) means unlimited.

cpu

Type: string, optional.

Maximum total CPU requests, as a Kubernetes quantity (4, 2500m).

memory

Type: string, optional.

Maximum total memory requests, as a Kubernetes quantity (8Gi).

pods

Type: integer, optional, format int32.

Maximum pods.

pvcs

Type: integer, optional, format int32.

Maximum persistent volume claims.

storage

Type: string, optional.

Maximum total claimed storage, as a Kubernetes quantity (100Gi).

V1QuotaUsage

What a project's apps use now.

cpu_millis

Type: integer, required, format uint64.

CPU requests in millicores.

memory_bytes

Type: integer, required, format uint64.

Memory requests in bytes.

pods

Type: integer, required, format int64.

Pods.

pvcs

Type: integer, required, format int64.

Persistent volume claims.

storage_bytes

Type: integer, required, format uint64.

Claimed storage in bytes.

V1RecordSet

A record set: every record of one name and type.

name

Type: string, required.

The owner name, fully qualified without the trailing dot (www.example.com).

records

Type: list of string, required.

The record values, in zone-file presentation format.

ttl

Type: integer, required, format uint32.

Time to live in seconds.

type

Type: string, required.

The record type (A, AAAA, CNAME, TXT, MX, ...).

V1Scale

How many pods an app runs.

replicas

Type: integer, required, format int32.

Desired pods.

V1Secret

A secret's metadata, as the public API shows it. The value is never part of it.

created_at

Type: string, required, format date-time.

When the secret was created (RFC 3339, UTC).

description

Type: string, optional.

Free text.

expires_at

Type: string, optional, format date-time.

When the value expires (RFC 3339, UTC).

has_value

Type: boolean, required.

False for a secret declared without a value (in IaC) until one is set; apps do not receive it until then.

id

Type: string, required, format uuid.

The secret id.

injection_mode

Type: string, required.

How apps receive it: env, file or both.

keep_versions

Type: integer, optional, format int32.

How many replaced versions the secret keeps (1 to 100, each billed like the current value); null = the default, 10. Older ones are destroyed.

mount_path

Type: string, optional.

Where a file secret is mounted.

name

Type: string, required.

The name, unique within its scope (the environment variable name for env injection).

rotated_at

Type: string, optional, format date-time.

When the value was last rotated (RFC 3339, UTC).

scope_id

Type: string, required, format uuid.

The id of that cluster, environment, project or app.

scope_type

Type: string, required.

What the secret belongs to: cluster, environment, project or app.

secret_type

Type: string, required.

opaque, database, registry or tls (new values may be added).

updated_at

Type: string, required, format date-time.

When the secret last changed (RFC 3339, UTC).

value_origin

Type: string, required.

Who set the value: user, generated or app_credential.

version

Type: integer, required, format int32.

The current version; every value change adds one.

write_only

Type: boolean, required.

The value can be replaced or deleted but never read back by anyone (apps still receive it). One-way.

V1SecretGroup

A secret group, as the public API shows it.

created_at

Type: string, required, format date-time.

When the group was created (RFC 3339, UTC).

description

Type: string, optional.

Free text.

id

Type: string, required, format uuid.

The group id.

member_count

Type: integer, required, format int64.

How many secrets the group holds.

name

Type: string, required.

The name, unique within the environment.

updated_at

Type: string, required, format date-time.

When the group last changed (RFC 3339, UTC).

V1SecretGroupDetail

A secret group with its members.

created_at

Type: string, required, format date-time.

When the group was created (RFC 3339, UTC).

description

Type: string, optional.

Free text.

id

Type: string, required, format uuid.

The group id.

keys_without_value

Type: list of string, required.

Member keys without a value yet.

managed_in_git

Type: V1ManagedInGit, optional.

The infra link file describing the group, null when it is not managed in git.

members

Type: list of V1GroupMember, required.

The secrets in the group.

name

Type: string, required.

The name, unique within the environment.

updated_at

Type: string, required, format date-time.

When the group last changed (RFC 3339, UTC).

V1SetActionsCacheLimit

A new org cache limit.

cache_limit_gb

Type: integer, required, format int64.

Whole GB, at least the free amount and at most the max.

V1SetClientIpHeader

The client-IP header of a domain behind a proxy.

header

Type: string, optional, default null.

CF-Connecting-IP, True-Client-IP, Fastly-Client-IP or another header name; null or empty clears it.

V1SetSecretValue

A new value for a secret (write-only). It becomes the next version.

value

Type: string, required.

The new value.

V1TosAcceptance

The terms of service the customer accepted.

crypto_prohibition_acknowledged

Type: boolean, optional, default false.

The provider's crypto prohibition was acknowledged (required on providers that prohibit crypto).

tos_version

Type: string, required.

The terms version accepted; must be the current one.

V1TriggerBackup

A backup to run now.

target_ids

Type: list of string, optional, default null.

Targets to back up to; the app's primary target when left out.

V1TriggerDeploy

A deploy to start.

strategy

Type: string, optional, default null.

rolling (default), recreate or surge (templates that support it).

V1UpdateApp

App settings to change; omitted fields stay as they are.

batch

Type: string, optional, default null.

Groups the redeploy with others sent under the same name (for example a release version), so their notices arrive together. 1-64 letters, digits or . _ - + :.

health_path

Type: string, optional, default null.

A new HTTP health check path.

image

Type: string, optional, default null.

A new container image; redeploys the app.

port

Type: integer, optional, default null, format int32.

A new main container port.

V1UpdateDomain

The fields to change; a field left out keeps its value.

behind_proxy

Type: boolean, optional, default null.

Served through a CDN or reverse proxy (HTTP and HTTPS routes only). Turning it off also turns the origin lock off and clears the client IP header.

V1UpdateProject

Changes to a project; at least one field. The name is fixed at creation; isolated switches the app network.

display_name

Type: string, optional, default null.

The new name shown in the dashboard, 1-255 characters.

isolated

Type: boolean, optional, default null.

Switch isolation. Turning it on blocks traffic between the project's apps that are not declared as connections; the namespace's network policies follow within a minute. A hosted organization's projects stay isolated.

V1Whoami

The calling API key.

key_id

Type: string, optional, format uuid.

The key's id.

scope

Type: V1KeyScope, required.

The key's scope.

tenant_id

Type: string, optional, format uuid.

The organization the key acts on.

V1ZoneSerial

The zone serial after a write.

serial

Type: integer, required, format uint32.

The zone's SOA serial including the change.

WwwRedirectMode

Redirect between a host and its www. form.

Type: "off" or "to_www" or "to_apex".

On this page

AppEgressResponseAppStatusAppStatusKindBackupRunInfoBlockedDestinationResponseBlockedEgressResponseContentNegotiationCoopCspModeCspPresetCsrfModeDependencyCreateDependencyModeDependencyRequestHeaderDtoHttpSettingsResponseLastDeployNegotiationTypePageQueryPermissionsPolicyModeProjectEgressResponseRecordSetKeyRuleRequestRuleResponseRunProgressUpdateEgressRequestUpdateHttpSettingsRequestV1AcmeDelegationV1ActionsCacheV1ActionsPricingV1ActionsSizeV1AddDomainV1AddGroupMembersV1AmountV1AppV1AppDomainV1AppLogLineV1AppLogsPageV1AppLogsQueryV1BackupRunQueuedV1BillingV1BillingUnitV1BuildLogsPageV1BuildLogsQueryV1BuildTierV1BuildsPricingV1CachePricingV1CapacityWaitV1ClusterV1ClusterNetworkV1ConcurrencyTierV1CreateAppV1CreateClusterV1CreateProjectV1CreateSecretV1CreateSecretGroupV1CustomShapesV1DeleteClusterQueryV1DeletedClusterV1DeployV1DeployListQueryV1DiskAddOnV1DnsRecordV1DnsTargetV1EnvV1ErrorV1GroupMemberV1GroupMembersAddedV1HostedZoneV1IacCommitV1IacHeldActionV1IacLinkV1IacLinkQueryV1IacPlanV1IacStatusV1IacStatusQueryV1IacSyncQueuedV1KeyScopeV1LogRetainedReasonV1LogsPricingV1MachineOrderV1ManagedInGitV1NewPoolV1NodeV1OrgDomainV1OriginKeyV1OriginLockV1Page_for_V1AppV1Page_for_V1AppDomainV1Page_for_V1ClusterV1Page_for_V1DeployV1Page_for_V1HostedZoneV1Page_for_V1IacLinkV1Page_for_V1NodeV1Page_for_V1OrgDomainV1Page_for_V1ProjectV1Page_for_V1RecordSetV1Page_for_V1SecretV1Page_for_V1SecretGroupV1PendingVerificationV1PoolRoleV1PriceCapsV1PriceConfirmationV1PriceQuoteV1PricingV1ProjectV1ProjectQuotasV1QuotaLimitsV1QuotaUsageV1RecordSetV1ScaleV1SecretV1SecretGroupV1SecretGroupDetailV1SetActionsCacheLimitV1SetClientIpHeaderV1SetSecretValueV1TosAcceptanceV1TriggerBackupV1TriggerDeployV1UpdateAppV1UpdateDomainV1UpdateProjectV1WhoamiV1ZoneSerialWwwRedirectMode