kongctl Documentation

This page is an introduction to kongctl, Kong's command-line tool for managing Konnect resources and infrastructure as code.

Learn how to use kongctl to manage Kong Konnect resources

Use Homebrew to install kongctl

Download and install the binary

Install the Windows binary

Use mise package manager

Learn how to configure kongctl using configuration files, environment variables, and command-line flags.

Learn how to authenticate kongctl to Kong Konnect using the device flow or personal access tokens.

Learn how to manage Kong Konnect infrastructure as code using declarative YAML configuration.

Reference for kongctl declarative configuration that lists supported resource types and their field-level values.

Learn how to use kongctl and decK together for declarative management of the entire API platform

Install kongctl agent skills to help coding agents manage kongctl configuration.

Learn how to use kongctl to listen to Konnect audit logs.

Common issues and solutions when using kongctl.

Adopt Kong resources using kongctl.

The analytics command adopts Konnect Observability resources into namespace management.

Adopt API resources.

Adopt authentication strategies.

Adopt control plane configurations.

Apply the KONGCTL-namespace label to an existing Konnect DCR provider that is not currently managed by kongctl.

Apply the KONGCTL-namespace label to an existing Konnect Event Gateway Control Plane that is not currently managed by kongctl.

Adopt Konnect resources.

Adopt organization settings.

Adopt Dev Portal configuration.

Make API requests using kongctl.

Delete resources via API.

Retrieve resources via API.

Partially update resources via API.

Create resources via API.

Update resources via API.

Apply Konnect configuration using kongctl.

Apply configuration to Konnect control planes.

Delete resources using kongctl.

Compare configurations using kongctl.

Show Konnect configuration differences.

Export configurations using kongctl.

Export declarative configuration.

Export configurations into Terraform format.

Explain shows the declarative schema for a supported resource type or field path.

Get detailed information about resources using kongctl.

The analytics command allows you to work with Konnect Observability resources.

Get API details.

Get audit logs.

Get authentication strategy details.

Get API catalog details.

Use the get verb with the dcr-provider command to query Konnect Dynamic Client Registration providers.

Use the get verb with the event-gateway command to query Konnect Event Gateways.

Get a kongctl CLI extension.

Get gateway information.

Get Konnect account information.

Get current user information.

Get organization details.

Get Portal configuration.

Get user profiles.

Get available regions.

Install local assets that help coding agents work with Konnect using kongctl.

Install a kongctl CLI extension.

Install kongctl agent skills.

Link locally developed features using kongctl.

Link a local development CLI extension.

Validate configuration files against a linting ruleset.

List resources using kongctl.

List APIs.

List authentication strategies.

Use the list verb with the dcr-provider command to query Konnect Dynamic Client Registration providers.

List installed kongctl CLI extensions.

List gateways.

List Konnect resources.

List organizations.

List Portal configurations.

The profile command allows you to list kongctl profiles and inspect profile configuration.

List Portal themes.

Listen to events using kongctl.

Listen to audit log stream.

Listen to Konnect events.

Authenticate with kongctl.

Log in to Konnect.

Log out with kongctl.

Log out from Konnect.

Patch resources using kongctl.

Apply patches from a declarative config file.

Plan changes using kongctl.

Plan changes for Konnect.

Manage processes using kongctl.

Stop Kong processes.

Scaffold emits a commented YAML starter configuration for a supported declarative resource path.

Synchronize configurations using kongctl.

Sync configuration with Konnect control planes.

Tail logs using kongctl.

Tail audit logs.

Tail Konnect events.

Uninstall kongctl features.

Uninstall a kongctl CLI extension.

Upgrade kongctl features.

Upgrade kongctl CLI extensions.

Launch the Konnect interactive viewer.