---
title: "Get Control Plane Group Status"
url: "https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed/operations/get-control-planes-id-group-status"
---

> Full API specification: https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed.md

# Get Control Plane Group Status

`GET` `/control-planes/{id}/group-status`

Operation ID: `get-control-planes-id-group-status`

Returns the status of a control plane group, including existing conflicts.

## Path parameters

- `id` (string, required) - ID of a control plane group

## Responses

- `200` - Status of a control plane group, including existing conflicts.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `503` - Service Unavailable

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes
  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
paths:
  /control-planes/{id}/group-status:
    parameters:
      - name: id
        in: path
        description: ID of a control plane group
        required: true
        schema:
          type: string
    get:
      operationId: get-control-planes-id-group-status
      summary: Get Control Plane Group Status
      description: Returns the status of a control plane group, including existing
        conflicts.
      responses:
        "200":
          $ref: "#/components/responses/GetGroupStatus"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      tags:
        - Control Plane Groups
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    GetGroupStatus:
      description: Status of a control plane group, including existing conflicts.
      content:
        application/json:
          schema:
            type: object
            properties:
              item:
                $ref: "#/components/schemas/GroupStatus"
          examples:
            Group Conflict Status Example:
              $ref: "#/components/examples/GroupConflictStatusExample"
            Group No Conflict Status Example:
              $ref: "#/components/examples/GroupNoConflictStatusExample"
    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"
    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"
  schemas:
    GroupStatus:
      description: The Group Status object contains information about the status of a
        control plane group.
      type: object
      properties:
        id:
          description: The control plane group ID.
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          readOnly: true
        created_at:
          description: An ISO-8604 timestamp representation of control plane group status
            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 group status
            update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        conflicts:
          type: array
          items:
            $ref: "#/components/schemas/GroupConflict"
          maxItems: 256
        state:
          description: The state of the control plane group.
          type: string
          example: CONFLICT
          enum:
            - OK
            - CONFLICT
            - UNKNOWN
          readOnly: true
      required:
        - id
        - created_at
        - updated_at
        - state
      title: GroupStatus
    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
    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
    GroupConflict:
      description: The Group Conflict object contains information about a conflict in
        a control plane group.
      type: object
      properties:
        cluster_id:
          description: The ID of a control plane member of a control plane group.
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          readOnly: true
        description:
          description: The description of the conflict.
          type: string
          example: "conflicting entity found: ID=38d790ad-8b08-4ff5-a074-2e1e9e64d8bd,
            Name=foo"
          readOnly: true
        resource:
          $ref: "#/components/schemas/GroupConflictResource"
      required:
        - cluster_id
        - description
        - resource
      title: GroupConflict
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          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
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    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
    GroupConflictResource:
      description: A resource causing a conflict in a control plane group.
      type: object
      properties:
        id:
          description: The ID of the resource.
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          readOnly: true
        type:
          description: The type of the resource.
          type: string
          example: service
          readOnly: true
      required:
        - id
        - type
      title: GroupConflictResource
    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
    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
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
      nullable: true
      readOnly: true
  examples:
    GroupConflictStatusExample:
      value:
        item:
          id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          conflicts:
            - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6
              description: "conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48,
                Name=svc1"
              resource:
                id: df43b088-cace-4119-9e2a-d83e5fbb0c48
                type: service
            - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002
              description: "conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd,
                Name=svc1"
              resource:
                id: 15f3ab7d-7202-498a-95b4-334f783dbcdd
                type: service
          state: CONFLICT
          created_at: 2022-11-04T20:10:06.927Z
          updated_at: 2022-11-04T20:10:06.927Z
    GroupNoConflictStatusExample:
      value:
        item:
          id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          conflicts:
            - cluster_id: 57fdf779-7935-476f-ab2b-7fa1323b70e6
              description: "conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48,
                Name=svc1"
              resource:
                id: df43b088-cace-4119-9e2a-d83e5fbb0c48
                type: service
            - cluster_id: 38ceea96-fe39-11ed-be56-0242ac120002
              description: "conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd,
                Name=svc1"
              resource:
                id: 15f3ab7d-7202-498a-95b4-334f783dbcdd
                type: service
          state: CONFLICT
          created_at: 2022-11-04T20:10:06.927Z
          updated_at: 2022-11-04T20:10:06.927Z
    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
    503PermissionReadFailureExample:
      value:
        status: 503
        title: Service Unavailable
        instance: konnect:trace:2287285207635123011
        detail: Could not retrieve permissions to check resource accessibility.
  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.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/tokens/) in the Konnect
        dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    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.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```