Skip to content
Docs

Get a project domain

GEThttps://api.vercel.com/v9/projects/{idOrName}/domains/{domain}
Get project domain by project id/name and domain name.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.projects.getProjectDomain({
    idOrName: "<value>",
    domain: "www.example.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "apexName": "Example Name",
  "createdAt": "123",
  "customEnvironmentId": "example_id",
  "gitBranch": "string",
  "name": "Example Name",
  "projectId": "example_id",
  "redirect": "string",
  "redirectStatusCode": "301",
  "updatedAt": "123",
  "verification": [
    {
      "domain": "string",
      "reason": "Customer requested refund",
      "type": "string",
      "value": "string"
    }
  ],
  "verified": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired
The unique project identifier or the project name
domainstringRequired
The project domain name

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

200Success
apexNamestringRequired
createdAtnumberOptional
customEnvironmentIdstringOptional
gitBranchstringOptional
namestringRequired
projectIdstringRequired
redirectstringOptional
redirectStatusCodenumberOptional
updatedAtnumberOptional
verificationarrayOptional
A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete POST /projects/:idOrName/domains/:domain/verify to verify the domain. Possible challenges: - If verification.type = TXT the verification.domain will be checked for a TXT record matching verification.value.
verifiedbooleanRequired
true if the domain is verified for use with the project. If false it will not be used as an alias on this project until the challenge in verification is completed.

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