Update a Key-set

Update a Key-set using ID or name.

put

Path Parameters

key-set_id_or_namestringrequired

The unique identifier or the name attribute of the Key Set that should be associated to the newly-created Key.

Example:46CA83EE-671C-11ED-BFAB-2FE47512C77A

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
namestring

The name to associate with the given key-set.

Example:my-key_set

tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

Response

application/json

Key set object response body

idstring

Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

namestring

The name to associate with the given key-set.

Example:my-key_set

created_atinteger

Unix epoch when the resource was last created.

Example:1422386534

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

tagsarray[string]

The name to associate with the given key-set.

nextstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

put/runtime-groups/{runtimeGroupId}/core-entities/key-sets/{key-set_id_or_name}

Body

{}
 
application/json

Information

Information routes

Get a Plugin Schema

Retrieve the schema of a plugin’s configuration. This is useful to understand what fields a plugin accepts, and can be used for building third-party integrations to the Kong’s plugin system.

get

Query Parameters

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

plugin_namestringrequired

The name of a Kong plugin

Example:basic-auth

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200

OK

get/runtime-groups/{runtimeGroupId}/core-entities/schemas/plugins/{plugin_name}
 
200

Debug

Debug routes

Set Node Log Level of All Control Plane Nodes

Change the log level of all Control Plane nodes deployed in Hybrid (CP/DP) cluster.

See the NGINX docs for a list of accepted values.

Care must be taken when changing the log level of a node to debug in a production environment because the disk could fill up quickly. As soon as the debug logging finishes, revert back to a higher level such as notice.

It’s currently not possible to change the log level of DP and DB-less nodes.

put

Path Parameters

log_levelstringrequired

Log levels are set in Kong’s configuration. Log levels increase in order of their severity

Allowed values:infonoticewarnerrorcrit

Example:warn

runtimeGroupIdstringrequired

Response

200 application/json

OK

messagestring

Response message

Example:log level changed

put/runtime-groups/{runtimeGroupId}/core-entities/debug/cluster/control-planes-nodes/log-level/{log_level}
 
200 application/json