---
title: "Konnect Runtime Groups"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-internal-2/versions/e185700f-0c72-40ae-9fcc-28365e70ba27"
---

# Konnect Runtime Groups

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect Runtime Groups","version":"2.0.0","description":"The API for Kong Konnect Runtime Groups.","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":{"/runtime-groups":{"post":{"operationId":"create-runtime-group","summary":"Create Runtime Group","description":"Create a runtime group in the Konnect Organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRuntimeGroupRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateRuntimeGroupRequestExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateRuntimeGroupResponse"},"400":{"$ref":"#/components/responses/RuntimeGroupsBadRequest"},"401":{"$ref":"#/components/responses/RuntimeGroupUnauthenticated"},"403":{"$ref":"#/components/responses/RuntimeGroupPermissionDenied"},"409":{"$ref":"#/components/responses/RuntimeGroupConflict"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Runtime Groups"]}}},"components":{"schemas":{"CreateRuntimeGroupRequest":{"description":"The request schema for the create runtime group request.","type":"object","properties":{"name":{"description":"The name of the runtime group.","type":"string","example":"Test Runtime Group"},"description":{"description":"The description of the runtime group in Konnect.","type":"string","example":"A test runtime group for exploration."},"cluster_type":{"description":"The ClusterType value of the cluster associated with the Runtime Group.","type":"string","example":"CLUSTER_TYPE_HYBRID","enum":["CLUSTER_TYPE_HYBRID","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_COMPOSITE","CLUSTER_TYPE_SERVERLESS","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 runtime group can be used for cloud-gateways.","type":"boolean","example":false},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name"],"title":"CreateRuntimeGroupRequest"},"RuntimeGroup":{"allOf":[{"$ref":"#/components/schemas/RuntimeGroupSummary"},{"type":"object","properties":{"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"CP configuration object for related access endpoints.","type":"object","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}}},"created_at":{"description":"An ISO-8604 timestamp representation of runtime group 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 runtime group update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}}}],"x-examples":{"Example 1":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Runtime Group","description":"A test runtime group for exploration.","labels":{"test":"true"},"config":{"control_plane_endpoint":"https://acfe5f253f.cp.konghq.com","telemetry_endpoint":"https://acfe5f253f.tp0.konghq.com","cluster_type":"CLUSTER_TYPE_HYBRID","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"}}},"RuntimeGroupSummary":{"description":"The runtime group object contains information about a Kong control plane.","type":"object","properties":{"id":{"description":"The runtime group ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The name of the runtime group.","type":"string","example":"Test Runtime Group"},"description":{"description":"The description of the runtime group in Konnect.","type":"string","example":"A test runtime group for exploration."},"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 Runtime Group.","type":"string","example":"CLUSTER_TYPE_HYBRID","enum":["CLUSTER_TYPE_HYBRID","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_COMPOSITE","CLUSTER_TYPE_SERVERLESS","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 this Runtime Group can be used for cloud-gateways.","type":"boolean","readOnly":true},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"}},"required":["control_plane_endpoint","telemetry_endpoint","cluster_type","auth_type","cloud_gateway"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"additionalProperties":false,"title":"RuntimeGroupSummary"},"Labels":{"description":"Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.","type":"object","example":{"test":"true"},"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 runtime group.","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 runtime group.","type":"array","items":{"$ref":"#/components/schemas/ProxyURL"},"example":[{"host":"example.com","port":443,"protocol":"https"}],"title":"ProxyURLs"},"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"}}}]}},"examples":{"400RequestFormatInvalidExample":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400CannotBeBlankExample":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"name","reason":"cannot be blank"}]}},"400InvalidIDFormatExample":{"value":{"status":400,"title":"Bad Request","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 runtime group because usage limits have been reached."}},"400UnknownPropertyExample":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"id","rule":"unknownProperty","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 runtime groups."}},"409ConflictExample":{"value":{"status":409,"title":"Conflict","instance":"konnect:trace:2287285207635123011","detail":"Runtime group with provided name already exists."}},"500InternalErrorExample":{"value":{"status":500,"title":"Internal Server Error","instance":"konnect:trace:2287285207635123011","detail":"Could not propagate runtime group 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."}},"CreateRuntimeGroupRequestExample":{"value":{"name":"Test Runtime Group","description":"A test runtime group for exploration.","cluster_type":"CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","cloud_gateway":false,"proxy_urls":[{"host":"example.com","port":443,"protocol":"https"}],"labels":{"test":"true"}}},"RuntimeGroupExample":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Runtime Group","description":"A test runtime group for exploration.","labels":{"test":"true"},"config":{"control_plane_endpoint":"https://acfe5f253f.cp.konghq.com","telemetry_endpoint":"https://acfe5f253f.tp0.konghq.com","cluster_type":"CLUSTER_TYPE_HYBRID","auth_type":"pinned_client_certs","cloud_gateway":false,"proxy_urls":[{"host":"example.com","port":443,"protocol":"https"}]}}}},"responses":{"CreateRuntimeGroupResponse":{"description":"A response to creating a runtime group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntimeGroup"},"examples":{"Create Runtime Group Response":{"$ref":"#/components/examples/RuntimeGroupExample"}}}}},"RuntimeGroupsBadRequest":{"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"}}}}},"RuntimeGroupPermissionDenied":{"description":"Permission denied","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/403PermissionDeniedExample"}}}}},"RuntimeGroupUnauthenticated":{"description":"Unauthenticated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/401UnauthenticatedExample"}}}}},"RuntimeGroupConflict":{"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","example":500,"enum":[500]},"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 runtime group 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","example":503,"enum":[503]},"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"}}}}}},"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":"Runtime Groups"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
