cURL
curl --request GET \
--url 'https://localhost/api/v2/nodes/?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
--header 'X-Cockroach-API-Session: REPLACE_KEY_VALUE'{
"next": 123,
"nodes": [
{
"ServerVersion": {
"internal": 123,
"major_val": 123,
"minor_val": 123,
"patch": 123
},
"address": {
"address_field": "<string>",
"network_field": "<string>"
},
"attrs": {
"attrs": [
"<string>"
]
},
"build_tag": "<string>",
"cluster_name": "<string>",
"liveness_status": 123,
"locality": {
"tiers": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"metrics": {},
"node_id": 123,
"num_cpus": 123,
"sql_address": {
"address_field": "<string>",
"network_field": "<string>"
},
"started_at": 123,
"total_system_memory": 123,
"updated_at": 123
}
]
}List nodes
List all nodes on this cluster.
Client must be logged in as a user with admin privileges.
GET
/
nodes
/
cURL
curl --request GET \
--url 'https://localhost/api/v2/nodes/?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
--header 'X-Cockroach-API-Session: REPLACE_KEY_VALUE'{
"next": 123,
"nodes": [
{
"ServerVersion": {
"internal": 123,
"major_val": 123,
"minor_val": 123,
"patch": 123
},
"address": {
"address_field": "<string>",
"network_field": "<string>"
},
"attrs": {
"attrs": [
"<string>"
]
},
"build_tag": "<string>",
"cluster_name": "<string>",
"liveness_status": 123,
"locality": {
"tiers": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"metrics": {},
"node_id": 123,
"num_cpus": 123,
"sql_address": {
"address_field": "<string>",
"network_field": "<string>"
},
"started_at": 123,
"total_system_memory": 123,
"updated_at": 123
}
]
}Authorizations
Token for logged-in REST session. Use /login/ to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.
Query Parameters
Maximum number of results to return in this call.
Continuation offset for results after a past limited run.

