0

Update a physical replication stream

by
Published Oct 17, 2025

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

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 a physical replication stream
7
 * Can be used by the following roles assigned at the organization, folder or cluster scope:
8
- CLUSTER_ADMIN
9

10
 */
11
export async function main(
12
  auth: Cockroachdb,
13
  id: string,
14
  body: {
15
    failover_at?: string;
16
    status?:
17
      | "STARTING"
18
      | "REPLICATING"
19
      | "FAILING_OVER"
20
      | "COMPLETED"
21
      | "CANCELED";
22
  },
23
) {
24
  const url = new URL(
25
    `https://cockroachlabs.cloud/api/v1/physical-replication-streams/${id}`,
26
  );
27

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