0

Get extended information about a cluster

by
Published Oct 17, 2025

Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - FOLDER_ADMIN - FOLDER_MOVER

Script cockroachdb Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Cockroachdb = {
3
  token: string;
4
};
5
/**
6
 * Get extended information about a cluster
7
 * Can be used by the following roles assigned at the organization, folder or cluster scope:
8
- ORG_ADMIN
9
- CLUSTER_ADMIN
10
- CLUSTER_OPERATOR_WRITER
11
- CLUSTER_DEVELOPER
12
- FOLDER_ADMIN
13
- FOLDER_MOVER
14

15
 */
16
export async function main(auth: Cockroachdb, cluster_id: string) {
17
  const url = new URL(
18
    `https://cockroachlabs.cloud/api/v1/clusters/${cluster_id}`,
19
  );
20

21
  const response = await fetch(url, {
22
    method: "GET",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.json();
33
}
34