GetProjectResponseBody

The project information

Example Usage

import { GetProjectResponseBody } from "@vercel/sdk/models/getprojectresponsebody.js";

let value: GetProjectResponseBody = {
  integrations: [
    {
      installationId: "icfg_3bwCLgxL8qt5kjRLcv2Dit7F",
    },
  ],
  accountId: "<id>",
  alias: [
    {
      deployment: {
        id: "<id>",
        createdAt: 6441.78,
        createdIn: "<value>",
        creator: {
          email: "Friedrich_Satterfield44@gmail.com",
          uid: "<id>",
          username: "Elsie33",
        },
        deploymentHostname: "<value>",
        name: "<value>",
        plan: "hobby",
        previewCommentsEnabled: false,
        private: false,
        readyState: "CANCELED",
        type: "LAMBDAS",
        url: "https://well-lit-grandson.info",
        userId: "<id>",
      },
      domain: "vague-diver.name",
      environment: "preview",
      target: "PRODUCTION",
    },
  ],
  crons: {
    enabledAt: 8434.21,
    disabledAt: null,
    updatedAt: 1228.16,
    deploymentId: "<id>",
    definitions: [
      {
        host: "vercel.com",
        path: "/api/crons/sync-something?hello=world",
        schedule: "0 0 * * *",
      },
    ],
  },
  deploymentExpiration: {},
  directoryListing: false,
  id: "<id>",
  latestDeployments: [
    {
      id: "<id>",
      createdAt: 3241.57,
      createdIn: "<value>",
      creator: {
        email: "Howard.Veum32@hotmail.com",
        uid: "<id>",
        username: "Laverne35",
      },
      deploymentHostname: "<value>",
      name: "<value>",
      plan: "pro",
      previewCommentsEnabled: false,
      private: true,
      readyState: "CANCELED",
      type: "LAMBDAS",
      url: "https://clueless-wallaby.info/",
      userId: "<id>",
    },
  ],
  name: "<value>",
  nodeVersion: "12.x",
  resourceConfig: {
    functionDefaultRegions: [],
  },
  rollingRelease: {
    target: "production",
    stages: [
      {
        targetPercentage: 25,
        requireApproval: false,
        duration: 600,
        linearShift: false,
      },
    ],
    canaryResponseHeader: false,
  },
  defaultResourceConfig: {
    functionDefaultRegions: [
      "<value 1>",
    ],
  },
  targets: {
    "key": {
      id: "<id>",
      createdAt: 6236.32,
      createdIn: "<value>",
      creator: {
        email: "Damien_Klocko@yahoo.com",
        uid: "<id>",
        username: "Thurman.Smith36",
      },
      deploymentHostname: "<value>",
      name: "<value>",
      plan: "enterprise",
      previewCommentsEnabled: false,
      private: true,
      readyState: "BLOCKED",
      type: "LAMBDAS",
      url: "https://frilly-replacement.biz",
      userId: "<id>",
    },
  },
};

Fields

