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}
 

Get a Partial

Get a Partial using ID.

get

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

application/json

Successfully fetched 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.

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

Upsert a Partial

Create or Update Partial using ID.

put

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

Body

application/json

Description of the 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.

Response

application/json

Successfully upserted 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.

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

Body

{}
 
application/json

Plugins

A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins let you add functionality to services that run behind a Kong Gateway instance, like authentication or rate limiting.
You can find more information about available plugins and which values each plugin accepts at the Plugin Hub.



When adding a plugin configuration to a service, the plugin will run on every request made by a client to that service. If a plugin needs to be tuned to different values for some specific consumers, you can do so by creating a separate plugin instance that specifies both the service and the consumer, through the service and consumer fields.