0

Add an egress rule

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
 * Add an egress rule
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
    description: string;
17
    destination: string;
18
    idempotency_key?: string;
19
    name: string;
20
    paths?: string[];
21
    ports?: number[];
22
    type: string;
23
  },
24
) {
25
  const url = new URL(
26
    `https://cockroachlabs.cloud/api/v1/clusters/${cluster_id}/networking/egress-rules`,
27
  );
28

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