0

Delete collection of keys

by
Published Oct 17, 2025

Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.

Script phrase Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Phrase = {
3
	token: string
4
	baseUrl: string
5
}
6
/**
7
 * Delete collection of keys
8
 * Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
9
 */
10
export async function main(
11
	auth: Phrase,
12
	project_id: string,
13
	branch: string | undefined,
14
	q: string | undefined,
15
	locale_id: string | undefined
16
) {
17
	const url = new URL(`${auth.baseUrl}/projects/${project_id}/keys`)
18
	for (const [k, v] of [
19
		['branch', branch],
20
		['q', q],
21
		['locale_id', locale_id]
22
	]) {
23
		if (v !== undefined && v !== '' && k !== undefined) {
24
			url.searchParams.append(k, v)
25
		}
26
	}
27
	const response = await fetch(url, {
28
		method: 'DELETE',
29
		headers: {
30
			Authorization: 'ApiToken ' + auth.token
31
		},
32
		body: undefined
33
	})
34
	if (!response.ok) {
35
		const text = await response.text()
36
		throw new Error(`${response.status} ${text}`)
37
	}
38
	return await response.json()
39
}
40