Remove a domain by name | Vercel REST API

APIs & SDKs

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.

https://api.vercel.com/v6/domains/{domain}

const response = await fetch('https://api.vercel.com/v6/domains/domain?teamId=string&slug=string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

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

https://api.vercel.com/v6/domains/{domain}

const response = await fetch('https://api.vercel.com/v6/domains/domain?teamId=string&slug=string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "uid": "example_id"
}

OpenAPI Specification