Skip to content

Latest commit

 

History

History
64 lines (59 loc) · 17.6 KB

getdomaindomain.md

File metadata and controls

64 lines (59 loc) · 17.6 KB

GetDomainDomain

Example Usage

import { GetDomainDomain } from "@vercel/sdk/models/getdomainop.js";

let value: GetDomainDomain = {
  suffix: false,
  verified: true,
  nameservers: [
    "ns1.nameserver.net",
    "ns2.nameserver.net",
  ],
  intendedNameservers: [
    "ns1.vercel-dns.com",
    "ns2.vercel-dns.com",
  ],
  customNameservers: [
    "ns1.nameserver.net",
    "ns2.nameserver.net",
  ],
  creator: {
    username: "vercel_user",
    email: "[email protected]",
    id: "ZspSRT4ljIEEmMHgoDwKWDei",
  },
  teamId: "<id>",
  boughtAt: 1613602938882,
  createdAt: 1613602938882,
  expiresAt: 1613602938882,
  id: "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
  name: "example.com",
  orderedAt: 1613602938882,
  renew: true,
  serviceType: "zeit.world",
  transferredAt: 1613602938882,
  transferStartedAt: 1613602938882,
  userId: "<id>",
};

Fields

Field Type Required Description Example
suffix boolean ✔️ N/A
verified boolean ✔️ If the domain has the ownership verified. true
nameservers string[] ✔️ A list of the current nameservers of the domain. [
"ns1.nameserver.net",
"ns2.nameserver.net"
]
intendedNameservers string[] ✔️ A list of the intended nameservers for the domain to point to Vercel DNS. [
"ns1.vercel-dns.com",
"ns2.vercel-dns.com"
]
customNameservers string[] ➖ A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. [
"ns1.nameserver.net",
"ns2.nameserver.net"
]
creator models.GetDomainCreator ✔️ An object containing information of the domain creator, including the user's id, username, and email. {
"id": "ZspSRT4ljIEEmMHgoDwKWDei",
"username": "vercel_user",
"email": "[email protected]"
}
teamId string ✔️ N/A
boughtAt number ✔️ If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. 1613602938882
createdAt number ✔️ Timestamp in milliseconds when the domain was created in the registry. 1613602938882
expiresAt number ✔️ Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel. 1613602938882
id string ✔️ The unique identifier of the domain. EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1
name string ✔️ The domain name. example.com
orderedAt number ➖ Timestamp in milliseconds at which the domain was ordered. 1613602938882
renew boolean ➖ Indicates whether the domain is set to automatically renew. true
serviceType models.ServiceType ✔️ The type of service the domain is handled by. external if the DNS is externally handled, zeit.world if handled with Vercel, or na if the service is not available. zeit.world
transferredAt number ➖ Timestamp in milliseconds at which the domain was successfully transferred into Vercel. null if the transfer is still processing or was never transferred in. 1613602938882
transferStartedAt number ➖ If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. 1613602938882
userId string ✔️ N/A