GetProjectDeployment

August 10, 2026 ยท View on GitHub

Example Usage

import { GetProjectDeployment } from "@vercel/sdk/models/getprojectprojectsbuildmachinetype.js";

let value: GetProjectDeployment = {
  id: "<id>",
  createdAt: 6209.13,
  createdIn: "<value>",
  creator: {
    email: "Friedrich_Satterfield44@gmail.com",
    uid: "<id>",
    username: "Elsie33",
  },
  deploymentHostname: "<value>",
  name: "<value>",
  plan: "hobby",
  previewCommentsEnabled: false,
  private: false,
  readyState: "ERROR",
  type: "LAMBDAS",
  url: "https://flashy-scaffold.name/",
  userId: "<id>",
};

Fields

FieldTypeRequiredDescriptionExample
idstring:heavy_check_mark:N/A
aliasstring[]:heavy_minus_sign:N/A
aliasAssignedmodels.GetProjectProjectsResponseAliasAssigned:heavy_minus_sign:N/A
aliasErrormodels.GetProjectProjectsResponseAliasError:heavy_minus_sign:N/A
aliasFinalstring:heavy_minus_sign:N/A
automaticAliasesstring[]:heavy_minus_sign:N/A
branchMatchermodels.GetProjectProjectsResponse200BranchMatcher:heavy_minus_sign:N/A
buildingAtnumber:heavy_minus_sign:N/A
buildsmodels.GetProjectProjectsResponseBuilds[]:heavy_minus_sign:N/A
checksConclusionmodels.GetProjectProjectsResponseChecksConclusion:heavy_minus_sign:N/A
checksStatemodels.GetProjectProjectsResponseChecksState:heavy_minus_sign:N/A
connectBuildsEnabledboolean:heavy_minus_sign:N/A
connectConfigurationIdstring:heavy_minus_sign:N/A
createdAtnumber:heavy_check_mark:N/A
createdInstring:heavy_check_mark:N/A
creatormodels.GetProjectProjectsResponse200Creator:heavy_check_mark:N/A
deletedAtnumber:heavy_minus_sign:N/A
deploymentHostnamestring:heavy_check_mark:N/A
forcedboolean:heavy_minus_sign:N/A
namestring:heavy_check_mark:N/A
metaRecord<string, string>:heavy_minus_sign:N/A
monorepoManagerstring:heavy_minus_sign:N/A
oidcTokenClaimsmodels.GetProjectProjectsResponseOidcTokenClaims:heavy_minus_sign:N/A
planmodels.GetProjectProjectsResponsePlan:heavy_check_mark:N/A
previewCommentsEnabledboolean:heavy_minus_sign:Whether or not preview comments are enabled for the deploymentfalse
privateboolean:heavy_check_mark:N/A
readyAtnumber:heavy_minus_sign:N/A
readyStatemodels.GetProjectProjectsResponseReadyState:heavy_check_mark:N/A
readySubstatemodels.GetProjectProjectsResponseReadySubstate:heavy_minus_sign:N/A
requestedAtnumber:heavy_minus_sign:N/A
targetstring:heavy_minus_sign:N/A
teamIdstring:heavy_minus_sign:N/A
typemodels.GetProjectProjectsResponse200ApplicationJSONResponseBodyAliasType:heavy_check_mark:N/A
urlstring:heavy_check_mark:N/A
userIdstring:heavy_check_mark:N/A
withCacheboolean:heavy_minus_sign:N/A