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

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

Use Homebrew to install kongctl

Download and install the binary

Install the Windows binary

Use mise package manager

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.

Common issues and solutions when using kongctl.

Adopt Kong resources using kongctl.

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.

Adopt Konnect APIs.

Adopt Konnect authentication strategies.

Adopt Konnect control plane configuration.

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 organization settings.

Adopt Konnect Developer Portal configuration.

Adopt organization teams.

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.

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 gateway information.

Get Konnect account information.

Get current user information.

Get organization details.

Get Portal configuration.

Get user profiles.

Get available regions.

Get API attributes.

Get API documents.

Get API implementations.

Get API publications.

Get API versions.

Get audit log destination.

Get audit log destinations.

Get audit log webhook.

Get catalog service.

Use the backend-clusters command to list or retrieve backend clusters for a specific Event Gateway.

Use the data-plane-certificates command to list or retrieve data plane certificates for a specific Event Gateway.

Use the listener-policies command to list or retrieve listener policies for a specific Event Gateway Listener.

Use the listeners command to list or retrieve listeners for a specific Event Gateway.

Use the schema-registries command to list or retrieve schema registries for a specific Event Gateway.

Use the static-keys command to list or retrieve static keys for a specific Event Gateway.

Use the tls-trust-bundles command to list or retrieve TLS trust bundles for a specific Event Gateway.

Use the virtual-clusters command to list or retrieve virtual clusters for a specific Event Gateway.

Get gateway consumer.

Get gateway control plane.

Get gateway route.

Get gateway service.

Get Konnect API information.

Get Konnect audit logs.

Get Konnect authentication strategy 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 Konnect gateway information.

Get Konnect user information.

Get Konnect organization details.

Get Konnect Portal configuration.

Get Konnect available regions.

Get organization system account.

Get organization team.

Get Portal application registrations.

Get Portal applications.

Get Portal assets.

Get Portal authentication settings.

Get Portal developers.

Get Portal email domains.

Use the identity-providers command to list identity providers for a Konnect portal.

Get Portal pages.

Get Portal snippets.

Get Portal team roles.

Get Portal teams.

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

Install kongctl agent skills.

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 gateways.

List Konnect resources.

List organizations.

List Portal configurations.

List Portal themes.

List API attributes.

List API documents.

List API implementations.

List API publications.

List API versions.

List gateway consumers.

List gateway control planes.

List gateway routes.

List gateway services.

List Konnect APIs.

List Konnect authentication strategies.

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

List Konnect event gateways.

List Konnect gateways.

List Konnect organizations.

List Konnect Portal configurations.

List organization system accounts.

List organization teams.

List Portal application registrations.

List Portal applications.

List Portal assets.

List Portal authentication settings.

List Portal developers.

List Portal email domains.

Use the identity-providers command to list identity providers for a Konnect portal.

List Portal pages.

List Portal snippets.

List Portal team roles.

List Portal teams.

Listen to events using kongctl.

Listen to audit log stream.

Listen to Konnect events.

Listen to Konnect audit log stream.

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.

Tail Konnect audit logs.

Launch the Konnect interactive viewer.