Key Sets

Uses: Kong Gateway Admin API Konnect API

What is a Key Set?

A Key Set is a collection of Kong Gateway Keys.

You can assign one or many Keys to a Key Set. This can be useful to logically group multiple Keys to use for a specific application or service. Key Sets allow you to give a plugin access to a specific list of Keys.

Key Sets can be used with the following plugins:

ACME, with the config.account_key.key_set parameter
JWE Decrypt, with the config.key_sets parameter
JWT Signer, with the config.access_token_keyset parameter

Schema

Set up a Key Set

curl -i -X POST http://localhost:8001/key-sets/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "example-key-set"
    }
    '

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/key-sets \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "example-key-set"
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

Key Sets

What is a Key Set?

Schema

Set up a Key Set

Help us make these docs great!

Still need help