Konnect Control Planes (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

The API for Kong Konnect Control Planes.

Control Planes

List Control Planes

Returns an array of control plane objects containing information about the Konnect Control Planes.

Authorizations:

personalAccessTokensystemAccountAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object (ControlPlaneFilterParameters) Filters a collection of control-planes.
labels	string Example: labels=key:value,existCheck Filter control planes in the response by associated labels.
sort	string (SortQuery) Example: sort=name,created_at desc Sorts a collection of control-planes. Supported sort attributes are: created_at

Responses

Response samples

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"labels": {"env": "test"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": true,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Control Plane

Create a control plane in the Konnect Organization.

Authorizations:

personalAccessTokensystemAccountAccessToken

Request Body schema: application/json

name required	string The name of the control plane.
description	string The description of the control plane in Konnect.
cluster_type	string Enum: "CLUSTER_TYPE_CONTROL_PLANE" "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER" "CLUSTER_TYPE_CONTROL_PLANE_GROUP" "CLUSTER_TYPE_SERVERLESS" The ClusterType value of the cluster associated with the Control Plane.
auth_type	string Enum: "pinned_client_certs" "pki_client_certs" The auth type value of the cluster associated with the Runtime Group.
cloud_gateway	boolean Whether this control-plane can be used for cloud-gateways.
	Array of objects (ProxyURLs) Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
	object (Labels) Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
],
"labels": {"env": "test"
}
}

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"labels": {"env": "test"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Fetch Control Plane

Returns information about an individual control plane.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The control plane ID

Responses

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"labels": {"env": "test"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update Control Plane

Update an individual control plane.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The control plane ID

Request Body schema: application/json

name	string The name of the control plane.
description	string The description of the control plane in Konnect.
auth_type	string Enum: "pinned_client_certs" "pki_client_certs" The auth type value of the cluster associated with the Runtime Group.
	Array of objects (ProxyURLs) Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
	object (Labels) Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
],
"labels": {"env": "development"
}
}

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"labels": {"env": "test"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Control Plane

Delete an individual control plane.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The control plane ID

Responses

Response samples

Content type

application/problem+json

Example

Request Format Invalid

{"status": 400,
"title": "Bad Request",
"detail": "Invalid request format",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Control Plane Groups

List Control Plane Group Memberships

Returns an array of control planes that are a member of this control plane group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane group

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-memberships

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-memberships

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-memberships

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-memberships

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-memberships

Response samples

Content type

application/json

{"meta": {"page": {"total": 2,
"size": 100,
"next": "/control-planes/57fdf779-7935-476f-ab2b-7fa1323b70e6/group-memberships?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ"
}
},
"data": [{"id": "774f2a35-509d-4b94-97e9-1ed49563bcb1",
"name": "Group Member 1",
"description": "Child RG",
"labels": {"env": "prod"
},
"config": {"control_plane_endpoint": "https://9e0353434a.us.cp0.konghq.com",
"telemetry_endpoint": "https://9e0353434a.us.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2023-03-20T22:23:45.873Z",
"updated_at": "2023-03-30T16:17:55.073Z"
},
{"id": "e4a1917c-bb26-4aa1-9a3e-50ee366f13db",
"name": "Group Member 2",
"description": "Child RG",
"labels": {"env": "prod",
"foo": "bar"
},
"config": {"control_plane_endpoint": "https://05459046af.us.cp0.konghq.com",
"telemetry_endpoint": "https://05459046af.us.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2023-03-23T22:25:30.907Z",
"updated_at": "2023-03-30T16:18:12.067Z"
}
]
}

Upsert Control Plane Group Members

Adds one or more control planes as a member of a control plane group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane group

Request Body schema: application/json

Request body for upserting a list of child control planes to a control plane group membership.

required

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-memberships

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-memberships

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-memberships

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-memberships

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-memberships

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

Add Control Plane Group Members

Adds one or more control planes as a member of a control plane group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane group

Request Body schema: application/json

Request body for adding a list of child control planes to a control plane group membership.

required

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-memberships/add

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-memberships/add

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-memberships/add

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-memberships/add

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-memberships/add

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

Remove Control Plane Group Members

Removes one or more control planes from the members of a control plane group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane group

Request Body schema: application/json

Request body for removing a list of child control planes from a control plane group membership.

required

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-memberships/remove

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-memberships/remove

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-memberships/remove

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-memberships/remove

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-memberships/remove

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

Control Plane Group Member Status

Determines the group membership status of a control plane.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-member-status

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-member-status

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-member-status

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-member-status

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-member-status

Response samples

Content type

application/json

{"is_member": true
}

Get Control Plane Group Status

Returns the status of a control plane group, including existing conflicts.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a control plane group

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/{id}/group-status

Europe Production region

https://eu.api.konghq.com/v2/control-planes/{id}/group-status

Australia Production region

https://au.api.konghq.com/v2/control-planes/{id}/group-status

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/{id}/group-status

India Production region

https://in.api.konghq.com/v2/control-planes/{id}/group-status

Response samples

Content type

application/json

Example

Group Conflict Status Example

{"item": {"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"conflicts": [{"cluster_id": "57fdf779-7935-476f-ab2b-7fa1323b70e6",
"description": "conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1",
"resource": {"id": "df43b088-cace-4119-9e2a-d83e5fbb0c48",
"type": "service"
}
},
{"cluster_id": "38ceea96-fe39-11ed-be56-0242ac120002",
"description": "conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1",
"resource": {"id": "15f3ab7d-7202-498a-95b4-334f783dbcdd",
"type": "service"
}
}
],
"state": "CONFLICT",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
}

Control Plane Resource Quotas

List default resource quotas with organisational override

Returns a paginated collection of default resource quotas for control planes, along with organizationally-defined overrides for those resource quotas.

Authorizations:

personalAccessTokensystemAccountAccessToken

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/default-resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/default-resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/default-resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/default-resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/default-resource-quotas

Response samples

Content type

application/json

{"data": [{"id": "cc504063-f3bb-4e09-8e32-bbcdbc5cd618",
"name": "consumer",
"description": "Default value of the consumer resource",
"resource": "count/control-plane.consumer",
"value": 10000,
"overrides": [{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
},
{"id": "1beb9ad3-f3bb-4e09-8e32-bbcdbc5cd618",
"name": "certificate",
"description": "Default value of the route resource",
"resource": "count/control-plane.route",
"value": 500
}
]
}

List all control plane resource quota overrides

Returns a list of control plane quota override values created by the user.

Authorizations:

personalAccessTokensystemAccountAccessToken

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas

Response samples

Content type

application/json

{"data": [{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
},
{"id": "cbef8c44-0fb1-4cb6-979c-5b82d2334b5f",
"name": "route override",
"description": "Override for resource route",
"resource": "count/control-plane.route",
"value": 1000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create a control plane resource quota

Creates a control plane resource quota scoped to a given resource, for an organization.

Authorizations:

personalAccessTokensystemAccountAccessToken

Request Body schema: application/json

Request body for creating the control plane override resource quota value.

name	string (ControlPlaneResourceQuotaName) The human-readable name of this resource quota.
description	string (ControlPlaneResourceQuotaDescription) A more verbose description of what this resource quota enforces.
resource required	string (ControlPlaneResourceQuotaResourceName) Identifier value of resources available for quota enforcement.
value required	integer (ControlPlaneResourceQuotaValue) >= 1 The aggregate non-negative integer count of this resource that's allowed for the organization.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas

Request samples

Payload

Content type

application/json

{"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 40000
}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get a control plane resource quota value corresponding to the ID

Returns the control plane resource quota for the ID.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update the control plane resource quota for the corresponding ID

Update the control plane resource quota for the corresponding ID.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Request Body schema: application/json

Request body for updating the control plane override resource quota value.

value

required

integer (ControlPlaneResourceQuotaValue) >= 1

The aggregate non-negative integer count of this resource that's allowed for the organization.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Request samples

Payload

Content type

application/json

{"value": 50000
}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete the control plane resource quota

Deletes the created control plane resource quota which matches the ID provided.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Response samples

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}