Retrieving information using kongctl

Beta and uses: kongctl
Related Documentation
Incompatible with
on-prem

kongctl provides the following tools for retrieving resources and resource details:

Command

Description

kongctl get api Get API details.
kongctl get audit-logs Get audit logs.
kongctl get auth-strategy Get authentication strategy details.
kongctl get catalog Get details.
kongctl get gateway Get gateway information.
kongctl get konnect Get Konnect account information.
kongctl get me Get current user information.
kongctl get organization Get organization details.
kongctl get portal Get Portal configuration.
kongctl get profile Get user profile.
kongctl get regions Get available regions.

Command usage

Usage:
  kongctl get [flags]
  kongctl get [command]

Aliases:
  get, g, G

Examples:
  # Retrieve Konnect portals
  kongctl get portals
  # Retrieve Konnect APIs
  kongctl get apis
  # Retrieve Konnect auth strategies
  kongctl get auth-strategies
  # Retrieve Konnect control planes (Konnect-first)
  kongctl get gateway control-planes
  # Retrieve Konnect control planes (explicit)
  kongctl get konnect gateway control-planes
  # Retrieve Konnect audit-log destinations
  kongctl get audit-logs destinations

Available Commands:
  api           List or get Konnect APIs
  audit-logs    Get Konnect audit-log destinations and webhook state
  auth-strategy List or get Konnect authentication strategies
  catalog       Manage Konnect catalog resources
  gateway       Manage Konnect Kong Gateway resources
  konnect       Manage Konnect resources
  me            Get current user information
  organization  Get current organization information
  portal        List or get Konnect portals
  profile       Manage CLI profiles
  regions       List available Konnect regions


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   : [ 3024_day, 3024_night, adventure, adventure_time, afterglow ]
                                - Reference  : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "kong-light")
      --config-file string      Path to the configuration file to load.
                                - Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
  -h, --help                    help for get
      --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")
  -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 [command] --help" for more information about a command.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!