removePackage

DELETE

/api/v1/packages/{packageId}

const url = 'https://example.com/api/v1/packages/example';
const options = {method: 'DELETE', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/packages/example \
  --cookie tilecast_session=<tilecast_session>

Requires the Owner or Administrator role with the admin scope. Cookie requests additionally require the X-CSRF-Token header. Deletes the installation and its contribution rows. The custom source, when any, survives for reinstall. Audited.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

packageId

required

string

/^[a-z][a-z0-9_.:-]{0,127}$/

Store package identifier such as countdown_bar.

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Responses

204

Package removed

401

Dashboard authentication required

403

Owner or Administrator role required

404

Package_not_installed

409

Package_in_use — contributed content still exists; remaining resources are listed in error.details

application/json

A removal, update, or rollback blocked by contributed content the operation would strand. The operation deletes installation state only, never content, so the operator deletes the listed content first.

object

error

required

object

code

required

string

Allowed value: package_in_use

message

required

string

details

required

The package and the contributed content that blocks the operation.

object

packageId

required

string

resources

required

Array<object>

object

kind

required

string

count

required

integer

>= 1

label

required

string

resolution

required

string

Example

{
  "error": {
    "code": "package_in_use"
  }
}