CustomEnvironments

August 5, 2026 ยท View on GitHub

Internal representation of a custom environment with all required properties

Example Usage

import { CustomEnvironments } from "@vercel/sdk/models/createprojectregion.js";

let value: CustomEnvironments = {
  id: "<id>",
  slug: "<value>",
  type: "preview",
  createdAt: 520.72,
  updatedAt: 5983.83,
};

Fields

FieldTypeRequiredDescription
idstring:heavy_check_mark:Unique identifier for the custom environment (format: env_*)
slugstring:heavy_check_mark:URL-friendly name of the environment
typemodels.CreateProjectProjectsResponse200Type:heavy_check_mark:The type of environment (production, preview, or development)
descriptionstring:heavy_minus_sign:Optional description of the environment's purpose
branchMatchermodels.CreateProjectBranchMatcher:heavy_minus_sign:Configuration for matching git branches to this environment
domainsmodels.CreateProjectDomains[]:heavy_minus_sign:List of domains associated with this environment
currentDeploymentAliasesstring[]:heavy_minus_sign:List of aliases for the current deployment
createdAtnumber:heavy_check_mark:Timestamp when the environment was created
updatedAtnumber:heavy_check_mark:Timestamp when the environment was last updated