0

Update the backup configuration for a cluster

by
Published Oct 17, 2025

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

Script cockroachdb Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Cockroachdb = {
3
  token: string;
4
};
5
/**
6
 * Update the backup configuration for a cluster
7
 * Can be used by the following roles assigned at the organization, folder or cluster scope:
8
- CLUSTER_ADMIN
9
- CLUSTER_OPERATOR_WRITER
10

11
 */
12
export async function main(
13
  auth: Cockroachdb,
14
  cluster_id: string,
15
  body: {
16
    enabled?: false | true;
17
    frequency_minutes?: number;
18
    retention_days?: number;
19
  },
20
) {
21
  const url = new URL(
22
    `https://cockroachlabs.cloud/api/v1/clusters/${cluster_id}/backups-config`,
23
  );
24

25
  const response = await fetch(url, {
26
    method: "PATCH",
27
    headers: {
28
      "Content-Type": "application/json",
29
      Authorization: "Bearer " + auth.token,
30
    },
31
    body: JSON.stringify(body),
32
  });
33
  if (!response.ok) {
34
    const text = await response.text();
35
    throw new Error(`${response.status} ${text}`);
36
  }
37
  return await response.json();
38
}
39