Get Information for a Single Domain

APIs & SDKs

GET/__remote/api.vercel.com/v5/domains/{domain}

Get information for a single domain in an account or team.

Request

import { Edgenivo } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

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",
    "suffix": "false",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

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 retrieving an information for a specific domains.

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

Request

import { Edgenivo } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

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",
    "suffix": "false",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

OpenAPI Specification