Field	Type	Required	Description
integrations	models.GetProjectIntegrations[]	:heavy_minus_sign:	N/A
accountId	string	:heavy_check_mark:	N/A
creator	models.GetProjectCreator	:heavy_minus_sign:	N/A
alias	models.GetProjectAlias[]	:heavy_check_mark:	N/A
analytics	models.GetProjectAnalytics	:heavy_minus_sign:	N/A
appliedCve55182Migration	boolean	:heavy_minus_sign:	N/A
speedInsights	models.GetProjectSpeedInsights	:heavy_minus_sign:	N/A
autoExposeSystemEnvs	boolean	:heavy_minus_sign:	N/A
autoAssignCustomDomains	boolean	:heavy_minus_sign:	N/A
autoAssignCustomDomainsUpdatedBy	string	:heavy_minus_sign:	N/A
buildCommand	string	:heavy_minus_sign:	N/A
commandForIgnoringBuildStep	string	:heavy_minus_sign:	N/A
connectConfigurations	models.GetProjectConnectConfigurations[]	:heavy_minus_sign:	N/A
connectConfigurationId	string	:heavy_minus_sign:	N/A
connectBuildsEnabled	boolean	:heavy_minus_sign:	N/A
passiveConnectConfigurationId	string	:heavy_minus_sign:	N/A
createdAt	number	:heavy_minus_sign:	N/A
customerSupportCodeVisibility	boolean	:heavy_minus_sign:	N/A
crons	models.GetProjectCrons	:heavy_minus_sign:	N/A
dataCache	models.GetProjectDataCache	:heavy_minus_sign:	N/A
deploymentExpiration	models.GetProjectDeploymentExpiration	:heavy_check_mark:	Retention policies for deployments. These are enforced at the project level, but we also maintain an instance of this at the team level as a default policy that gets applied to new projects.
expiration	models.GetProjectExpiration	:heavy_minus_sign:	N/A
devCommand	string	:heavy_minus_sign:	N/A
directoryListing	boolean	:heavy_check_mark:	N/A
installCommand	string	:heavy_minus_sign:	N/A
env	models.GetProjectEnv[]	:heavy_minus_sign:	N/A
customEnvironments	models.GetProjectCustomEnvironments[]	:heavy_minus_sign:	N/A
framework	models.GetProjectFramework	:heavy_minus_sign:	N/A
services	models.GetProjectServices[]	:heavy_minus_sign:	N/A
gitForkProtection	boolean	:heavy_minus_sign:	N/A
gitLFS	boolean	:heavy_minus_sign:	N/A
id	string	:heavy_check_mark:	N/A
ipBuckets	models.GetProjectIpBuckets[]	:heavy_minus_sign:	N/A
jobs	models.GetProjectJobs	:heavy_minus_sign:	N/A
latestDeployments	models.GetProjectLatestDeployments[]	:heavy_minus_sign:	N/A
link	models.GetProjectLink	:heavy_minus_sign:	N/A
blobs	models.GetProjectBlobs	:heavy_minus_sign:	N/A
microfrontends	models.GetProjectMicrofrontends	:heavy_minus_sign:	N/A
name	string	:heavy_check_mark:	N/A
nodeVersion	models.GetProjectNodeVersion	:heavy_check_mark:	N/A
optionsAllowlist	models.GetProjectOptionsAllowlist	:heavy_minus_sign:	N/A
outputDirectory	string	:heavy_minus_sign:	N/A
passwordProtection	models.GetProjectPasswordProtection	:heavy_minus_sign:	N/A
passport	models.GetProjectPassport	:heavy_minus_sign:	N/A
protectionConfig	models.GetProjectProtectionConfig	:heavy_minus_sign:	N/A
sandbox	models.GetProjectSandbox	:heavy_minus_sign:	N/A
productionDeploymentsFastLane	boolean	:heavy_minus_sign:	N/A
resourceConfig	models.GetProjectResourceConfig	:heavy_check_mark:	N/A
rollbackDescription	models.GetProjectRollbackDescription	:heavy_minus_sign:	Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback.
rollingRelease	models.GetProjectRollingRelease	:heavy_minus_sign:	Project-level rolling release configuration that defines how deployments should be gradually rolled out
defaultResourceConfig	models.GetProjectDefaultResourceConfig	:heavy_check_mark:	N/A
rootDirectory	string	:heavy_minus_sign:	N/A
serverlessFunctionZeroConfigFailover	boolean	:heavy_minus_sign:	N/A
skewProtectionBoundaryAt	number	:heavy_minus_sign:	N/A
skewProtectionMaxAge	number	:heavy_minus_sign:	N/A
skewProtectionAllowedDomains	string[]	:heavy_minus_sign:	N/A
skipGitConnectDuringLink	boolean	:heavy_minus_sign:	N/A
staticIps	models.GetProjectStaticIps	:heavy_minus_sign:	N/A
sourceFilesOutsideRootDirectory	boolean	:heavy_minus_sign:	N/A
enableAffectedProjectsDeployments	boolean	:heavy_minus_sign:	N/A
enableExternalRewriteCaching	boolean	:heavy_minus_sign:	N/A
ssoProtection	models.GetProjectSsoProtection	:heavy_minus_sign:	N/A
targets	Record<string, models.GetProjectTargets>	:heavy_minus_sign:	N/A
transferCompletedAt	number	:heavy_minus_sign:	N/A
transferStartedAt	number	:heavy_minus_sign:	N/A
transferToAccountId	string	:heavy_minus_sign:	N/A
transferredFromAccountId	string	:heavy_minus_sign:	N/A
updatedAt	number	:heavy_minus_sign:	N/A
live	boolean	:heavy_minus_sign:	N/A
enablePreviewFeedback	boolean	:heavy_minus_sign:	N/A
enableProductionFeedback	boolean	:heavy_minus_sign:	N/A
permissions	models.GetProjectPermissions	:heavy_minus_sign:	N/A
lastRollbackTarget	models.GetProjectLastRollbackTarget	:heavy_minus_sign:	N/A
lastAliasRequest	models.GetProjectLastAliasRequest	:heavy_minus_sign:	N/A
protectionBypass	Record<string, models.GetProjectProtectionBypass>	:heavy_minus_sign:	N/A
hasActiveBranches	boolean	:heavy_minus_sign:	N/A
trustedIps	models.GetProjectTrustedIps	:heavy_minus_sign:	N/A
trustedSources	models.GetProjectTrustedSources	:heavy_minus_sign:	N/A
gitComments	models.GetProjectGitComments	:heavy_minus_sign:	N/A
gitProviderOptions	models.GetProjectGitProviderOptions	:heavy_minus_sign:	N/A
paused	boolean	:heavy_minus_sign:	N/A
concurrencyBucketName	string	:heavy_minus_sign:	N/A
webAnalytics	models.GetProjectWebAnalytics	:heavy_minus_sign:	N/A
security	models.GetProjectSecurity	:heavy_minus_sign:	N/A
oidcTokenConfig	models.GetProjectOidcTokenConfig	:heavy_minus_sign:	N/A
deploymentPolicy	models.GetProjectDeploymentPolicy	:heavy_minus_sign:	Project shape. null on a rule list clears the project's override for that rule type (fall back to team for every env); omitting is equivalent. Setting deploymentPolicy itself to null clears every override at once. Kept structurally distinct from {@link TeamDeploymentPolicy} so the two storage locations don't share a type by accident.
tier	string	:heavy_minus_sign:	N/A
usageStatus	models.GetProjectUsageStatus	:heavy_minus_sign:	N/A
features	models.GetProjectFeatures	:heavy_minus_sign:	N/A
v0	boolean	:heavy_minus_sign:	N/A
v0Created	boolean	:heavy_minus_sign:	N/A
abuse	models.GetProjectAbuse	:heavy_minus_sign:	N/A
internalRoutes	models.GetProjectInternalRoutes[]	:heavy_minus_sign:	N/A
hasDeployments	boolean	:heavy_minus_sign:	N/A
dismissedToasts	models.GetProjectDismissedToasts[]	:heavy_minus_sign:	N/A
protectedSourcemaps	boolean	:heavy_minus_sign:	N/A
tracing	models.GetProjectTracing	:heavy_minus_sign:	N/A
avatar	string	:heavy_minus_sign:	N/A