Create Control Plane
Create a control plane in the Konnect Organization.
Body
application/json
Body
CreateControlPlaneRequest
The request schema for the create control plane request.
The name of the control plane.
Example:Test Control Plane
The description of the control plane in Konnect.
Example:A test control plane for exploration.
The ClusterType value of the cluster associated with the Control Plane.
Allowed values:CLUSTER_TYPE_CONTROL_PLANECLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_CONTROL_PLANE_GROUPCLUSTER_TYPE_SERVERLESSCLUSTER_TYPE_HTTP_GATEWAYCLUSTER_TYPE_EVENT_GATEWAYCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_CLOUD_API_GATEWAYCLUSTER_TYPE_SERVERLESS_V1
Example:CLUSTER_TYPE_CONTROL_PLANE
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
Whether this control-plane can be used for cloud-gateways.
Example:false
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
Show Child Parameters
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 ‘_’.
Example:{"env":"test"}
Response
application/json
Response
A response to creating a control plane.
ControlPlane
The control plane object contains information about a Kong control plane.
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the control plane.
Example:Test Control Plane
The description of the control plane in Konnect.
Example:A test control plane for exploration.
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 ‘_’.
Example:{"env":"test"}
CP configuration object for related access endpoints.
Show Child Parameters
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
Control Plane Groups
Get Control Plane Group Settings
Returns the settings of a control plane group.
Path Parameters
ID of a control plane group
Response
application/json
Response
A response to retrieving the settings of a control plane group.
GroupSettings
Whether the control plane group can be used to create workspaces.
Example:true
The default workspace member ID for the control plane group. This is used to determine the default workspace member for workspaces created in this control plane group.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Authentication
Path Parameters
Upsert Control Plane Group Settings
Updates the settings of a control plane group. If the settings do not exist, they will be created.
Path Parameters
ID of a control plane group
Body
application/json
Body
GroupSettings
Whether the control plane group can be used to create workspaces.
Example:true
The default workspace member ID for the control plane group. This is used to determine the default workspace member for workspaces created in this control plane group.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A response to retrieving the settings of a control plane group.
GroupSettings
Whether the control plane group can be used to create workspaces.
Example:true
The default workspace member ID for the control plane group. This is used to determine the default workspace member for workspaces created in this control plane group.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Authentication
Path Parameters
Body
Get Feature Configuration
Returns the feature configuration of an organization.
Path Parameters
The feature name for the configuration.
Allowed values:enterprise-ai-plugins
Response
application/json
Response
A response for getting or updating a feature configuration for an organization.
Feature configuration for an organization
The unique identifier for the feature configuration.
Allowed values:enterprise-ai-plugins
Whether this feature is enabled for the organization.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z