0

Create a backup

by
Published Oct 17, 2025

### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: **Service Token Accesses** `write_backups` **OAuth Scopes** | Resource | Scopes | | :------- | :---------- | | Organization | `write_backups` | | Database | `write_backups` | | Branch | `write_backups` |

Script planetscale Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Planetscale = {
3
  serviceTokenId: string;
4
  serviceToken: string;
5
};
6
/**
7
 * Create a backup
8
 * 
9
### Authorization
10
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
11

12
**Service Token Accesses**
13
 `write_backups`
14

15
**OAuth Scopes**
16

17
 | Resource | Scopes |
18
| :------- | :---------- |
19
| Organization | `write_backups` |
20
| Database | `write_backups` |
21
| Branch | `write_backups` |
22
 */
23
export async function main(
24
  auth: Planetscale,
25
  organization: string,
26
  database: string,
27
  branch: string,
28
  body: {
29
    name?: string;
30
    retention_unit?: "hour" | "day" | "week" | "month" | "year";
31
    retention_value?: number;
32
  },
33
) {
34
  const url = new URL(
35
    `https://api.planetscale.com/v1/organizations/${organization}/databases/${database}/branches/${branch}/backups`,
36
  );
37

38
  const response = await fetch(url, {
39
    method: "POST",
40
    headers: {
41
      "Content-Type": "application/json",
42
      Authorization: `${auth.serviceTokenId}:${auth.serviceToken}`,
43
    },
44
    body: JSON.stringify(body),
45
  });
46
  if (!response.ok) {
47
    const text = await response.text();
48
    throw new Error(`${response.status} ${text}`);
49
  }
50
  return await response.json();
51
}
52