Remove Endpoints

Remove one or more endpoints

DELETE /v2/topics/{topicName}/endpoints

curl

curl -XDELETE https://qstash.upstash.io/v2/topics/:topicName/endpoints \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoints": [
      {
        "name": "endpoint1",
      },
      {
        "url": "https://somewhere-else.com"
      }
    ]
  }'

const response = await fetch("https://qstash.upstash.io/v2/topics/:topicName/endpoints", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: {
    endpoints: [
      {
        name: "endpoint1",
      },
      {
        url: "https://somewhere-else.com",
      },
    ],
  },
});

import requests

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
}

data = {
   "endpoints": [
      {
        "name": "endpoint1",
      },
      {
        "url": "https://somewhere-else.com"
      }
    ]
}

response = requests.delete(
  'https://qstash.upstash.io/v2/topics/:topicName/endpoints',
  headers=headers,
  data=data
)

var data = strings.NewReader(`{
  "endpoints": [
    {
      "name": "endpoint1",
    },
    {
      "url": "https://somewhere-else.com"
    }
  ]
}`)
req, err := http.NewRequest("DELETE", "https://qstash.upstash.io/v2/topics/:topicName/endpoints", data)
if err != nil {
  log.Fatal(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
  log.Fatal(err)
}
defer resp.Body.Close()

Remove one or multiple endpoints from a topic. If all endpoints have been removed, the topic will be deleted.

Request

topicName · string · required

The name of your topic. If it doesn’t exist, we return an error.

endpoints · Array · required

The endpoints to be removed from to the topic.

Hide child attributes

Either name or url must be provided

name · string

The name of the endpoint

url · string

The URL of the endpoint

Response

This endpoint simply returns 200 OK if the endpoints have been removed successfully.

curl

curl -XDELETE https://qstash.upstash.io/v2/topics/:topicName/endpoints \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoints": [
      {
        "name": "endpoint1",
      },
      {
        "url": "https://somewhere-else.com"
      }
    ]
  }'

const response = await fetch("https://qstash.upstash.io/v2/topics/:topicName/endpoints", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: {
    endpoints: [
      {
        name: "endpoint1",
      },
      {
        url: "https://somewhere-else.com",
      },
    ],
  },
});

import requests

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
}

data = {
   "endpoints": [
      {
        "name": "endpoint1",
      },
      {
        "url": "https://somewhere-else.com"
      }
    ]
}

response = requests.delete(
  'https://qstash.upstash.io/v2/topics/:topicName/endpoints',
  headers=headers,
  data=data
)

var data = strings.NewReader(`{
  "endpoints": [
    {
      "name": "endpoint1",
    },
    {
      "url": "https://somewhere-else.com"
    }
  ]
}`)
req, err := http.NewRequest("DELETE", "https://qstash.upstash.io/v2/topics/:topicName/endpoints", data)
if err != nil {
  log.Fatal(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
  log.Fatal(err)
}
defer resp.Body.Close()