CitadelHosts

Check the managed status of an application. Returns a PascalCase string: Queued (waiting for a worker, nothing deployed yet), Created (deployed on a worker, containers waiting to be started), Running (up and serving), Stopped (intentionally stopped; restart with start_app), Deleted (terminal, torn down), or Unknown (worker could not confirm the state; check get_app_logs then restart). Poll Queued/Created until Running or a terminal state.

Deploy a managed application onto a territory. application_id is a catalog id (list_available_apps) or a custom definition id (create_custom_app). Omit advanced arrays unless needed.

Schedule automatic backups for an app.

Register a custom application definition from the user's own Docker images (and/or public images) so it can be deployed with create_app. Push images first: get_registry_credentials, then tag/push as /:, and verify with list_custom_images. Container 'image' is 'repo:tag' when is_custom is true (an image in the user's registry, the default), or a fully-qualified public image including its registry domain, like 'docker.io/library/postgres:16', when is_custom is false. Publish exactly one port on the container that serves traffic; volumes persist data at container_path; env_vars function defaults to TEXT for literal values.

Create a standalone storage volume. size_limit uses the same units as the web dashboard (GB).

Create a new territory. Index selects the tier: 1 = Outpost (1 CPU, 0.5 GB RAM, 5 GB disk), 2 = Scout (1 CPU, 1 GB RAM, 10 GB disk), 3 = Watchtower (2 CPU, 2 GB RAM, 20 GB disk), 4 = Bastion (4 CPU, 4 GB RAM, 40 GB disk), 5 = Keep (8 CPU, 8 GB RAM, 80 GB disk), 6 = Stronghold (16 CPU, 16 GB RAM, 160 GB disk), 7 = Citadel (32 CPU, 32 GB RAM, 320 GB disk). Starts billing.

Delete a territory and stop billing for it. Destructive.

Get the full application record by id: status, territory_id, container instances (image, ports, volumes, env vars, router targets) and mount points. Its 'status' uses the same PascalCase values as check_app_status (Queued, Created, Running, Stopped, Deleted, Unknown). For resource usage instead, use get_app_details.

Get an application definition (containers, ports, volumes, env vars) by id. Catalog definitions are shared; custom definitions are visible only to the user who created them (404 otherwise).

Get a usage summary for a managed application: app name, auth flag, aggregated CPU and memory usage, and storage used per container and per volume. For the full record with ports, env vars and router targets, use get_app.

Get the public URL where a deployed managed application can be reached, so it can be shared with the user. Returns app_link null when the app publishes no port.

Capture recent container log lines for an app. Samples ~4 seconds of logs. container_select is a managed_container_id (see get_app_details); omit it to use the app's first container.

Get the user's credit wallet balance (cents USD).

Check whether the user has a payment method on file.

Get Docker registry login credentials and step-by-step instructions for pushing custom images. The password is the caller's own API token (read_write keys only); it works with docker/podman/skopeo login and in CI. Images pushed as /: are automatically scoped to this account; reference them in create_custom_app as ':' with is_custom true.

Get the status of one territory. Returns a PascalCase string: Queued (being provisioned, cannot host apps yet), Active (ready to host apps), or Deleted (terminal, billing stopped).

Forcefully kill a running managed application.

List all managed applications across the user's territories. Each entry's 'status' uses the PascalCase values documented on check_app_status.

List the application catalog available to deploy.

List stored backups, optionally filtered by app id.

List scheduled backup tasks, optionally filtered by app id.

List the Docker images pushed to the user's CitadelHosts registry (name, tag, size bytes). Verify pushes here before referencing images in create_custom_app.

List the user's queued/active/failed background jobs.

List volumes attached to a managed application.

List the user's standalone storage volumes with size limits and usage.

List the user's territories (resource containers that hold apps) with limits, status and pricing.

Rename a territory.

Restore a backup over the app's current volume data. Destructive.

Start a stopped managed application.

Gracefully stop a running managed application.

Toggle whether the proxy requires login to reach the app.