Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 18.6 KB

getprojectdomainresponsebody.md

File metadata and controls

30 lines (25 loc) · 18.6 KB

GetProjectDomainResponseBody

Example Usage

import { GetProjectDomainResponseBody } from "@simplesagar/vercel/models/getprojectdomainop.js";

let value: GetProjectDomainResponseBody = {
  name: "<value>",
  apexName: "<value>",
  projectId: "<value>",
  verified: false,
};

Fields

Field Type Required Description
name string ✔️ N/A
apexName string ✔️ N/A
projectId string ✔️ N/A
redirect string ➖ N/A
redirectStatusCode number ➖ N/A
gitBranch string ➖ N/A
customEnvironmentId string ➖ N/A
updatedAt number ➖ N/A
createdAt number ➖ N/A
verified boolean ✔️ 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.
verification models.Verification[] ➖ 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.