Delete a Partial in a workspace

Delete a Partial in a workspace

delete

Path Parameters

PartialIdstringrequired

ID of the Partial to lookup

workspacestring(string)required

The name of the workspace

Example:team-payments

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/{workspace}/partials/{PartialId}
 

Get a Partial in a workspace

Get a Partial using ID in a workspace.

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

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/{workspace}/partials/{PartialId}
 
application/json

Upsert a Partial in a workspace

Create or Update Partial using ID in a workspace.

put

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

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/{workspace}/partials/{PartialId}

Body

{}
 
application/json

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