Usage:
kongctl get event-gateway [flags]
kongctl get event-gateway [command]
Aliases:
event-gateway, egw, EGW, event-gateways
Examples:
# List all the Event Gateways for the organization
kongctl get event-gateways
# Get a specific Event Gateway
kongctl get event-gateways <id|name>
Available Commands:
backend-clusters Manage backend clusters for an Event Gateway
data-plane-certificates Manage data plane certificates for an Event Gateway
listener-policies Manage listener policies for an Event Gateway Listener
listeners Manage listeners for an Event Gateway
schema-registries Manage schema registries for an Event Gateway
static-keys Manage static keys for an Event Gateway
tls-trust-bundles Manage TLS trust bundles for an Event Gateway
virtual-clusters Manage virtual clusters for an Event Gateway
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
-h, --help help for event-gateway
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
Use "kongctl get event-gateway [command] --help" for more information about a command.
Use the backend-clusters command to list or retrieve backend clusters for a specific Event Gateway.
Usage:
kongctl get event-gateway backend-clusters [flags]
Aliases:
backend-clusters, backend-cluster, bc, bcs
Examples:
# List backend clusters for an event gateway by ID
kongctl get event-gateway backend-clusters --gateway-id <gateway-id>
# List backend clusters for an event gateway by name
kongctl get event-gateway backend-clusters --gateway-name my-gateway
# Get a specific backend cluster by ID (positional argument)
kongctl get event-gateway backend-clusters --gateway-id <gateway-id> <cluster-id>
# Get a specific backend cluster by name (positional argument)
kongctl get event-gateway backend-clusters --gateway-id <gateway-id> my-cluster
# Get a specific backend cluster by ID (flag)
kongctl get event-gateway backend-clusters --gateway-id <gateway-id> --backend-cluster-id <cluster-id>
# Get a specific backend cluster by name (flag)
kongctl get event-gateway backend-clusters --gateway-name my-gateway --backend-cluster-name my-cluster
Flags:
--backend-cluster-id string The ID of the backend cluster to retrieve.
- Config path: [ konnect.event-gateway.backend-cluster.id ]
--backend-cluster-name string The name of the backend cluster to retrieve.
- Config path: [ konnect.event-gateway.backend-cluster.name ]
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for backend-clusters
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
Use the data-plane-certificates command to list or retrieve data plane certificates for a specific Event Gateway.
Usage:
kongctl get event-gateway data-plane-certificates [flags]
Aliases:
data-plane-certificates, data-plane-certificate, dpc, dpcs, dp-cert, dp-certs
Examples:
# List data plane certificates for an event gateway by ID
kongctl get event-gateway data-plane-certificates --gateway-id <gateway-id>
# List data plane certificates for an event gateway by name
kongctl get event-gateway data-plane-certificates --gateway-name my-gateway
# Get a specific data plane certificate by ID (positional argument)
kongctl get event-gateway data-plane-certificates --gateway-id <gateway-id> <certificate-id>
# Get a specific data plane certificate by name (positional argument)
kongctl get event-gateway data-plane-certificates --gateway-id <gateway-id> my-certificate
# Get a specific data plane certificate by ID (flag)
kongctl get event-gateway data-plane-certificates --gateway-id <gateway-id> --data-plane-certificate-id <certificate-id>
# Get a specific data plane certificate by name (flag)
kongctl get event-gateway data-plane-certificates --gateway-name my-gateway --data-plane-certificate-name my-certificate
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--data-plane-certificate-id string The ID of the data plane certificate to retrieve.
- Config path: [ konnect.event-gateway.data-plane-certificate.id ]
--data-plane-certificate-name string The name of the data plane certificate to retrieve.
- Config path: [ konnect.event-gateway.data-plane-certificate.name ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for data-plane-certificates
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
Use the listener-policies command to list or retrieve listener policies for a specific Event Gateway Listener.
Usage:
kongctl get event-gateway listener-policies [flags]
Aliases:
listener-policies, listener-policy, lp, lps
Examples:
# List listener policies for a listener by ID
kongctl get event-gateway listener-policies --gateway-id <gateway-id> --listener-id <listener-id>
# List listener policies for a listener by name
kongctl get event-gateway listener-policies --gateway-name my-gateway --listener-name my-listener
# Get a specific listener policy by ID (positional argument)
kongctl get event-gateway listener-policies --gateway-id <gateway-id> --listener-id <listener-id> <policy-id>
# Get a specific listener policy by name (positional argument)
kongctl get event-gateway listener-policies --gateway-id <gateway-id> --listener-id <listener-id> my-policy
# Get a specific listener policy by ID (flag)
kongctl get event-gateway listener-policies --gateway-id <gateway-id> --listener-id <listener-id> --policy-id <policy-id>
# Get a specific listener policy by name (flag)
kongctl get event-gateway listener-policies --gateway-name my-gateway --listener-name my-listener --policy-name my-policy
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for listener-policies
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--listener-id string The ID of the listener to retrieve.
- Config path: [ konnect.event-gateway.listener.id ]
--listener-name string The name of the listener to retrieve.
- Config path: [ konnect.event-gateway.listener.name ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- Config path: [ konnect.pat ]
--policy-id string The ID of the listener policy to retrieve.
- Config path: [ konnect.event-gateway.listener-policy.id ]
--policy-name string The name of the listener policy to retrieve.
- Config path: [ konnect.event-gateway.listener-policy.name ]
-p, --profile string Specify the profile to use for this command. (default "default")
--region string Konnect region identifier (for example "eu"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
Use the listeners command to list or retrieve listeners for a specific Event Gateway.
Usage:
kongctl get event-gateway listeners [flags]
Aliases:
listeners, listener, ln, lns
Examples:
# List listeners for an event gateway by ID
kongctl get event-gateway listeners --gateway-id <gateway-id>
# List listeners for an event gateway by name
kongctl get event-gateway listeners --gateway-name my-gateway
# Get a specific listener by ID (positional argument)
kongctl get event-gateway listeners --gateway-id <gateway-id> <listener-id>
# Get a specific listener by name (positional argument)
kongctl get event-gateway listeners --gateway-id <gateway-id> my-listener
# Get a specific listener by ID (flag)
kongctl get event-gateway listeners --gateway-id <gateway-id> --listener-id <listener-id>
# Get a specific listener by name (flag)
kongctl get event-gateway listeners --gateway-name my-gateway --listener-name my-listener
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for listeners
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--listener-id string The ID of the listener to retrieve.
- Config path: [ konnect.event-gateway.listener.id ]
--listener-name string The name of the listener to retrieve.
- Config path: [ konnect.event-gateway.listener.name ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
Use the schema-registries command to list or retrieve schema registries for a specific Event Gateway.
Usage:
kongctl get event-gateway schema-registries [flags]
Aliases:
schema-registries, schema-registry, sr
Examples:
# List schema registries for an event gateway by ID
kongctl get event-gateway schema-registries --gateway-id <gateway-id>
# List schema registries for an event gateway by name
kongctl get event-gateway schema-registries --gateway-name my-gateway
# Get a specific schema registry by ID (positional argument)
kongctl get event-gateway schema-registries --gateway-id <gateway-id> <schema-registry-id>
# Get a specific schema registry by name (positional argument)
kongctl get event-gateway schema-registries --gateway-id <gateway-id> my-registry
# Get a specific schema registry by ID (flag)
kongctl get event-gateway schema-registries --gateway-id <gateway-id> --schema-registry-id <registry-id>
# Get a specific schema registry by name (flag)
kongctl get event-gateway schema-registries --gateway-name my-gateway --schema-registry-name my-registry
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for schema-registries
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
--schema-registry-id string The ID of the schema registry to retrieve.
- Config path: [ konnect.event-gateway.schema-registry.id ]
--schema-registry-name string The name of the schema registry to retrieve.
- Config path: [ konnect.event-gateway.schema-registry.name ]
Use the static-keys command to list or retrieve static keys for a specific Event Gateway.
Usage:
kongctl get event-gateway static-keys [flags]
Aliases:
static-keys, static-key, sk
Examples:
# List static keys for an event gateway by name
kongctl get event-gateway static-keys --gateway-name my-gateway
# List static keys for an event gateway by ID
kongctl get event-gateway static-keys --gateway-id <gateway-id>
# Get a specific static key by name (positional argument)
kongctl get event-gateway static-keys --gateway-name my-gateway my-static-key
# Get a specific static key by ID (positional argument)
kongctl get event-gateway static-keys --gateway-id <gateway-id> <static-key-id>
# Get a specific static key by name (flag)
kongctl get event-gateway static-keys --gateway-name my-gateway --static-key-name my-static-key
# Get a specific static key by ID (flag)
kongctl get event-gateway static-keys --gateway-id <gateway-id> --static-key-id <static-key-id>
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for static-keys
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
--static-key-id string The ID of the static key to retrieve.
- Config path: [ konnect.event-gateway.static-key.id ]
--static-key-name string The name of the static key to retrieve.
- Config path: [ konnect.event-gateway.static-key.name ]
Use the tls-trust-bundles command to list or retrieve TLS trust bundles for a specific Event Gateway.
TLS trust bundles define trusted certificate authorities used for mTLS client certificate verification and are referenced by TLS listener policies.
Usage:
kongctl get event-gateway tls-trust-bundles [flags]
Aliases:
tls-trust-bundles, tls-trust-bundle, ttb
Examples:
# List TLS trust bundles for an event gateway by name
kongctl get event-gateway tls-trust-bundles --gateway-name my-gateway
# List TLS trust bundles for an event gateway by ID
kongctl get event-gateway tls-trust-bundles --gateway-id <gateway-id>
# Get a specific TLS trust bundle by name (positional argument)
kongctl get event-gateway tls-trust-bundles --gateway-name my-gateway my-bundle
# Get a specific TLS trust bundle by ID (positional argument)
kongctl get event-gateway tls-trust-bundles --gateway-id <gateway-id> <bundle-id>
# Get a specific TLS trust bundle by name (flag)
kongctl get event-gateway tls-trust-bundles --gateway-name my-gateway --tls-trust-bundle-name my-bundle
# Get a specific TLS trust bundle by ID (flag)
kongctl get event-gateway tls-trust-bundles --gateway-id <gateway-id> --tls-trust-bundle-id <bundle-id>
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for tls-trust-bundles
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
--tls-trust-bundle-id string The ID of the TLS trust bundle to retrieve.
- Config path: [ konnect.event-gateway.tls-trust-bundle.id ]
--tls-trust-bundle-name string The name of the TLS trust bundle to retrieve.
- Config path: [ konnect.event-gateway.tls-trust-bundle.name ]
Use the virtual-clusters command to list or retrieve virtual clusters for a specific Event Gateway.
Usage:
kongctl get event-gateway virtual-clusters [flags]
kongctl get event-gateway virtual-clusters [command]
Aliases:
virtual-clusters, virtual-cluster, vc, vcs
Examples:
# List virtual clusters for an event gateway by ID
kongctl get event-gateway virtual-clusters --gateway-id <gateway-id>
# List virtual clusters for an event gateway by name
kongctl get event-gateway virtual-clusters --gateway-name my-gateway
# List virtual clusters for a backend cluster
kongctl get event-gateway virtual-clusters --gateway-id <gateway-id> --backend-cluster-id <cluster-id>
# Get a specific virtual cluster by ID (positional argument)
kongctl get event-gateway virtual-clusters --gateway-id <gateway-id> <cluster-id>
# Get a specific virtual cluster by name (positional argument)
kongctl get event-gateway virtual-clusters --gateway-id <gateway-id> my-cluster
# Get a specific virtual cluster by ID (flag)
kongctl get event-gateway virtual-clusters --gateway-id <gateway-id> --virtual-cluster-id <cluster-id>
# Get a specific virtual cluster by name (flag)
kongctl get event-gateway virtual-clusters --gateway-name my-gateway --virtual-cluster-name my-cluster
Available Commands:
cluster-policies Manage cluster policies for an Event Gateway Virtual Cluster
consume-policies Manage consume policies for an Event Gateway Virtual Cluster
produce-policies Manage produce policies for an Event Gateway Virtual Cluster
Flags:
--backend-cluster-id string The ID of the backend cluster to retrieve.
- Config path: [ konnect.event-gateway.backend-cluster.id ]
--backend-cluster-name string The name of the backend cluster to retrieve.
- Config path: [ konnect.event-gateway.backend-cluster.name ]
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
- Default : [ https://us.api.konghq.com ]
--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.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.id ]
--gateway-name string The name of the event gateway that owns the resource.
- Config path: [ konnect.event-gateway.name ]
-h, --help help for virtual-clusters
--jq string Filter JSON responses using jq expressions (powered by gojq for full jq compatibility)
--jq-color string Controls colorized output for jq filter results.
- Config path: [ jq.color.enabled ]
- Allowed : [ auto|always|never ] (default "auto")
--jq-color-theme string Select the color theme used for jq filter results.
- Config path: [ jq.color.theme ]
- Examples : [ friendly, github-dark, dracula ]
- Reference : [ https://xyproto.github.io/splash/docs/ ] (default "friendly")
-r, --jq-raw-output Output string jq results without JSON quotes (like jq -r).
- Config path: [ jq.raw-output ]
--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 ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--page-size int Max number of results to include per response page for get and list operations.
- Config path: [ konnect.page-size ] (default 10)
--pat string Konnect Personal Access Token (PAT) used to authenticate the CLI.
Setting this value overrides tokens obtained from the login command.
- 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"). Used to construct the base URL when --base-url is not provided.
- Config path: [ konnect.region ]
--virtual-cluster-id string The ID of the virtual cluster to retrieve.
- Config path: [ konnect.event-gateway.virtual-cluster.id ]
--virtual-cluster-name string The name of the virtual cluster to retrieve.
- Config path: [ konnect.event-gateway.virtual-cluster.name ]
Use "kongctl get event-gateway virtual-clusters [command] --help" for more information about a command.