Skip to main content

kongctl - a CLI for kong admin interface.

Project description

A command line client for kong admin API

This tool ease kong management like getting routes for service name (not id):

kongctl -s https://localhost:8001 list routes -s example-service

1ba43640-6977-4d6a-9804-6e0032d77bb1: example-service

d091d9c4-fde8-4982-b984-8376bd544aaf: example-service

You can store your configuration in multiple yaml files and apply them individually. Let’s assume you have configuration like this:

_format_version: "1.1"

  - name: orders-service
      - name: orders-root
        strip_path: true

      - name: jwt
        enabled: false
          name: orders-root

        run_on: first
          key_claim_name: iss
          cookie_names: {}
          secret_is_base64: false
          maximum_expiration: 0
          run_on_preflight: true
            - jwt

Now you can call the following command to apply it:

kongctl -s https://localhost:8001 ensure order-service.yaml


brew tap kepkin/kongctl
brew install kongctl


pip3 install kongctl

Quick guide to usage

mkdir ~/.kongctl
cat  > ~/.kongctl/qa-env << EOF
  "client": {
    "server": "https://my-kong.url:8001",
    "auth": {
      "password": "pass",
      "type": "basic",
      "user": "user"
  "var_map": {
    "VAR1": "VALUE1",
    "VAR2": "VALUE2"

kong -c qa-env list services


  • Support for OIDC authorization
  • Get stubs for create operation
  • Support all key-auth like plugins
  • Support update from cmd args
  • Support yaml
  • Sort by id?
  • list command filter option
  • Autocomplete
  • Add images instead of code in README (to show color support)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kongctl-0.3.8.tar.gz (16.7 kB view hashes)

Uploaded source

Built Distributions

kongctl-0.3.8-py3.8.egg (39.9 kB view hashes)

Uploaded 0 3 8

kongctl-0.3.8-py2.py3-none-any.whl (17.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page