Skip to content
Built with

Platform operations ​

SDK Reference

You need an administrator session for these commands. See Platform Management for choosing a platform, previews and confirmation.

On this pageInspect deployments and builds · Check system health · Manage hosted work

These commands find a deploy, show its manifest or request a cancel. Commands that take an <id> use a deploy ID from list.

Requires: platform admin login

These commands need an admin session from void platform auth login. Automation uses VOID_OPERATOR_TOKEN from a secret store. Never put it in project files.

Now you will run void platform deployment list and void platform deployment show.

sh
void platform deployment list [--project <id-or-slug>] [--status <status>] [--search <text>] [--page <n>] [--limit <n>]
void platform deployment show <id>

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform deployment cancel and void platform deployment migrate-assets.

sh
void platform deployment cancel <id>
void platform deployment migrate-assets <id> [--cursor <cursor>] [--plan|--yes]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

You can cancel a deploy while it is pending, uploading, migrating or prerendering. You can request it again while it is canceling. You cannot cancel a deploy that has started switching traffic, is recovering from a failure or has finished.

migrate-assets copies a deploy's legacy assets to scoped R2 storage. App traffic does not change. Use --plan to preview and --cursor to resume after a successful batch. The original assets stay in place.

Now you will read a deploy's runtime logs. Use the deploy ID from the list step.

sh
void platform deployment logs <id> [--since <time>] [--cursor <cursor>] [--limit <n>] [--follow]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

By default you get the last hour, oldest first, up to 100 records. --since takes a duration such as 10m, 2h or 1d, an ISO date or epoch milliseconds. Set --limit from 1 to 500. To read the next page, pass the response's nextCursor as --cursor.

--follow reads the remaining pages, then checks for new logs every two seconds until you press Ctrl+C. It rechecks a five-minute overlap for late records and hides repeats. Records that arrive later may need another history query. Following stops with an error if a window has more than 10,000 records. Use a narrower history query then.

Builds ​

These commands show a build or read its output. Use the build ID from the deploy details.

Now you will run void platform build show and void platform build logs.

sh
void platform build show <id>
void platform build logs <id> [--since <sequence>] [--limit <n>] [--follow]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Build logs start at sequence 0 and return up to 500 lines. Pass the returned lastSeq as --since to continue. --limit takes 1 to 500. Container logs need managed builds to be on. GitHub Actions builds return an external log URL.

--follow waits for the final logs after the build ends. If the end cannot be confirmed within two minutes, the command exits with an error.

System ​

These commands show activity, check service health and list admin changes.

Now you will run void platform system overview and void platform system health.

sh
void platform system overview
void platform system health

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform system cli-versions and void platform system asset-migrations.

sh
void platform system cli-versions
void platform system asset-migrations [--page <n>] [--limit <n>]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform system events and void platform system backfill-queue-tokens.

sh
void platform system events [--page <n>] [--limit <n>]
void platform system backfill-queue-tokens

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform system sandbox-drain and void platform system rotate-proxy-tokens.

sh
void platform system sandbox-drain [--cursor <opaque-cursor>]
void platform system rotate-proxy-tokens [--project <id> | --all]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

overview shows platform totals and recent activity. health checks the configured services and database. It exits nonzero if a check fails. cli-versions reports the CLI versions that deploys used.

asset-migrations lists stored deploy assets and reports needsMigration and invalid counts. Use the pagination fields to read all entries.

events shows the admin, target and outcome of each change. A pending event means the outcome is not recorded yet. Previews and session login or logout create no events. backfill-queue-tokens repairs older queue entries that lack auth tokens. It supports --plan before the repair.

sandbox-drain removes legacy tenant-owned Sandbox resources. Use --plan to preview and --yes to apply. Then pass nextCursor as --cursor to continue. App traffic stays paused during cleanup.

rotate-proxy-tokens gives projects new platform credentials on their live Worker and rollback Workers, with no redeploy. Rollback Workers whose author can no longer deploy keep the old credentials.

Use --project <id> for one project or --all for every project. Add --plan to preview or --yes to apply. --plan alone shows every rotation still running. Each run handles one batch. The platform finishes the rest in the background. A rotation takes about 6 minutes per project, longer during a deploy. Check progress with --plan until nothing is pending or failed.

Running --yes again during a rotation starts one more rotation for that project. Once a rotation finishes, the old credentials stop working. Each rotation starts a new version of the live Worker, so WebSocket connections reconnect once.

Use the platform lifecycle commands to maintain your installation's Workers.

Hosted Workers ​

These commands manage the Workers of the hosted Void Cloud platform. Later commands use a Worker name and version ID from the list and show steps. They do not work on a self-hosted installation. Use the lifecycle commands there instead.

Now you will run void platform worker list and void platform worker show.

sh
void platform worker list [--environment <production|staging>]
void platform worker show <worker-name> [--environment <production|staging>]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform worker rollback and void platform worker rollback-all.

sh
void platform worker rollback <worker-name> <version-id> [--environment <production|staging>]
void platform worker rollback-all [--environment <production|staging>]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Next, run void platform worker events.

sh
void platform worker events [batch-id] [--environment <production|staging>]

Example output: the requested record, list, or a confirmation. Commands with --plan show the change without applying it.

Use a name from worker list, such as api or proxy. show lists its versions and current deploy. Preview either rollback with --plan. Then apply it interactively, or with --yes in a script. events lists Worker operation events or shows one batch by ID.

Next steps ​

implemented.stream AI