Skip to content

Create an app install

POST
/teams/{teamId}/domains/{domainId}/apps/{appSlug}/installs
curl --request POST \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/apps/facebook-capi/installs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "EU pixel" }'

Adds another installation of an app that is already on the site. Name it with label. Use this after the first install when the app allows more than one.

How it works

The app must already be installed and allow multiple installs. The new install starts unconfigured — set its values, then deploy. multiple_not_allowed means the app only supports one; install_limit means the site is at the cap. Secret values are never returned.

Required permissions

  • domain:manage_domain_apps: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 site operations.

string format: uuid

Example

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

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

appSlug
required

Immutable slug of the app, as shown by the list operation.

string
/^[a-z][a-z0-9-]{2,29}$/

Example

facebook-capi

Immutable slug of the app, as shown by the list operation.

The name for the additional installation.

Media typeapplication/json

The name for the additional installation. A geoFilter is refused as invalid_body: a new install runs in every location until the update operation sets one.

object
label
required

The label every surface shows for this install. At most 100 characters.

string
>= 1 characters <= 100 characters

Example

EU pixel
key
additional properties

The additional install this call created.

Media typeapplication/json

The additional install this call created, without its secrets.

object
appInstallId
required

Id of the install this call created.

string
ordinal
required

The install’s permanent ordinal; never reused after removal.

integer
label
required

The label every surface shows for this install.

string
enabled
required

The install’s own switch, beneath the app-level one. A new install starts enabled.

boolean
geoFilter
required

Always null: a new install runs in every location.

null

Example

{
"appInstallId": "8d7c6b5a-4938-4271-a605-9e8f7a6b5c4d",
"ordinal": 2,
"label": "EU pixel",
"enabled": true,
"geoFilter": null
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.

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 invalid_body
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"
}

multiple_not_allowed — The app allows only one install per site, or a version change would leave more installs than the target version allows. message states the conflict. install_limit — The site already has as many installs of this app as Qinto allows. Remove one, then retry. message states the cap. variable_invalid — The app declares no variable by that name, or another party sets the name (the site manager, the app developer, or the app’s own panel); message names it. registry_budget — The change would grow the site’s app configuration past the size the site worker can deploy. Remove an app or an install, or shorten install labels and geo filters, then retry. message states the refusal. app_suspended — Blotout has suspended this app, so nothing ran and nothing changed. The call works again once the suspension is lifted. app_taken_down — Blotout has taken this app down for good, so nothing changed. message states what the call cannot do. Do not retry. 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: multiple_not_allowed install_limit variable_invalid registry_budget app_suspended app_taken_down sites_paused deploys_blocked
message

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

string

Example

{
"error": "multiple_not_allowed",
"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"
}