---
title: "Konnect Control Planes"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-dev-2/versions/a10d5ab7-97dd-4ab4-a28d-5dd567e1649c"
---

# Konnect Control Planes

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect Control Planes","version":"2.0.0","description":"The API for Kong Konnect Control Planes.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","description":"Singapore Production region"}],"paths":{"/control-planes":{"post":{"operationId":"create-control-plane","summary":"Create Control Plane","description":"Create a control plane in the Konnect Organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateControlPlaneRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateControlPlaneRequestExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateControlPlaneResponse"},"400":{"$ref":"#/components/responses/ControlPlanesBadRequest"},"401":{"$ref":"#/components/responses/ControlPlaneUnauthenticated"},"403":{"$ref":"#/components/responses/ControlPlanePermissionDenied"},"409":{"$ref":"#/components/responses/ControlPlaneConflict"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Control Planes"]}},"/control-planes/{id}/group-settings":{"parameters":[{"name":"id","in":"path","description":"ID of a control plane group","required":true,"schema":{"type":"string"}}],"get":{"operationId":"get-control-plane-group-settings","summary":"Get Control Plane Group Settings","description":"Returns the settings of a control plane group.","responses":{"200":{"$ref":"#/components/responses/GroupSettings"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Control Plane Groups"]},"put":{"operationId":"put-control-plane-group-settings","summary":"Upsert Control Plane Group Settings","description":"Updates the settings of a control plane group. If the settings do not exist, they will be created.","requestBody":{"$ref":"#/components/requestBodies/GroupSettingsUpsert"},"responses":{"200":{"$ref":"#/components/responses/GroupSettings"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Control Plane Groups"]}},"/control-planes/features/{featureName}":{"parameters":[{"$ref":"#/components/parameters/FeatureName"}],"get":{"operationId":"get-organization-feature","summary":"Get Feature Configuration","description":"Returns the feature configuration of an organization.\n","responses":{"200":{"$ref":"#/components/responses/OrganizationFeatureResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Organization Feature"]},"put":{"operationId":"upsert-organization-feature","summary":"Upsert Feature Configuration","requestBody":{"$ref":"#/components/requestBodies/UpsertOrganizationFeatureRequest"},"responses":{"200":{"$ref":"#/components/responses/OrganizationFeatureResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Organization Feature"]}},"/control-planes/{controlPlaneId}/ai-manager/virtual-keys":{"parameters":[{"name":"controlPlaneId","in":"path","description":"ID of a control plane","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-virtual-keys","summary":"Get Control Plane Virtual Keys","description":"Returns the Virtual Keys defined on a control plane.","parameters":[{"name":"filter[acl_group][eq]","in":"query","description":"The ACL group name to filter","required":false,"schema":{"type":"string"}},{"name":"filter[consumer][contains]","in":"query","description":"The consumer name to filter","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/AIManagerVirtualKeysResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["AI Manager"]}},"/control-planes/{controlPlaneId}/core-entities/workspaces":{"parameters":[{"name":"controlPlaneId","in":"path","description":"ID of a control plane","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-workspaces","summary":"List all Workspaces","description":"List all Workspaces","parameters":[{"$ref":"#/components/parameters/PaginationSize"},{"$ref":"#/components/parameters/PaginationOffset"},{"$ref":"#/components/parameters/FilterByNameContains"},{"$ref":"#/components/parameters/FilterByNameEquality"}],"responses":{"200":{"$ref":"#/components/responses/ListWorkspacesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Workspaces"]},"post":{"operationId":"create-workspace","summary":"Create a Workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateWorkspaceRequestExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateWorkspaceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"}},"tags":["Workspaces"]}},"/control-planes/{controlPlaneId}/core-entities/workspaces/{workspaceIdOrName}":{"parameters":[{"name":"controlPlaneId","in":"path","description":"ID of a control plane","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workspaceIdOrName","in":"path","description":"ID or name of the workspace to retreive","required":true,"schema":{"type":"string","example":"2747d1e5-8246-4f65-a939-b392f1ee17f8"}}],"get":{"operationId":"get-workspace","summary":"Get a Workspace","description":"Get a Workspace using ID or name.","responses":{"200":{"$ref":"#/components/responses/RetrieveWorkspaceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Workspaces"]},"delete":{"operationId":"delete-workspace","summary":"Delete a Workspace","description":"Delete an individual workspace.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Workspaces"]},"put":{"operationId":"upsert-workspace","summary":"Upsert a Workspace","description":"Create or Update Workspace using ID or name.","requestBody":{"description":"Description of the Workspace","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"responses":{"200":{"description":"Successfully upserted Workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"501":{"$ref":"#/components/responses/NotImplemented"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Workspaces"]}}},"components":{"parameters":{"FeatureName":{"name":"featureName","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FeatureName"},"description":"The feature name for the configuration."},"FilterByNameContains":{"name":"filter[name][contains]","description":"Filter by contains comparison of the name property with a supplied substring.","in":"query","required":false,"schema":{"type":"string","example":"test"}},"FilterByNameEquality":{"name":"filter[name][eq]","description":"Filter by direct equality comparison of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"test"}},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"PaginationOffset":{"allowEmptyValue":true,"description":"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","in":"query","name":"offset","schema":{"type":"string"}},"PaginationSize":{"description":"Number of resources to be returned.","in":"query","name":"size","schema":{"type":"integer","default":100,"maximum":1000,"minimum":1}}},"schemas":{"GroupSettings":{"type":"object","properties":{"workspaceable":{"description":"Whether the control plane group can be used to create workspaces.","type":"boolean","example":true},"default_workspace_member_id":{"description":"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.","type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},"additionalProperties":false},"CreateControlPlaneRequest":{"description":"The request schema for the create control plane request.","type":"object","properties":{"name":{"description":"The name of the control plane.","type":"string","example":"Test Control Plane"},"description":{"description":"The description of the control plane in Konnect.","type":"string","example":"A test control plane for exploration.","nullable":false},"cluster_type":{"description":"The ClusterType value of the cluster associated with the Control Plane.","type":"string","example":"CLUSTER_TYPE_CONTROL_PLANE","enum":["CLUSTER_TYPE_CONTROL_PLANE","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_CONTROL_PLANE_GROUP","CLUSTER_TYPE_SERVERLESS","CLUSTER_TYPE_HTTP_GATEWAY","CLUSTER_TYPE_EVENT_GATEWAY","CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY","CLUSTER_TYPE_CLOUD_API_GATEWAY","CLUSTER_TYPE_SERVERLESS_V1"]},"auth_type":{"description":"The auth type value of the cluster associated with the Runtime Group.","type":"string","example":"pinned_client_certs","enum":["pinned_client_certs","pki_client_certs"]},"cloud_gateway":{"description":"Whether this control-plane can be used for cloud-gateways.","type":"boolean","example":false,"nullable":false},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name"],"title":"CreateControlPlaneRequest"},"ControlPlane":{"description":"The control plane object contains information about a Kong control plane.","type":"object","properties":{"id":{"description":"The control plane ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The name of the control plane.","type":"string","example":"Test Control Plane"},"description":{"description":"The description of the control plane in Konnect.","type":"string","example":"A test control plane for exploration.","nullable":false},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"CP configuration object for related access endpoints.","type":"object","additionalProperties":false,"properties":{"control_plane_endpoint":{"description":"Control Plane Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.cp.konghq.com","readOnly":true},"telemetry_endpoint":{"description":"Telemetry Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.tp0.konghq.com","readOnly":true},"cluster_type":{"description":"The ClusterType value of the cluster associated with the Control Plane.","type":"string","example":"CLUSTER_TYPE_CONTROL_PLANE","enum":["CLUSTER_TYPE_CONTROL_PLANE","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_CONTROL_PLANE_GROUP","CLUSTER_TYPE_SERVERLESS","CLUSTER_TYPE_HTTP_GATEWAY","CLUSTER_TYPE_EVENT_GATEWAY","CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY","CLUSTER_TYPE_CLOUD_API_GATEWAY","CLUSTER_TYPE_SERVERLESS_V1"],"readOnly":true},"auth_type":{"description":"The auth type value of the cluster associated with the Runtime Group.","type":"string","example":"pinned_client_certs","enum":["pinned_client_certs","pki_client_certs"],"readOnly":true},"cloud_gateway":{"description":"Whether the Control Plane can be used for cloud-gateways.","type":"boolean","nullable":false,"readOnly":true},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"}},"required":["control_plane_endpoint","telemetry_endpoint","cluster_type","auth_type","cloud_gateway"]},"created_at":{"description":"An ISO-8604 timestamp representation of control plane creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of control plane update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"additionalProperties":false,"required":["id","name","config","created_at","updated_at"],"x-examples":{"Example 1":{"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.cp.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"}}},"Labels":{"description":"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 '_'.","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z\\-\\.\\_]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"title":"Labels"},"ProxyURL":{"description":"Proxy URL associated with reaching the data-planes connected to a control-plane.","type":"object","properties":{"host":{"description":"Hostname of the proxy URL.","type":"string"},"port":{"description":"Port of the proxy URL.","type":"integer"},"protocol":{"description":"Protocol of the proxy URL.","type":"string"}},"example":{"host":"example.com","port":443,"protocol":"https"},"additionalProperties":false,"required":["host","port","protocol"],"title":"ProxyURL"},"ProxyURLs":{"description":"Array of proxy URLs associated with reaching the data-planes connected to a control-plane.","type":"array","items":{"$ref":"#/components/schemas/ProxyURL"},"format":"set","example":[{"host":"example.com","port":443,"protocol":"https"}],"title":"ProxyURLs"},"FeatureName":{"type":"string","enum":["enterprise-ai-plugins"],"readOnly":true},"OrganizationFeature":{"type":"object","properties":{"id":{"description":"The unique identifier for the feature configuration.","type":"string","format":"uuid","readOnly":true},"name":{"$ref":"#/components/schemas/FeatureName"},"enabled":{"description":"Whether this feature is enabled for the organization.","type":"boolean"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["name","enabled"],"title":"Feature configuration for an organization"},"AIManagerVirtualKey":{"type":"object","properties":{"consumer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id"]},"key":{"description":"The actual key value","type":"string"},"tags":{"type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["consumer","key"]},"Workspace":{"description":"Workspaces provide a way to segment Kong entities.","type":"object","properties":{"id":{"description":"The unique UUID for this resource.","type":"string"},"name":{"type":"string"},"comment":{"type":"string"},"description":{"type":"string"},"managed_by":{"type":"object","additionalProperties":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["name"],"x-examples":{"Example 1":{"name":"team-payments","comment":"string","description":"string","managed_by":{"team":"platform"},"created_at":0,"id":"string"}}},"CreateWorkspaceRequest":{"description":"The request schema for the create a workspace request.","type":"object","properties":{"name":{"description":"The name of the workspace.","type":"string","example":"team-1"},"comment":{"description":"The description of the workspace.","type":"string","example":"A test workspace for team 1"},"description":{"description":"The description of the workspace.","type":"string","example":"A test workspace for team 1"},"managed_by":{"type":"object","additionalProperties":true}},"additionalProperties":false,"required":["name"],"title":"CreateWorkspaceRequest"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"NotImplementedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":501},"title":{"example":"Not Implemented"},"type":{"example":"https://httpstatuses.com/501"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not Implemented"}}}]},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"PaginationNextResponse":{"description":"URI to the next page (may be null)","type":"string"},"PaginationOffsetResponse":{"description":"Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page","type":"string"}},"examples":{"400RequestFormatInvalidExample":{"value":{"status":400,"title":"Bad Request","detail":"Invalid request format","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400CannotBeBlankExample":{"value":{"status":400,"title":"Bad Request","detail":"Request cannot be empty","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"name","reason":"cannot be blank"}]}},"400InvalidIDFormatExample":{"value":{"status":400,"title":"Bad Request","detail":"Request contains invalid ID format","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"id","reason":"invalid ID format"}]}},"400UsageLimitsReachedExample":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:8988732526256293040","detail":"Cannot create an additional control plane because usage limits have been reached.","invalid_parameters":[{"field":"object","reason":"usage limits reached"}]}},"400UnknownPropertyExample":{"value":{"status":400,"title":"Bad Request","detail":"Request contains unknown property","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"id","reason":"property id should not exist"}]}},"401UnauthenticatedExample":{"value":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"403PermissionDeniedExample":{"value":{"status":403,"title":"Permission denied","instance":"konnect:trace:2822394689570210664","detail":"Insufficient role-set to create control planes."}},"409ConflictExample":{"value":{"status":409,"title":"Conflict","instance":"konnect:trace:2287285207635123011","detail":"Control Plane with provided name already exists."}},"500InternalErrorExample":{"value":{"status":500,"title":"Internal Server Error","instance":"konnect:trace:2287285207635123011","detail":"Could not propagate control plane changes to control plane cluster service."}},"503PermissionReadFailureExample":{"value":{"status":503,"title":"Service Unavailable","instance":"konnect:trace:2287285207635123011","detail":"Could not retrieve permissions to check resource accessibility."}},"CreateControlPlaneRequestExample":{"value":{"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"}}},"ControlPlaneExample":{"value":{"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.cp.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"}},"WorkspaceExample":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"team-1","comment":"A test workspace for team 1","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"CreateWorkspaceRequestExample":{"value":{"name":"Test Workspace","comment":"A test workspace for team 1"}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"GroupSettingsUpsert":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSettings"},"examples":{"Example 1":{"value":{"workspaceable":true,"default_workspace_member_id":"1beb9ad3-d21b-4090-b6e3-574784d1166d"}}}}}},"UpsertOrganizationFeatureRequest":{"content":{"application/json":{"schema":{"description":"The request schema for the upsert organization feature request.","type":"object","properties":{"enabled":{"description":"Whether this feature is enabled for the organization.","type":"boolean","example":true}},"additionalProperties":false,"title":"UpsertOrganizationFeatureRequest"}}}}},"responses":{"GroupSettings":{"description":"A response to retrieving the settings of a control plane group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSettings"}}}},"CreateControlPlaneResponse":{"description":"A response to creating a control plane.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlane"},"examples":{"Create Control Plane Response":{"$ref":"#/components/examples/ControlPlaneExample"}}}}},"ControlPlanesBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format Invalid":{"$ref":"#/components/examples/400RequestFormatInvalidExample"},"Cannot Be Blank":{"$ref":"#/components/examples/400CannotBeBlankExample"},"Invalid ID Format":{"$ref":"#/components/examples/400InvalidIDFormatExample"},"Usage Limits Reached":{"$ref":"#/components/examples/400UsageLimitsReachedExample"},"Unknown Property":{"$ref":"#/components/examples/400UnknownPropertyExample"}}}}},"ControlPlanePermissionDenied":{"description":"Permission denied","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/403PermissionDeniedExample"}}}}},"ControlPlaneUnauthenticated":{"description":"Unauthenticated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/401UnauthenticatedExample"}}}}},"ControlPlaneConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Conflict":{"$ref":"#/components/examples/409ConflictExample"}}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/problem+json":{"schema":{"description":"The error response object.","type":"object","properties":{"status":{"description":"The HTTP status code.","type":"integer","format":"int32","example":500,"enum":[500],"x-go-type":"int32"},"title":{"description":"The error response code.","type":"string","example":"Internal Server Error"},"instance":{"description":"The Konnect traceback code","type":"string","example":"konnect:trace:2287285207635123011"},"detail":{"description":"Details about the error.","type":"string","example":"Could not propagate control plane changes to control plane cluster service."}},"required":["status","title","instance"],"title":"InternalServerError"},"examples":{"Internal Server Error":{"$ref":"#/components/examples/500InternalErrorExample"}}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/problem+json":{"schema":{"description":"Error response for temporary service unavailability.","type":"object","properties":{"status":{"description":"The HTTP status code.","type":"integer","format":"int32","example":503,"enum":[503],"x-go-type":"int32"},"title":{"description":"The error response code.","type":"string","example":"Service Unavailable"},"instance":{"description":"The Konnect traceback code","type":"string","example":"konnect:trace:2287285207635123011"},"detail":{"description":"Details about the error.","type":"string","example":"Could not retrieve permissions to check resource accessibility."}},"required":["status","title","instance"],"title":"ServiceUnavailableError"},"examples":{"Service Unavailable":{"$ref":"#/components/examples/503PermissionReadFailureExample"}}}}},"OrganizationFeatureResponse":{"description":"A response for getting or updating a feature configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationFeature"}}}},"AIManagerVirtualKeysResponse":{"description":"AI Manager Virtual Keys","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIManagerVirtualKey"}},"page":{"type":"object","properties":{"total":{"type":"integer"},"next":{"type":"string"}}}},"required":["data"]}}}},"ListWorkspacesResponse":{"description":"A paginated list response for a collection of workspaces.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"}},"next":{"$ref":"#/components/schemas/PaginationNextResponse"},"offset":{"$ref":"#/components/schemas/PaginationOffsetResponse"}},"additionalProperties":false,"required":["data"],"title":"ListWorkspacesResponse"}}}},"CreateWorkspaceResponse":{"description":"A response to creating a workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"},"examples":{"Create Workspace Response":{"$ref":"#/components/examples/WorkspaceExample"}}}}},"RetrieveWorkspaceResponse":{"description":"A response to retrieving a single workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"},"examples":{"Single workspace response":{"$ref":"#/components/examples/WorkspaceExample"}}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"NotImplemented":{"description":"Not Implemented","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Control Planes"},{"name":"Control Plane Groups"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
