Skip to content

Uninstall an app

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

Removes an app from the site. The app stops being listed immediately; its code, data, and secrets are removed in the background, and removed: false means a removal was already under way.

How it works

Uninstalling an app leaves the apps it needs on the site.

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.

acknowledgeDependents

Set to true to uninstall an app that apps it needs also need, after a site manager accepts that they can stop working.

string
Allowed values: true false

Example

true

Set to true to uninstall an app that apps it needs also need, after a site manager accepts that they can stop working.

Whether a live installation was marked for removal.

Media typeapplication/json
object
removed
required

Whether a live installation was marked for removal; false when it was already being removed.

boolean

Example

{
"removed": true
}

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

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

linked — The app’s storage is shared through a storage link: a child site binds this site’s objects, or this site binds a parent’s. message names the sites; change the link first, or make the change on the parent site. When a child site lacks an app the version needs, message names it; install it on that child first. app_required_by — Other apps on the site need this app: the versions they run declare it as a required dependency, and this app does not need them back. requiredBy lists their slugs and message names them. Nothing was removed. Uninstall those apps first, or move them to a version that does not need it. dependents_affected — Other apps on the site need this app, and this app also needs each of them, at any depth. Without it they can stop working. requiredBy lists their slugs and message names them. Nothing was removed. Repeat the call with acknowledgeDependents=true once a site manager accepts this. removal_pending — A deployment for the site is running. Nothing changed, so retry later.

Media typeapplication/json
object
error
required

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

string
Allowed values: linked app_required_by dependents_affected removal_pending
message

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

string
requiredBy

With app_required_by or dependents_affected: the slugs of the apps on the site that need this app.

Array<string>

Example

{
"error": "linked",
"message": "The Cloudflare API token is invalid or expired.",
"requiredBy": [
"pixel"
]
}

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