Vercel API reference

New to Corsair? See API access, authentication, and error handling.

Aliases

assignAlias

aliases.assignAlias Assign an alias Risk: write

await corsair.vercel.api.aliases.assignAlias({});

Input

Name	Type	Required	Description
`deploymentId`	`string`	Yes	—
`alias`	`string`	Yes	—
`redirect`	`string \| null`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`uid`	`string`	Yes	—
`alias`	`string`	Yes	—
`created`	`string`	Yes	—
`oldDeploymentId`	`string \| null`	Yes	—

getAliases

aliases.getAliases Get all aliases Risk: read

await corsair.vercel.api.aliases.getAliases({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`until`	`number`	No	—
`since`	`number`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`aliases`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

aliases full type

{
  uid: string,
  alias: string,
  created: string,
  createdAt: number,
  deploymentId: string | null,
  projectId: string | null,
  redirect: string | null
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

Deployments

createDeployment

deployments.createDeployment Create a deployment Risk: write

await corsair.vercel.api.deployments.createDeployment({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`project`	`string`	No	—
`target`	`production \| staging`	No	—
`gitSource`	`object`	No	—
`files`	`any[]`	No	—
`meta`	`Record<string, string>`	No	—
`env`	`Record<string, string>`	No	—
`teamId`	`string`	No	—

gitSource full type

{
  type: github | gitlab | bitbucket,
  ref?: string,
  repoId?: string | number,
  sha?: string
}

Output

Name	Type	Required	Description
`uid`	`string`	Yes	—
`name`	`string`	Yes	—
`url`	`string`	Yes	—
`created`	`number`	Yes	—
`readyState`	`string`	Yes	—
`type`	`LAMBDAS \| PREBUILT \| STATIC \| string`	Yes	—
`creator`	`object \| null`	No	—
`meta`	`Record<string, string> \| null`	No	—
`target`	`production \| staging \| string \| null`	Yes	—
`aliasError`	`object \| null`	No	—
`aliasAssigned`	`number \| null`	No	—
`inspectorUrl`	`string \| null`	No	—

creator full type

{
  uid: string,
  email: string,
  username: string
} | null

aliasError full type

{
  code: string,
  message: string
} | null

getDeployment

deployments.getDeployment Get deployment details Risk: read

await corsair.vercel.api.deployments.getDeployment({});

Input

Name	Type	Required	Description
`idOrUrl`	`string`	Yes	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`uid`	`string`	Yes	—
`name`	`string`	Yes	—
`url`	`string`	Yes	—
`created`	`number`	Yes	—
`readyState`	`string`	Yes	—
`type`	`LAMBDAS \| PREBUILT \| STATIC \| string`	Yes	—
`creator`	`object \| null`	No	—
`meta`	`Record<string, string> \| null`	No	—
`target`	`production \| staging \| string \| null`	Yes	—
`aliasError`	`object \| null`	No	—
`aliasAssigned`	`number \| null`	No	—
`inspectorUrl`	`string \| null`	No	—

creator full type

{
  uid: string,
  email: string,
  username: string
} | null

aliasError full type

{
  code: string,
  message: string
} | null

getDeployments

deployments.getDeployments Get all deployments Risk: read

await corsair.vercel.api.deployments.getDeployments({});

Input

Name	Type	Required	Description
`projectId`	`string`	No	—
`limit`	`number`	No	—
`until`	`number`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`deployments`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

deployments full type

{
  uid: string,
  name: string,
  url: string,
  created: number,
  readyState: string,
  type: LAMBDAS | PREBUILT | STATIC | string,
  creator?: {
    uid: string,
    email: string,
    username: string
  } | null,
  meta?: Record<string, string> | null,
  target: production | staging | string | null,
  aliasError?: {
    code: string,
    message: string
  } | null,
  aliasAssigned?: number | null,
  inspectorUrl?: string | null
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

Domains

getDomains

domains.getDomains Get all domains Risk: read

await corsair.vercel.api.domains.getDomains({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`until`	`number`	No	—
`since`	`number`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

domains full type

{
  id: string,
  name: string,
  createdAt: number,
  boughtAt: number | null,
  expiresAt: number | null,
  transferredAt: number | null,
  verified: boolean,
  nameservers: string[],
  intendedNameservers: string[]
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

getProjectDomains

domains.getProjectDomains Get project domains Risk: read

await corsair.vercel.api.domains.getProjectDomains({});

Input

Name	Type	Required	Description
`idOrName`	`string`	Yes	—
`limit`	`number`	No	—
`until`	`number`	No	—
`since`	`number`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`domains`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

domains full type

{
  name: string,
  apexName: string,
  projectId: string,
  redirect: string | null,
  redirectStatusCode: number | null,
  gitBranch: string | null,
  updatedAt: number,
  createdAt: number,
  verified: boolean
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

Envs

createEnvVariable

envs.createEnvVariable Create an environment variable for a project (supports plain, secret, encrypted, and sensitive types) Risk: write

await corsair.vercel.api.envs.createEnvVariable({});

Input

Name	Type	Required	Description
`idOrName`	`string`	Yes	—
`key`	`string`	Yes	—
`value`	`string`	Yes	—
`type`	`plain \| secret \| encrypted \| sensitive`	Yes	—
`target`	`(production \| preview \| development)[]`	Yes	—
`gitBranch`	`string \| null`	No	—
`comment`	`string`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	Yes	—
`value`	`string`	Yes	—
`type`	`plain \| secret \| encrypted \| sensitive`	Yes	—
`target`	`(production \| preview \| development)[]`	Yes	—
`gitBranch`	`string \| null`	Yes	—
`configurationId`	`string \| null`	No	—
`createdAt`	`number`	Yes	—
`updatedAt`	`number`	Yes	—
`createdBy`	`string \| null`	No	—
`updatedBy`	`string \| null`	No	—

getEnvVariables

envs.getEnvVariables Get environment variables for a project (may include secret/sensitive values) Risk: read

await corsair.vercel.api.envs.getEnvVariables({});

Input

Name	Type	Required	Description
`idOrName`	`string`	Yes	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`envs`	`object[]`	No	—

envs full type

{
  id: string,
  key: string,
  value: string,
  type: plain | secret | encrypted | sensitive,
  target: (production | preview | development)[],
  gitBranch: string | null,
  configurationId?: string | null,
  createdAt: number,
  updatedAt: number,
  createdBy?: string | null,
  updatedBy?: string | null
}[]

Projects

getProject

projects.getProject Get project details Risk: read

await corsair.vercel.api.projects.getProject({});

Input

Name	Type	Required	Description
`idOrName`	`string`	Yes	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`accountId`	`string`	Yes	—
`createdAt`	`number`	Yes	—
`updatedAt`	`number`	Yes	—
`framework`	`string \| null`	Yes	—
`link`	`object \| null`	No	—
`latestDeployments`	`any[] \| null`	No	—
`targets`	`Record<string, any> \| null`	No	—

link full type

{
  type: string,
  repo: string,
  repoId?: number,
  org?: string | null,
  gitCredentialId?: string | null,
  productionBranch?: string | null,
  createdAt?: number | null,
  updatedAt?: number | null,
  deployHooks?: any[] | null
} | null

getProjects

projects.getProjects Get all projects Risk: read

await corsair.vercel.api.projects.getProjects({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`until`	`number`	No	—
`since`	`number`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

projects full type

{
  id: string,
  name: string,
  accountId: string,
  createdAt: number,
  updatedAt: number,
  framework: string | null,
  link?: {
    type: string,
    repo: string,
    repoId?: number,
    org?: string | null,
    gitCredentialId?: string | null,
    productionBranch?: string | null,
    createdAt?: number | null,
    updatedAt?: number | null,
    deployHooks?: any[] | null
  } | null,
  latestDeployments?: any[] | null,
  targets?: Record<string, any> | null
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

Teams

getTeams

teams.getTeams Get all teams Risk: read

await corsair.vercel.api.teams.getTeams({});

Input

Name	Type	Required	Description
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`teams`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

teams full type

{
  id: string,
  slug: string,
  name: string,
  createdAt: number,
  updatedAt?: number | null,
  avatar: string | null,
  membership: {
    uid: string,
    role: OWNER | MEMBER | DEVELOPER | BILLING | VIEWER | string,
    createdAt: number
  }
}[]

pagination full type

{
  count: number,
  next: number | null,
  prev: number | null
}

Webhooks

createWebhook

webhooks.createWebhook Create a webhook Risk: write

await corsair.vercel.api.webhooks.createWebhook({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`events`	`(deployment.created \| deployment.succeeded \| deployment.ready \| deployment.error \| deployment.canceled \| deployment.promoted \| project.created \| project.removed \| domain.created \| integration-configuration.scope-change-confirmed \| integration-configuration.removed \| integration-configuration.permission-upgraded \| string)[]`	Yes	—
`projectIds`	`string[]`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`url`	`string`	Yes	—
`events`	`(deployment.created \| deployment.succeeded \| deployment.ready \| deployment.error \| deployment.canceled \| deployment.promoted \| project.created \| project.removed \| domain.created \| integration-configuration.scope-change-confirmed \| integration-configuration.removed \| integration-configuration.permission-upgraded \| string)[]`	Yes	—
`ownerId`	`string`	Yes	—
`projectIds`	`string[]`	No	—
`createdAt`	`number`	Yes	—
`updatedAt`	`number`	Yes	—

getWebhooks

webhooks.getWebhooks Get all webhooks Risk: read

await corsair.vercel.api.webhooks.getWebhooks({});

Input

Name	Type	Required	Description
`teamId`	`string`	No	—

Output: object[]

Output full type

{
  id: string,
  url: string,
  events: (deployment.created | deployment.succeeded | deployment.ready | deployment.error | deployment.canceled | deployment.promoted | project.created | project.removed | domain.created | integration-configuration.scope-change-confirmed | integration-configuration.removed | integration-configuration.permission-upgraded | string)[],
  ownerId: string,
  projectIds?: string[],
  createdAt: number,
  updatedAt: number
}[]

Overview

Plugins

Vercel API reference

Aliases

assignAlias

getAliases

Deployments

createDeployment

getDeployment

getDeployments

Domains

getDomains

getProjectDomains

Envs

createEnvVariable

getEnvVariables

Projects

getProject

getProjects

Teams

getTeams

Webhooks

createWebhook

getWebhooks