Claim Domain Ownership | Vercel REST API

APIs & SDKs

Claim Domain Ownership

POSThttps://api.vercel.com/v9/domains/{domain}/claim

Claim ownership of a domain for the authenticated team by verifying a TXT record. The caller must first add a TXT record to _vercel.{domain} (obtained from GET /domains/:domain/verification), then call this endpoint to complete the ownership transfer. If the TXT record is verified, the domain ownership will be transferred to the caller's team, even if the domain is currently owned by another user or team.

https://api.vercel.com/v9/domains/{domain}/claim

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

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

Response

{
  "domain": {
    "boughtAt": "1613602938882",
    "createdAt": "1613602938882",
    "creator": {
      "customerId": "example_id",
      "email": "user@example.com",
      "id": "icfg_1234567890",
      "isDomainReseller": "false",
      "username": "string"
    },
    "customNameservers": [],
    "echMode": "auto",
    "expiresAt": "123",
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "intendedNameservers": [],
    "name": "example.com",
    "nameservers": [],
    "renew": "true",
    "serviceType": "zeit.world",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

domainstringRequired

The domain name to claim ownership of

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

200Domain ownership successfully claimed.

domainobjectRequired

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

410Error

https://api.vercel.com/v9/domains/{domain}/claim

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

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

Response

{
  "domain": {
    "boughtAt": "1613602938882",
    "createdAt": "1613602938882",
    "creator": {
      "customerId": "example_id",
      "email": "user@example.com",
      "id": "icfg_1234567890",
      "isDomainReseller": "false",
      "username": "string"
    },
    "customNameservers": [],
    "echMode": "auto",
    "expiresAt": "123",
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "intendedNameservers": [],
    "name": "example.com",
    "nameservers": [],
    "renew": "true",
    "serviceType": "zeit.world",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

OpenAPI Specification