gatewayctl

Reference

Generated source hash: sha256:4c3018cdf3cf481f612ffed62fe7ce4657ee4bdc571c4ae7d727d244d6351a30.

Find the root command supported by your checkout. The command table is read from the Go dispatcher, and the usage block is copied from the same source.

Run the command with its help option to inspect supported flags before executing an administrative mutation. Match the CLI release to the gateway you administer.

Commands

• 34 root commands are parsed from the command dispatcher.
• Usage text is copied from the source usage() function.
• Command behavior remains owned by Go source and tests.

Command	Source status
admin-activity	Source-dispatched root command.
bootstrap-admin	Source-dispatched root command.
bootstrap-self-hosted	Source-dispatched root command.
call-tool	Source-dispatched root command.
claude-config	Source-dispatched root command.
client-surface	Source-dispatched root command.
connector-status	Source-dispatched root command.
connectors	Source-dispatched root command.
credential-binding	Source-dispatched root command.
diagnose-deny	Source-dispatched root command.
drain-session	Source-dispatched root command.
emergency-disable	Source-dispatched root command.
environments	Source-dispatched root command.
explain	Source-dispatched root command.
inspect-session	Source-dispatched root command.
license	Source-dispatched root command.
list-sessions	Source-dispatched root command.
management	Source-dispatched root command.
outbound-endpoint	Source-dispatched root command.
outbound-target	Source-dispatched root command.
policy	Source-dispatched root command.
register-agent	Source-dispatched root command.
register-server	Source-dispatched root command.
revoke-session	Source-dispatched root command.
search-audit	Source-dispatched root command.
siem-webhook	Source-dispatched root command.
simulate-policy	Source-dispatched root command.
status	Source-dispatched root command.
telemetry	Source-dispatched root command.
terminate-session	Source-dispatched root command.
validate-agent	Source-dispatched root command.
validate-credential-binding	Source-dispatched root command.
validate-manifest	Source-dispatched root command.
webhook	Source-dispatched root command.

Usage text from source

gatewayctl is the Go CLI shell for registration, validation, OpenAPI import, policy simulation, and diagnostics.
gatewayctl commands: validate-manifest <file> [--format text|json], register-server <manifest> [--registry <file>] [--format text|json], call-tool (--registry <file>|--manifest <file>) [--request <file>|--server <id> --tool <id>], simulate-policy [--user <id>] [--group <id>] [--agent <id>] [--client-surface <id>] [--environment <id>] --server <id> --tool <id> [--allow|--explicit-deny|--revoked-subject|--unauthorized-surface|--environment-mismatch|--credential-mode-denied|--credential-binding-denied|--missing-auth|--invalid-auth] [--policy-version <id>] [--format text|json], diagnose-deny <reason>|(--request-id <id>|--audit-event-id <id>) [--tenant <id>] [--environment <id>] [--control-plane-url <url>] [--token-file <file>]|--simulate [actor/tool context] [--format text|json], bootstrap-self-hosted [--dry-run] [--format text|json], bootstrap-admin [--control-plane-url <url>] [--user <id>] [--display-name <name>] [--email <email>] [--password-env <env>] [--format text|json], status deployment [--format text|json], validate-agent <manifest> [--format text|json], register-agent <manifest> [--registry <file>] [--format text|json], validate-credential-binding <manifest> [--format text|json], credential-binding (list|get|update|rotate|disable|revoke|status) [id] [--lifecycle approved|disabled|revoked] [--reason <reason>] [--format text|json], search-audit [filters] [--export-ready] [--format text|json], list-sessions [filters] [--format text|json], inspect-session <id> [--format text|json], drain-session <id> --reason <reason> [--format text|json], terminate-session <id> --reason <reason> [--format text|json], revoke-session <id> --reason <reason> [--revocation-id <id>] [--format text|json], emergency-disable --target-type <type> --target-id <id> --reason <reason> [--format text|json], connector-status <id> [--lifecycle approved|disabled|revoked] [--format text|json], policy review <file> --policy-version <id> [--format text|json], policy publish <file> --policy-version <id> [--format text|json], explain
additional commands: status data-planes [filters] [--format text|json], status data-plane <id> [--format text|json], environments list|get [--format text|json], license status [--environment <id>] [--state valid|expired|missing|offline_grace] [--role platform_admin|security_admin|viewer|developer] [--format text|json], telemetry (status|configure|test|disable) [--control-plane-url <url>] [--format text|json], siem-webhook (list|get|create|update|test|enable|force-enable|disable|deliveries|delivery|attempts|confirmations|confirmation-polls|redrive|replay|replay-list|replay-status) [--control-plane-url <url>] [--format text|json], outbound-endpoint (list|get|create|update|archive) --tenant <id> --environment <id> --control-plane-url <url>, outbound-target (list|get|create|update|test|test-result|enable|disable|rotation-get|rotation-stage|rotation-promote) --tenant <id> --environment <id> --control-plane-url <url>, webhook event-types (list|get|deprecate|retire), webhook subscription (list|get|create|update|test|enable|disable|dependencies|archive|dispose-backlog), webhook delivery (list|get|redrive) --tenant <id> --environment <id> --control-plane-url <url>, client-surface (list|get|disable|revoke) [id] [--environment <id>] [--reason <reason-code>] [--format text|json], admin-activity (search|get) [filters] [--format text|json], connectors list --tenant <id> --environment <id> [--format text|json], connectors get|impact <id> --tenant <id> --environment <id> [--format text|json], connectors disable|reenable|revoke <id> --tenant <id> --environment <id> --reason-code <code> --reason <text> --expected-version <version> [--control-plane-url <url>] [--format text|json], claude-config --endpoint <url> [--server-id <id>]

Usage notes

Check the command implementation when a result may be a dry run or a fixture. CLI success alone does not establish upstream execution or external delivery.

Source truth

• cmd/gatewayctl/main.go
• apps/docs/scripts/generate-reference-pages.mjs

Next

• Read Admin API for control-plane route contracts.
• Read Operator Workflow for daily baseline commands.
• Read Evals for harness-backed behavior checks.