---
title: "RuntimeGroup"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-dev-2/versions/862e9175-5aa3-444d-bb10-aba17a552b0f/schemas/RuntimeGroup"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-dev-2/versions/862e9175-5aa3-444d-bb10-aba17a552b0f.md

# RuntimeGroup

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Runtime Groups
  version: 2.0.0
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
components:
  schemas:
    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_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 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
    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
    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
    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
```
