Skip to content

Deploy a site

POST
/teams/{teamId}/domains/{domainId}/deploy
curl --request POST \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/deploy \
--header 'Authorization: Bearer <token>'

Starts serving a site on its hostname, turning a pending site active. Until it runs, a site is registered but serves nothing.

How it works

The request runs the deployment and does not return until it finishes, so expect it to take longer than the other operations. It is safe to retry: deploying an already-deployed site republishes it rather than creating a second one. Deploying is also how a site picks up later configuration changes. A site set to its Qinto URL is deployed without attaching the customer’s domain.

Required permissions

  • domain:write on all domains, or on the addressed domain when its id is in the route
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

domainId
required

Unique id (UUID) of the site, as returned by the create and list operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the site, as returned by the create and list operations.

The site was deployed and is now active.

Media typeapplication/json
object
deploymentId
required

Id of the worker this deployment produced.

string
version
required

Version of the Qinto worker the site now runs.

string

Example

{
"deploymentId": "shopexamplecom-3f2a9c81",
"version": "1.4.0"
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

no_payment_method — The team pays by card and has no payment method on file, so nothing was deployed or installed. Add a card on the team’s Billing page, then retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: no_payment_method
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "no_payment_method",
"message": "The Cloudflare API token is invalid or expired."
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

deploy_in_progress — Another deployment for this site is already running. Wait for it to finish, then retry. storage_link_blocked — The site’s storage link holds this deployment: its parent has not published the link yet (the sync retries on its own), a linked resource could not be resolved on the parent, or the deploy would retire a resource a linked child still binds. message states which. apps_updating — An app worker on this site still runs an older app runtime or does not yet hold a saved value, so the site was not published. The sync finishes this on its own; retry in a few minutes. message states which. sites_paused — Blotout has paused this team’s sites, so nothing was deployed or installed. Every site of the team answers 410 until the pause ends, and uninstalls, switches and settings changes are still recorded. A payment does not end the pause; contact Blotout. deploys_blocked — Blotout has blocked this team’s deploys, so nothing was deployed or installed. The team’s live sites keep running, and uninstalls, switches and settings changes still roll out. A payment does not lift the block; contact Blotout.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: deploy_in_progress storage_link_blocked apps_updating sites_paused deploys_blocked
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "deploy_in_progress",
"message": "The Cloudflare API token is invalid or expired."
}

host_not_ready — The site’s host is not ready to serve it — no Cloudflare zone chosen, no stored API token, a token scoped to the wrong zone, a conflicting DNS record, or a dispatcher that refused the request. message names the fix.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: host_not_ready
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "host_not_ready",
"message": "The Cloudflare API token is invalid or expired."
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}

upstream_unavailable — A provider Qinto depends on (Cloudflare for the DNS records, or the email service) could not be reached or refused the request. Delivery is unconfirmed rather than ruled out — a lost response can follow an accepted send — so retry with the same submissionId, which de-duplicates an identical retry at the provider.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: upstream_unavailable

Example

{
"error": "upstream_unavailable"
}