0

Create a deploy request

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** `read_deploy_request`, `create_deploy_requests` **OAuth Scopes** | Resource | Scopes | | :------- | :---------- | | Organization | `write_deploy_requests` | | Database | `write_deploy_requests` |

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 deploy request
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
 `read_deploy_request`, `create_deploy_requests`
14

15
**OAuth Scopes**
16

17
 | Resource | Scopes |
18
| :------- | :---------- |
19
| Organization | `write_deploy_requests` |
20
| Database | `write_deploy_requests` |
21
 */
22
export async function main(
23
  auth: Planetscale,
24
  organization: string,
25
  database: string,
26
  body: {
27
    branch: string;
28
    into_branch: string;
29
    notes?: string;
30
    auto_cutover?: false | true;
31
    auto_delete_branch?: false | true;
32
  },
33
) {
34
  const url = new URL(
35
    `https://api.planetscale.com/v1/organizations/${organization}/databases/${database}/deploy-requests`,
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