Usage:
kongctl list ai-gateway [flags]
kongctl list ai-gateway [command]
Maturity:
beta
Aliases:
ai-gateway, ai-gateways, aigw, AIGW
Examples:
# List all AI Gateways
kongctl list ai-gateways
# List AI Gateways using aliases
kongctl list aigw
Available Commands:
agents List or get Agents for a Konnect AI Gateway
consumer-groups List or get Consumer Groups for a Konnect AI Gateway
consumers List or get Consumers for a Konnect AI Gateway
credentials List or get Consumer Credentials for a Konnect AI Gateway Consumer
data-plane-certificates List or get data plane certificates for a Konnect AI Gateway
identity-providers List or get identity providers for a Konnect AI Gateway
mcp-servers List or get MCP Servers for a Konnect AI Gateway
model-providers List or get model providers for a Konnect AI Gateway
models List or get models for a Konnect AI Gateway
nodes List or get data plane Nodes for a Konnect AI Gateway
policies List or get Policies for a Konnect AI Gateway
vaults List or get Vaults for a Konnect AI 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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
-h, --help help for ai-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 list ai-gateway [command] --help" for more information about a command.
Use the agents command to list or retrieve Agents for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway agents [agent-id|agent-name] [flags]
Maturity:
beta
Aliases:
agents, agent
Examples:
# List Agents for an AI Gateway by display name
kongctl get ai-gateway agents --gateway-name "Customer Support Gateway"
# List Agents for an AI Gateway by ID
kongctl get ai-gateway agents --gateway-id <gateway-id>
# Get an Agent by name
kongctl get ai-gateway agents --gateway-name "Customer Support Gateway" booking-agent
# Get an Agent by ID
kongctl get ai-gateway agents --gateway-id <gateway-id> --agent-id <agent-id>
Flags:
--agent-id string The ID of the AI Gateway Agent to retrieve.
- Config path: [ konnect.ai-gateway.agent.id ]
--agent-name string The name of the AI Gateway Agent to retrieve.
- Config path: [ konnect.ai-gateway.agent.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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for agents
--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 consumer-groups command to list or retrieve Consumer Groups for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway consumer-groups [consumer-group-id|consumer-group-name] [flags]
Maturity:
beta
Aliases:
consumer-groups, consumer-group
Examples:
# List Consumer Groups for an AI Gateway by display name
kongctl get ai-gateway consumer-groups --gateway-name "Customer Support Gateway"
# List Consumer Groups for an AI Gateway by ID
kongctl get ai-gateway consumer-groups --gateway-id <gateway-id>
# Get a Consumer Group by name
kongctl get ai-gateway consumer-groups --gateway-name "Customer Support Gateway" premium-users
# Get a Consumer Group by ID
kongctl get ai-gateway consumer-groups --gateway-id <gateway-id> --consumer-group-id <consumer-group-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--consumer-group-id string The ID of the AI Gateway Consumer Group to retrieve.
- Config path: [ konnect.ai-gateway.consumer-group.id ]
--consumer-group-name string The name of the AI Gateway Consumer Group to retrieve.
- Config path: [ konnect.ai-gateway.consumer-group.name ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for consumer-groups
--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 consumers command to list or retrieve Consumers for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway consumers [consumer-id|consumer-name] [flags]
Maturity:
beta
Aliases:
consumers, consumer
Examples:
# List Consumers for an AI Gateway by display name
kongctl get ai-gateway consumers --gateway-name "Customer Support Gateway"
# List Consumers for an AI Gateway by ID
kongctl get ai-gateway consumers --gateway-id <gateway-id>
# Get a Consumer by name
kongctl get ai-gateway consumers --gateway-name "Customer Support Gateway" support-user
# Get a Consumer by ID
kongctl get ai-gateway consumers --gateway-id <gateway-id> --consumer-id <consumer-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--consumer-id string The ID of the AI Gateway Consumer to retrieve.
- Config path: [ konnect.ai-gateway.consumer.id ]
--consumer-name string The name of the AI Gateway Consumer to retrieve.
- Config path: [ konnect.ai-gateway.consumer.name ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for consumers
--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 credentials command to list or retrieve Credentials for a specific Konnect AI Gateway Consumer.
Usage:
kongctl list ai-gateway credentials [credential-id|credential-name] [flags]
Maturity:
beta
Aliases:
credentials, credential, consumer-credential, consumer-credentials
Examples:
# List Credentials for an AI Gateway Consumer by names
kongctl get ai-gateway credentials --gateway-name "Customer Support Gateway" --consumer-name support-user
# List Credentials for an AI Gateway Consumer by IDs
kongctl get ai-gateway credentials --gateway-id <gateway-id> --consumer-id <consumer-id>
# Get a Credential by name
kongctl get ai-gateway credentials --gateway-name "Customer Support Gateway" --consumer-name support-user support-user-key
# Get a Credential by ID
kongctl get ai-gateway credentials --gateway-id <gateway-id> --consumer-id <consumer-id> --credential-id <credential-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--consumer-id string The ID of the AI Gateway Consumer to retrieve.
- Config path: [ konnect.ai-gateway.consumer.id ]
--consumer-name string The name of the AI Gateway Consumer to retrieve.
- Config path: [ konnect.ai-gateway.consumer.name ]
--credential-id string The ID of the AI Gateway Consumer Credential to retrieve.
- Config path: [ konnect.ai-gateway.consumer.credential.id ]
--credential-name string The name of the AI Gateway Consumer Credential to retrieve.
- Config path: [ konnect.ai-gateway.consumer.credential.name ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for credentials
--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 Konnect AI Gateway.
Usage:
kongctl list ai-gateway data-plane-certificates [certificate-id|title] [flags]
Maturity:
beta
Aliases:
data-plane-certificates, data-plane-certificate, dpc, dpcs, dp-cert, dp-certs
Examples:
# List data plane certificates for an AI Gateway by display name
kongctl get ai-gateway data-plane-certificates --gateway-name "Customer Support Gateway"
# List data plane certificates for an AI Gateway by ID
kongctl get ai-gateway data-plane-certificates --gateway-id <gateway-id>
# Get a data plane certificate by title
kongctl get ai-gateway data-plane-certificates --gateway-name "Customer Support Gateway" support-data-plane-cert
# Get a data plane certificate by ID
kongctl get ai-gateway data-plane-certificates --gateway-id <gateway-id> --data-plane-certificate-id <certificate-id>
# Get a data plane certificate by title flag
kongctl get ai-gateway data-plane-certificates --gateway-id <gateway-id> \
--data-plane-certificate-title support-data-plane-cert
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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--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 AI Gateway data plane certificate to retrieve.
- Config path: [ konnect.ai-gateway.data-plane-certificate.id ]
--data-plane-certificate-title string The title of the AI Gateway data plane certificate to retrieve.
- Config path: [ konnect.ai-gateway.data-plane-certificate.title ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-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 identity-providers command to list or retrieve identity providers for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway identity-providers [identity-provider-id|identity-provider-name] [flags]
Maturity:
beta
Aliases:
identity-providers, identity-provider, identity
Examples:
# List identity providers for an AI Gateway by ID
kongctl get ai-gateways identity-providers --gateway-id <gateway-id>
# List identity providers for an AI Gateway by display name
kongctl get ai-gateways identity-providers --gateway-name "Customer Support Gateway"
# Get an identity provider by ID or name
kongctl get ai-gateways identity-providers --gateway-name "Customer Support Gateway" support-key-auth
# Get an identity provider by flag
kongctl get ai-gateways identity-providers --gateway-id <gateway-id> --identity-provider-name support-key-auth
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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for identity-providers
--identity-provider-id string The ID of the AI Gateway Identity Provider to retrieve.
- Config path: [ konnect.ai-gateway.identity-provider.id ]
--identity-provider-name string The name of the AI Gateway Identity Provider to retrieve.
- Config path: [ konnect.ai-gateway.identity-provider.name ]
--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 mcp-servers command to list or retrieve MCP Servers for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway mcp-servers [mcp-server-id|mcp-server-name] [flags]
Maturity:
beta
Aliases:
mcp-servers, mcp-server
Examples:
# List MCP Servers for an AI Gateway by display name
kongctl get ai-gateway mcp-servers --gateway-name "Customer Support Gateway"
# List MCP Servers for an AI Gateway by ID
kongctl get ai-gateway mcp-servers --gateway-id <gateway-id>
# Get an MCP Server by name
kongctl get ai-gateway mcp-servers --gateway-name "Customer Support Gateway" customer-support-tools
# Get an MCP Server by ID
kongctl get ai-gateway mcp-servers --gateway-id <gateway-id> --mcp-server-id <mcp-server-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for mcp-servers
--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")
--mcp-server-id string The ID of the AI Gateway MCP Server to retrieve.
- Config path: [ konnect.ai-gateway.mcp-server.id ]
--mcp-server-name string The name of the AI Gateway MCP Server to retrieve.
- Config path: [ konnect.ai-gateway.mcp-server.name ]
--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 model-providers command to list or retrieve model providers for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway model-providers [model-provider-id|model-provider-name] [flags]
Maturity:
beta
Aliases:
model-providers, model-provider
Examples:
# List model providers for an AI Gateway by ID
kongctl get ai-gateways model-providers --gateway-id <gateway-id>
# List model providers for an AI Gateway by display name
kongctl get ai-gateways model-providers --gateway-name "Customer Support Gateway"
# Get a model provider by ID or name
kongctl get ai-gateways model-providers --gateway-name "Customer Support Gateway" openai-provider
# Get a model provider by flag
kongctl get ai-gateways model-providers --gateway-id <gateway-id> --model-provider-name openai-provider
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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for model-providers
--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")
--model-provider-id string The ID of the AI Gateway Model Provider to retrieve.
- Config path: [ konnect.ai-gateway.model-provider.id ]
--model-provider-name string The name of the AI Gateway Model Provider to retrieve.
- Config path: [ konnect.ai-gateway.model-provider.name ]
--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 models command to list or retrieve models for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway models [model-id|model-name] [flags]
Maturity:
beta
Aliases:
models, model
Examples:
# List models for an AI Gateway by display name
kongctl get ai-gateway models --gateway-name "Customer Support Gateway"
# List models for an AI Gateway by ID
kongctl get ai-gateway models --gateway-id <gateway-id>
# Get a model by name
kongctl get ai-gateway models --gateway-name "Customer Support Gateway" support-gpt
# Get a model by ID
kongctl get ai-gateway models --gateway-id <gateway-id> --model-id <model-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for models
--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")
--model-id string The ID of the AI Gateway Model to retrieve.
- Config path: [ konnect.ai-gateway.model.id ]
--model-name string The name of the AI Gateway Model to retrieve.
- Config path: [ konnect.ai-gateway.model.name ]
--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 nodes command to list or retrieve data plane Nodes for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway nodes [node-id] [flags]
Maturity:
beta
Aliases:
nodes, node, data-plane-nodes, data-plane-node
Examples:
# List Nodes for an AI Gateway by display name
kongctl get ai-gateway nodes --gateway-name "Customer Support Gateway"
# List Nodes for an AI Gateway by ID
kongctl get ai-gateway nodes --gateway-id <gateway-id>
# Get a Node by ID
kongctl get ai-gateway nodes --gateway-name "Customer Support Gateway" <node-id>
# Get a Node by ID flag
kongctl get ai-gateway nodes --gateway-id <gateway-id> --node-id <node-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for nodes
--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 ]
--node-id string The ID of the AI Gateway Node to retrieve.
- Config path: [ konnect.ai-gateway.node.id ]
-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 policies command to list or retrieve Policies for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway policies [policy-id|policy-name] [flags]
Maturity:
beta
Aliases:
policies, policy
Examples:
# List Policies for an AI Gateway by display name
kongctl get ai-gateway policies --gateway-name "Customer Support Gateway"
# List Policies for an AI Gateway by ID
kongctl get ai-gateway policies --gateway-id <gateway-id>
# Get a Policy by name
kongctl get ai-gateway policies --gateway-name "Customer Support Gateway" mask-sensitive-data
# Get a Policy by ID
kongctl get ai-gateway policies --gateway-id <gateway-id> --policy-id <policy-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for 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 ]
--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 AI Gateway Policy to retrieve.
- Config path: [ konnect.ai-gateway.policy.id ]
--policy-name string The name of the AI Gateway Policy to retrieve.
- Config path: [ konnect.ai-gateway.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 vaults command to list or retrieve Vaults for a specific Konnect AI Gateway.
Usage:
kongctl list ai-gateway vaults [vault-id|vault-name] [flags]
Maturity:
beta
Aliases:
vaults, vault
Examples:
# List Vaults for an AI Gateway by display name
kongctl get ai-gateway vaults --gateway-name "Customer Support Gateway"
# List Vaults for an AI Gateway by ID
kongctl get ai-gateway vaults --gateway-id <gateway-id>
# Get a Vault by name
kongctl get ai-gateway vaults --gateway-name "Customer Support Gateway" support-env
# Get a Vault by ID
kongctl get ai-gateway vaults --gateway-id <gateway-id> --vault-id <vault-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")
--columns stringArray Select text columns as HEADER=.field (repeatable or comma-separated). Supports nested fields, quoted keys, array indexes, and string slices.
--config-file string Path to the configuration file to load.
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--gateway-id string The ID of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.id ]
--gateway-name string The name or display_name of the AI Gateway that owns the resource.
- Config path: [ konnect.ai-gateway.name ]
-h, --help help for vaults
--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 ]
--vault-id string The ID of the AI Gateway Vault to retrieve.
- Config path: [ konnect.ai-gateway.vault.id ]
--vault-name string The name of the AI Gateway Vault to retrieve.
- Config path: [ konnect.ai-gateway.vault.name ]