Deleting resources using kongctl

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

kongctl provides the following tools for deleting resources:

Command

Description

kongctl delete gateway Delete a gateway.
kongctl delete konnect Delete resources from Konnect.
kongctl delete portal Delete Portal configuration.

Command usage

Usage:
  kongctl delete [flags]
  kongctl delete [command]

Aliases:
  delete, d, D, del, rm, DEL, RM

Examples:
  # Delete resources defined in declarative configuration
  kongctl delete -f config.yaml
  kongctl delete -f ./configs/ --recursive
  kongctl delete -f config.yaml --dry-run
  # Delete a Konnect Kong Gateway control plane (Konnect-first)
  kongctl delete gateway control-plane <id>
  # Delete a Konnect Kong Gateway control plane (explicit)
  kongctl delete konnect gateway control-plane <id>
  # Delete a Konnect portal by ID (Konnect-first)
  kongctl delete portal 12345678-1234-1234-1234-123456789012
  # Delete a Konnect portal by name
  kongctl delete portal my-portal

Available Commands:
  gateway     Manage Konnect Kong Gateway resources
  konnect     Manage Konnect resources
  portal      Delete a Konnect portal


Flags:
      --auto-approve                   Skip confirmation prompt
      --base-dir string                Base directory boundary for !file resolution.
                                       Defaults to each -f source root (file: its parent dir, dir: the directory itself). For stdin, defaults to CWD.
                                       - Config path: [ konnect.declarative.base-dir ]
      --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 ]
      --dry-run                        Preview deletions without executing them
      --execution-report-file string   Save execution report as JSON to file
  -f, --filename strings               Filename or directory to files to use to create the resource (can specify multiple)
      --force                          Force deletion even when related resources exist (not configurable)
  -h, --help                           help for delete
      --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                  Output format (text|json|yaml) (default "text")
      --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 ]
      --plan string                    Path to existing delete plan file
  -p, --profile string                 Specify the profile to use for this command. (default "default")
  -R, --recursive                      Process the directory used in -f, --filename recursively
      --region string                  Konnect region identifier (for example "eu"). Used to construct the base URL when --base-url is not provided.
                                       - Config path: [ konnect.region ]
      --require-any-namespace          Require explicit namespace on all resources (via kongctl.namespace or _defaults.kongctl.namespace).
                                       Cannot be used with --require-namespace.
                                       - Config path: [ konnect.declarative.require-any-namespace ]
      --require-namespace strings      Require specific namespaces. Accepts comma-separated list or repeated flags.
                                       Cannot be used with --require-any-namespace.
                                       Examples:
                                         --require-namespace=foo                          # Allow only 'foo' namespace
                                         --require-namespace=foo,bar                      # Allow 'foo' or 'bar' (comma-separated)
                                         --require-namespace=foo --require-namespace=bar  # Allow 'foo' or 'bar' (repeated flags)
                                       - Config path: [ konnect.declarative.require-namespace ]

Use "kongctl delete [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!