List partial links

List all plugins linked to the partial

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

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

PartialIdstringrequired

ID of the Partial to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

The plugins linked to the partial

countinteger

The total number of plugins linked to the partial

Example:10

dataarray[object]
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

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

get/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}/links
 
200 application/json

Partials

Some entities in Kong Gateway share common configuration settings that often need to be repeated. For example, multiple plugins that connect to Redis may require the same connection settings. Without Partials, you would need to replicate this configuration across all plugins. If the settings change, you would need to update each plugin individually.

List all Partials

List all Partials

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

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

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

A successful response listing Partials

dataOne Of
array[object]
PartialRedisCeobject

Example:{"config":{"database":0,"host":"localhost","password":"password","port":6379,"server_name":"redis","ssl":false,"ssl_verify":false,"timeout":2000,"username":"username"},"type":"redis-ce"}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

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

get/control-planes/{controlPlaneId}/core-entities/partials
 
application/json

Create a new Partial

Create a new Partial

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

Description of the new Partial for creation

Partial

Partialobject
One Of
configobjectrequired
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

A unique string representing a UTF-8 encoded name.

tagsarray[string]

A string representing a tag.

typestringrequired

Allowed values:redis-ce

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully created Partial

Partial

Partialobject
One Of
configobjectrequired
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

A unique string representing a UTF-8 encoded name.

tagsarray[string]

A string representing a tag.

typestringrequired

Allowed values:redis-ce

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/partials

Body

{}
 
application/json

Delete a Partial

Delete a Partial

delete

Path Parameters

PartialIdstringrequired

ID of the Partial to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

Successfully deleted Partial or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}