Skip to content
Docs

Remove a domain by name

DELhttps://api.vercel.com/v6/domains/{domain}
Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.domains.deleteDomain({
    domain: "example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "uid": "example_id"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

domainstringRequired
The name of the domain.

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Successful response removing a domain.
uidstringRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error