Consumer Groups

Upsert a Consumer Group

Changed on

Create or Update Consumer Group using ID.

put/{workspace}/consumer_groups/{ConsumerGroupId}

Request

  • Base URL: http://localhost:8001
  • URL: http://localhost:8001/{workspace}/consumer_groups/{ConsumerGroupId}
  • Auth: API key in header Kong-Admin-Token

Path parameters

workspacestring required
Example:team-payments

The name of the workspace

Request body

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

namestring required

The name of the consumer group.

tagsstring[] nullable

A set of strings representing tags.

updated_atinteger nullable

Unix epoch when the resource was last updated.

Response

Successfully upserted Consumer Group

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

namestring required

The name of the consumer group.

tagsstring[] nullable

A set of strings representing tags.

updated_atinteger nullable

Unix epoch when the resource was last updated.

Changes