Upsert a Workspace
Create or Update Workspace using ID or name.
Path Parameters
ID of a control plane
ID or name of the workspace to retreive
Example:2747d1e5-8246-4f65-a939-b392f1ee17f8
Body
application/json
Body
Description of the Workspace
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
Response
application/json
Response
Successfully upserted Workspace
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
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
Authentication
Path Parameters
Body
GroupSettings
objectWhether 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
CreateControlPlaneRequest
objectThe 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.
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"}
ControlPlane
objectThe 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
Labels
objectLabels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.