Get availability for a domain | Edgenivo REST API

APIs & SDKs

Get availability for a domain

GET/__remote/api.vercel.com/v1/registrar/domains/{domain}/availability

Get availability for a specific domain. If the domain is available, it can be purchased using the Buy a domain endpoint or the Buy multiple domains endpoint.

/__remote/api.vercel.com/v1/registrar/domains/{domain}/availability

const response = await fetch('/__remote/api.vercel.com/v1/registrar/domains/domain/availability?teamId=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "available": "true"
}

Errors

{
  "issues": [
    {
      "path": [],
      "message": "string"
    }
  ],
  "message": "string"
}

Path parameters

domainanyRequired

Query parameters

teamIdstringOptional

Response

200Success

availablebooleanRequired

Errors

400There was something wrong with the request

issuesarrayRequired

messagestringRequired

401Unauthorized

statusnumberRequired

codestringRequired

messagestringRequired

reasonstringOptional

403NotAuthorizedForScope

statusnumberRequired

codestringRequired

messagestringRequired

404NotFound

statusnumberRequired

codestringRequired

messagestringRequired

429TooManyRequests

statusnumberRequired

codestringRequired

messagestringRequired

retryAfterobjectRequired

limitobjectRequired

500InternalServerError

statusnumberRequired

codestringRequired

messagestringRequired

/__remote/api.vercel.com/v1/registrar/domains/{domain}/availability

const response = await fetch('/__remote/api.vercel.com/v1/registrar/domains/domain/availability?teamId=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "available": "true"
}

Errors

{
  "issues": [
    {
      "path": [],
      "message": "string"
    }
  ],
  "message": "string"
}

OpenAPI Specification