URL Groups - Upstash Documentation

Create a URL Group and add 2 endpoints#

import { Client } from "@upstash/qstash";const client = new Client({ token: "<QSTASH_TOKEN>" });const urlGroups = client.urlGroups;await urlGroups.addEndpoints({  name: "url_group_name",  endpoints: [    { url: "https://my-endpoint-1" },    { url: "https://my-endpoint-2" },  ],});

Get URL Group by name#

import { Client } from "@upstash/qstash";const client = new Client({ token: "<QSTASH_TOKEN>" });const urlGroups = client.urlGroups;const urlGroup = await urlGroups.get("urlGroupName");console.log(urlGroup.name, urlGroup.endpoints);

List URL Groups#

import { Client } from "@upstash/qstash";const client = new Client({ token: "<QSTASH_TOKEN>" });const allUrlGroups = await client.urlGroups.list();for (const urlGroup of allUrlGroups) {  console.log(urlGroup.name, urlGroup.endpoints);}

Remove an endpoint from a URL Group#

import { Client } from "@upstash/qstash";const client = new Client({ token: "<QSTASH_TOKEN>" });const urlGroups = client.urlGroups;await urlGroups.removeEndpoints({  name: "urlGroupName",  endpoints: [{ url: "https://my-endpoint-1" }],});

Delete a URL Group#

import { Client } from "@upstash/qstash";const client = new Client({ token: "<QSTASH_TOKEN>" });const urlGroups = client.urlGroups;await urlGroups.delete("urlGroupName");