Kafka Consumer Groups

post

Delete the offset for a consumer group topic-partition tuples

Path parameters

groupIdstringRequired

The consumer group id

Body

application/json

topicsstring[] · min: 1Required

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets/delete

HTTPcURLJavaScriptPython

POST /api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "topics": [
    "text"
  ]
}

No content

delete

Delete the offset for a topic-partition for the given group

Path parameters

groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitionintegerRequired

The topic partition number

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

/api/v1/environments/{name}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{name}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets HTTP/1.1
Host: 
Accept: */*

No content

delete

Returns the consumer groups which are using the given topic

Path parameters

consumerGroupNamestringRequired

The consumer group name

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

/api/v1/environments/{name}/proxy/api/consumers/{consumerGroupName}

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{name}/proxy/api/consumers/{consumerGroupName} HTTP/1.1
Host: 
Accept: */*

No content

put

Update the offset for a consumer group topic-partition tuples

Path parameters

groupIdstringRequired

The consumer group id

Body

application/json

or

or

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "topics": [
    "text"
  ]
}

No content

put

Updates the offset for a topic-partition for the given group

Path parameters

groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitioninteger · int64Required

The topic partition number

Body

application/json

or

objectOptional

or

objectOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition}

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{name}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "offset": 1
}

No content

Deprecated

get

Returns the consumer groups which are using the given topic

Path parameters

topicstringRequired

The topic name

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{name}/proxy/api/consumers/{topic}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/consumers/{topic} HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "coordinator": {
      "id": 1,
      "host": "text",
      "port": 1,
      "rack": "text"
    },
    "active": true,
    "state": "Unknown",
    "consumers": [
      {
        "topic": "text",
        "partition": 1,
        "currentOffset": 1,
        "startOffset": 1,
        "logEndOffset": 1,
        "lag": 1,
        "consumerId": "text",
        "host": "text",
        "clientId": "text"
      }
    ],
    "application": {
      "id": "text",
      "name": "text",
      "type": "AkkaStreams"
    }
  }
]

Deprecated

get

Returns the list of Kafka consumer groups

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{name}/proxy/api/consumers

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/consumers HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "coordinator": {
      "id": 1,
      "host": "text",
      "port": 1,
      "rack": "text"
    },
    "active": true,
    "state": "Unknown",
    "consumers": [
      "text"
    ],
    "consumersCount": 1,
    "topicPartitionsCount": 1,
    "minLag": 1,
    "maxLag": 1,
    "application": {
      "id": "text",
      "name": "text",
      "type": "AkkaStreams"
    }
  }
]