API - Corsair

Every vercel.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

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

Projects

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  projects: {
    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?: unknown[] | null;
    } | null;
    latestDeployments?: any[] | null;
    targets?: Record<string, any> | null;
  }[];
  pagination: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

getProject

projects.getProject Get project details Risk: read

await corsair.vercel.api.projects.getProject({ idOrName: 'my-project' });

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`	No	—
`link`	`object`	No	—
`latestDeployments`	`array`	No	—
`targets`	`object`	No	—

Response 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?: unknown[] | null;
  } | null;
  latestDeployments?: any[] | null;
  targets?: Record<string, any> | null;
}

Deployments

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  deployments: {
    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: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

getDeployment

deployments.getDeployment Get deployment details Risk: read

await corsair.vercel.api.deployments.getDeployment({ idOrUrl: 'dpl_xxx' });

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`	`string`	Yes	—
`creator`	`object`	No	—
`meta`	`object`	No	—
`target`	`string`	No	—
`aliasError`	`object`	No	—
`aliasAssigned`	`number`	No	—
`inspectorUrl`	`string`	No	—

Response 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;
}

createDeployment

deployments.createDeployment Create a deployment Risk: write

await corsair.vercel.api.deployments.createDeployment({ name: 'my-deploy' });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`project`	`string`	No	—
`target`	`'production' \| 'staging'`	No	—
`gitSource`	`object`	No	—
`files`	`array`	No	—
`meta`	`record`	No	—
`env`	`record`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`uid`	`string`	Yes	—
`name`	`string`	Yes	—
`url`	`string`	Yes	—
`created`	`number`	Yes	—
`readyState`	`string`	Yes	—
`type`	`string`	Yes	—
`creator`	`object`	No	—
`meta`	`object`	No	—
`target`	`string`	No	—
`aliasError`	`object`	No	—
`aliasAssigned`	`number`	No	—
`inspectorUrl`	`string`	No	—

gitSource full type

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

Response 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;
}

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  domains: {
    id: string;
    name: string;
    createdAt: number;
    boughtAt: number | null;
    expiresAt: number | null;
    transferredAt: number | null;
    verified: boolean;
    nameservers: string[];
    intendedNameservers: string[];
  }[];
  pagination: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

getProjectDomains

domains.getProjectDomains Get project domains Risk: read

await corsair.vercel.api.domains.getProjectDomains({ idOrName: 'my-project' });

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  domains: {
    name: string;
    apexName: string;
    projectId: string;
    redirect: string | null;
    redirectStatusCode: number | null;
    gitBranch: string | null;
    updatedAt: number;
    createdAt: number;
    verified: boolean;
  }[];
  pagination: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

Envs

getEnvVariables

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

await corsair.vercel.api.envs.getEnvVariables({ idOrName: 'my-project' });

Input

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

Output

Name	Type	Required	Description
`envs`	`array`	No	—

Response full type

{
  envs?: {
    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;
  }[];
}

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({
    idOrName: 'my-project',
    key: 'API_KEY',
    value: 'secret',
    type: 'encrypted',
    target: ['production']
});

Input

Name	Type	Required	Description
`idOrName`	`string`	Yes	—
`key`	`string`	Yes	—
`value`	`string`	Yes	—
`type`	`'plain' \| 'secret' \| 'encrypted' \| 'sensitive'`	Yes	—
`target`	`array`	Yes	—
`gitBranch`	`string`	No	—
`comment`	`string`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`key`	`string`	Yes	—
`value`	`string`	Yes	—
`type`	`string`	Yes	—
`target`	`array`	Yes	—
`gitBranch`	`string`	No	—
`configurationId`	`string`	No	—
`createdAt`	`number`	Yes	—
`updatedAt`	`number`	Yes	—
`createdBy`	`string`	No	—
`updatedBy`	`string`	No	—

Response 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;
}

Aliases

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  aliases: {
    uid: string;
    alias: string;
    created: string;
    createdAt: number;
    deploymentId: string | null;
    projectId: string | null;
    redirect: string | null;
  }[];
  pagination: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

assignAlias

aliases.assignAlias Assign an alias Risk: write

await corsair.vercel.api.aliases.assignAlias({
    deploymentId: 'dpl_123',
    alias: 'my-alias.vercel.app'
});

Input

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

Output

Name	Type	Required	Description
`uid`	`string`	Yes	—
`alias`	`string`	Yes	—
`created`	`string`	Yes	—
`oldDeploymentId`	`string`	No	—

Response full type

{
  uid: string;
  alias: string;
  created: string;
  oldDeploymentId: string | null;
}

Webhooks

getWebhooks

webhooks.getWebhooks Get all webhooks Risk: read

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

Input

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

Output

Name	Type	Required	Description
`(Array of Webhooks)`	`array`	Yes	—

Response full type

{
  id: string;
  url: string;
  events: string[];
  ownerId: string;
  projectIds?: string[];
  createdAt: number;
  updatedAt: number;
}[]

createWebhook

webhooks.createWebhook Create a webhook Risk: write

await corsair.vercel.api.webhooks.createWebhook({
    url: 'https://example.com/api/webhook',
    events: ['deployment.created']
});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`events`	`string[]`	Yes	—
`projectIds`	`string[]`	No	—
`teamId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`url`	`string`	Yes	—
`events`	`array`	Yes	—
`ownerId`	`string`	Yes	—
`projectIds`	`array`	No	—
`createdAt`	`number`	Yes	—
`updatedAt`	`number`	Yes	—

Response full type

{
  id: string;
  url: string;
  events: string[];
  ownerId: string;
  projectIds?: string[];
  createdAt: number;
  updatedAt: number;
}

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`	`array`	Yes	—
`pagination`	`object`	Yes	—

Response full type

{
  teams: {
    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: {
    count: number;
    next: number | null;
    prev: number | null;
  };
}

​Projects

​getProjects

​getProject

​Deployments

​getDeployments

​getDeployment

​createDeployment

​Domains

​getDomains

​getProjectDomains

​Envs

​getEnvVariables

​createEnvVariable

​Aliases

​getAliases

​assignAlias

​Webhooks

​getWebhooks

​createWebhook

​Teams

​getTeams

Projects

getProjects

getProject

Deployments

getDeployments

getDeployment

createDeployment

Domains

getDomains

getProjectDomains

Envs

getEnvVariables

createEnvVariable

Aliases

getAliases

assignAlias

Webhooks

getWebhooks

createWebhook

Teams

getTeams