Control Plane Groups

Get Control Plane Group Status

Changed on

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

get/v2/control-planes/{controlPlaneId}/group-status

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/group-status
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

Status of a control plane group, including existing conflicts.

Example response

{
  "item": {
    "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z",
    "conflicts": [
      {
        "cluster_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
        "description": "conflicting entity found: ID=38d790ad-8b08-4ff5-a074-2e1e9e64d8bd, Name=foo",
        "resource": {
          "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
          "type": "service"
        }
      }
    ],
    "state": "CONFLICT"
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 500.00 enum value to the response property for the response status