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

Set Node Log Level of All Nodes

Change the log level of all nodes in a cluster.

See the NGINX docs for a list of accepted values.

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

Currently, when a user dynamically changes the log level for the entire cluster, if a new node joins a cluster the new node will run at the previous log level, not at the log level that was previously set dynamically for the entire cluster.

put

Path Parameters

runtimeGroupIdstringrequired

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

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

log_levelstringrequired

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

Allowed values:infonoticewarnerrorcrit

Example:warn

Response

200 application/json

OK

messagestring

A message containing information about the log level

Example:log level changed

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

Get a Node Log Level of A Node

Retrieve the current log level of a node.

See the NGINX documentation for the list of possible return values.

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

runtimeGroupIdstringrequired

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

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

Response

200 application/json

OK

messagestring

A message containing the current log level of the node.

Example:log level: debug

get/runtime-groups/{runtimeGroupId}/core-entities/debug/node/log-level
 
200 application/json