Inspect resource relationships, computed configuration, and runtime state. Currently supports Kong Mesh.
kongctl inspect
Uses:
kongctl
Related Documentation
Incompatible with
on-prem
Related Resources
Examples
kongctl inspect mesh dataplanesSubcommands
kongctl provides the following tools for inspecting resources:
|
Command |
Description |
|---|---|
| kongctl inspect konnect | Inspect Konnect resources. |
| kongctl inspect mesh | Inspect what a Kong Mesh control plane computed. |
Command usage
Usage:
kongctl inspect [flags]
kongctl inspect [command]
Examples:
kongctl inspect mesh dataplanes
Available Commands:
konnect Manage Konnect resources
mesh Inspect what a control plane computed for a resource
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
--color-theme string Configures the CLI UI/theme (prompt, tables, TUI elements).
- Config path: [ color-theme ]
- Examples : [ auto, 3024_day, 3024_night, aardvark_blue, abernathy ]
- Reference : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "auto")
--config-file string Path to the configuration file to load.
- Environment variable: KONGCTL_CONFIG_FILE (overridden by this flag)
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
-h, --help help for inspect
--log-file string Write execution logs to the specified file instead of STDERR.
- Config path: [ log-file ]
--log-level string Configures the logging level. Execution logs are written to STDERR.
- Config path: [ log-level ]
- Allowed : [ trace|debug|info|warn|error ] (default "error")
--no-telemetry Disable telemetry for this command invocation. Overrides config and env.
- Config path: [ telemetry.enabled ]
- Env var : [ KONGCTL_NO_TELEMETRY ]
- Default : [ false ]
--no-trunc Preserve full cell widths in static text tables beyond terminal width.
Does not change column selection, UUID formatting, or explicit string slices.
- Config path: [ text.no-trunc ]
- Default : [ false ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--pat string Konnect Personal Access Token (PAT).
- Config path: [ konnect.pat ]
-p, --profile string Specify the profile to use for this command. (default "default")
--region string Konnect region identifier (for example eu).
- Config path: [ konnect.region ]
--text-id-format string Configure UUID rendering in static text-table ID columns.
- Config path: [ text.id-format ]
- Allowed : [ compact|full ]
- Default : [ compact ]
--text-layout string Configure static text-table column selection.
- Config path: [ text.layout ]
- Allowed : [ compact|auto|wide ]
- Default : [ compact ]
Use "kongctl inspect [command] --help" for more information about a command.