{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kong Enterprise Admin ACLs Consumer Groups API",
    "version": "3.14.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Kong-Admin-Token",
      "value": "{{Kong-Admin-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Consumer Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups",
            "params": [
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Consumer Group"
        },
        {
          "info": {
            "name": "Get a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ]
          },
          "docs": "Get a Consumer Group using ID."
        },
        {
          "info": {
            "name": "Upsert a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or Update Consumer Group using ID."
        },
        {
          "info": {
            "name": "Delete a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ]
          },
          "docs": "Delete a Consumer Group"
        },
        {
          "info": {
            "name": "Add consumer to consumer group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups/:ConsumerGroupId/consumers",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a consumer to a consumer group"
        },
        {
          "info": {
            "name": "Remove consumer from consumer group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/:workspace/consumer_groups/:ConsumerGroupId/consumers/:ConsumerIdOrUsername",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "ConsumerIdOrUsername",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace",
                "value": "",
                "type": "path",
                "description": "The name of the workspace"
              }
            ]
          },
          "docs": "Remove a consumer from a consumer group"
        },
        {
          "info": {
            "name": "List all Consumer Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups",
            "params": [
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of resources to be returned."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "tags",
                "value": "tag1,tag2",
                "type": "query",
                "description": "A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR."
              }
            ]
          },
          "docs": "List all Consumer Groups"
        },
        {
          "info": {
            "name": "Create a new Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups",
            "params": [
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Consumer Group"
        },
        {
          "info": {
            "name": "Get a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              },
              {
                "name": "list_consumers",
                "value": "false",
                "type": "query",
                "description": "Expand the consumer group to include a list of its consumers."
              }
            ]
          },
          "docs": "Get a Consumer Group using ID."
        },
        {
          "info": {
            "name": "Upsert a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or Update Consumer Group using ID."
        },
        {
          "info": {
            "name": "Delete a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "ID of the Consumer Group to lookup"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ]
          },
          "docs": "Delete a Consumer Group"
        },
        {
          "info": {
            "name": "List all Consumers in a Consumer Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId/consumers",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of resources to be returned."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "tags",
                "value": "tag1,tag2",
                "type": "query",
                "description": "A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR."
              }
            ]
          },
          "docs": "List all consumers in a consumer group"
        },
        {
          "info": {
            "name": "Add consumer to consumer group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId/consumers",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a consumer to a consumer group"
        },
        {
          "info": {
            "name": "Remove consumers from consumer group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId/consumers",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ]
          },
          "docs": "**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nRemoves all consumers from a Consumer Groups. This operation does not delete the consumer group."
        },
        {
          "info": {
            "name": "Remove consumer from consumer group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v2/control-planes/:controlPlaneId/core-entities/consumer_groups/:ConsumerGroupId/consumers/:ConsumerId",
            "params": [
              {
                "name": "ConsumerGroupId",
                "value": "",
                "type": "path",
                "description": "The UUID or name of the consumer group"
              },
              {
                "name": "ConsumerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "controlPlaneId",
                "value": "",
                "type": "path",
                "description": "The UUID of your control plane. This variable is available in the Konnect manager."
              }
            ]
          },
          "docs": "Remove a consumer from a consumer group"
        }
      ]
    }
  ],
  "bundled": true
}