Agent nodes

GET

/api/v1/nodes

const url = 'http://localhost:8080/api/v1/nodes';
const options = {method: 'GET', headers: {cookie: 'brokerium_session=<brokerium_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/nodes \
  --cookie brokerium_session=<brokerium_session>

Role: viewer.

Authorizations

sessionCookie
bearerToken

Parameters

Query Parameters

clusterId

string

Responses

200

Nodes with connection state.

application/json

object

nodes

Array<object>

object

string

name

string

clusterId

string | null

role

string

Allowed values: "" broker controller

kafkaNodeId

integer | null

hostname

string

agentVersion

string

status

Last status reported by the agent.

object

labels

object | null

providerRef

string

lastSeenAt

string | null format: date-time

createdAt

string format: date-time

connected

boolean

Example

{
  "nodes": [
    {
      "role": ""
    }
  ]
}

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.