Skip to main content
GET
/
v4
/
domains
/
status
checkDomainStatus
import { Vercel } from "@vercel/sdk";

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

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

  console.log(result);
}

run();
{
  "available": true
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
name
string
required

The name of the domain for which we would like to check the status.

Example:

"example.com"

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

Successful response checking if a Domain's name is available.

​
available
boolean
required