Skip to main content
Version: v5.7.0

opschain admin

Included from Basic tier

Administer a running OpsChain server over its API. Every verb under admin addresses a live server and works with a plain opschain login session — the server authorises the caller through RBAC (the /admin updatable determination, which a superuser passes). The credential resolves as --auth-token, then your stored opschain login session (renewed through its refresh token on expiry), then OPSCHAIN_ADMIN_TOKEN, then the token stored by opschain admin login — the admin-token lanes stay as automation fallbacks for environments without a login. Host-local server lifecycle — configure, start, backup, restore — lives under opschain server instead.

FamilyPurpose
login, logoutStore/clear the admin token this tree authenticates with — opschain docs cli/admin-login, cli/admin-logout.
status, queue, changesOperational views: server status, the fleet dispatch queue, active changes — opschain docs cli/admin-status, cli/admin-queue, cli/admin-changes.
runners, runner, runner-group, runner-attributes, runner-tokenThe runner fleet: inventory, per-runner lifecycle, placement groups and attributes, registration tokens — opschain docs cli/admin-runners, cli/admin-runner, cli/admin-runner-group, cli/admin-runner-attributes, cli/admin-runner-token.
agents, agent, agent-token, trustThe agent plane: inventory, per-agent lifecycle and governance, registration tokens, trust tiers — opschain docs cli/admin-agents, cli/admin-agent, cli/admin-agent-token, cli/admin-trust.
server, platformHold tiers: server quiesce/resume and platform attempt/halt/quiesce/resume — opschain docs cli/admin-server, cli/admin-platform.
authz, users, service-accounts, groups, sessionsIdentity and authorisation: policies and rules, user accounts, automation service accounts, group membership, session visibility and revocation — opschain docs cli/admin-authz, cli/admin-users, cli/admin-service-accounts, cli/admin-groups, cli/admin-sessions.
github-connections, github-trust-policiesThe GitHub integration: App connections and the trust policies the Actions OIDC token exchange decides against — opschain docs cli/admin-github-connections, cli/admin-github-trust-policies.
settings, licence, database, nodesServer state: DB-authoritative settings, entitlements, database maintenance, node tree repair — opschain docs cli/admin-settings, cli/admin-licence, cli/admin-database, cli/admin-nodes.

See also​

  • opschain docs cli/server — host-local lifecycle of the server process.
  • opschain docs fleet-queue — the dispatch queue the runner/agent verbs and admin queue operate on.