projects

projects Endpoints

PUT/projects/transfer-request/{code}
POST/v10/projects/{idOrName}/domains
POST/v11/projects
POST/v10/projects/{idOrName}/env
POST/projects/{idOrName}/transfer-request
DELETE/v9/projects/{idOrName}
PATCH/v9/projects/{idOrName}/env/{id}
GET/v9/projects/{idOrName}
GET/v9/projects/{idOrName}/domains/{domain}
GET/v1/projects/{projectId}/promote/aliases
POST/v1/projects/{projectId}/pause
POST/v10/projects/{projectId}/promote/{deploymentId}
DELETE/v9/projects/{idOrName}/domains/{domain}
DELETE/v9/projects/{idOrName}/env/{id}
GET/v10/projects
GET/v9/projects/{idOrName}/domains
GET/v1/projects/{idOrName}/env/{id}
GET/v10/projects/{idOrName}/env
POST/v1/projects/{projectId}/unpause
PATCH/v9/projects/{idOrName}/domains/{domain}
PATCH/v9/projects/{idOrName}
PATCH/v1/projects/{idOrName}/protection-bypass
PATCH/v1/data-cache/projects/{projectId}
POST/v9/projects/{idOrName}/domains/{domain}/verify

Accept project transfer request

Accept a project transfer request initated by another team.
The code is generated using the POST /projects/:idOrName/transfer-request endpoint.

Path Parameters

code
string
required

The code of the project transfer request.

Query Parameters

teamId
string

The Team identifier to perform the request on behalf of.
slug
string

The Team slug to perform the request on behalf of.

Body

application/json

newProjectName

string

max:

100

The desired name for the project

Examplea-project-name

paidFeatures

object

Responses

400

One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401
403

You do not have permission to access this resource.
404

PUT/projects/transfer-request/{code}

Selected HTTP client: JavaScript Fetch

fetch('https://api.vercel.com/projects/transfer-request/{code}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    newProjectName: 'a-project-name',
    paidFeatures: {
      concurrentBuilds: null,
      passwordProtection: null,
      previewDeploymentSuffix: null
    }
  })
})

Show Schema

{}

The project has been transferred successfully.

Add a domain to a project

Add a domain to the project by passing its domain name and by specifying the project by either passing the project id or name in the URL. If the domain is not yet verified to be used on this project, the request will return verified = false, and the domain will need to be verified according to the verification challenge via POST /projects/:idOrName/domains/:domain/verify. If the domain already exists on the project, the request will fail with a 400 status code.

Path Parameters

idOrName
string
required

The unique project identifier or the project name

Query Parameters

teamId
string

The Team identifier to perform the request on behalf of.
slug
string

The Team slug to perform the request on behalf of.

Body

application/json

name

string

required

The project domain name

Examplewww.example.com

gitBranch

string | null

max:

250

Git branch to link the project domain

Example

customEnvironmentId

string

The unique custom environment identifier within the project

redirect

string | null

Target destination domain for redirect

Examplefoobar.com

redirectStatusCode

integer | null enum

Status code for domain redirect

Example307

Responses

400

One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The domain is not valid You can't set both a git branch and a redirect for the domain The domain can not be added because the latest production deployment for the project was not successful The domain redirect is not valid A domain cannot redirect to itself You can not set the production branch as a branch for your domain
401
402

The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated
403

You do not have permission to access this resource. You don't have access to the domain you are adding
409

The domain is already assigned to another Vercel project Cannot create project domain since owner already has domain on their account, but it's not verified yet. Cannot create project domain since owner already has domain on their account, and it's verified. The domain is not allowed to be used The project is currently being transferred

POST/v10/projects/{idOrName}/domains

Selected HTTP client: JavaScript Fetch

fetch('https://api.vercel.com/v10/projects/{idOrName}/domains', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'www.example.com',
    gitBranch: null,
    customEnvironmentId: '',
    redirect: 'foobar.com',
    redirectStatusCode: 307
  })
})

Show Schema

{
  "name": "…",
  "apexName": "…",
  "projectId": "…",
  "redirect": null,
  "redirectStatusCode": 307,
  "gitBranch": null,
  "customEnvironmentId": null,
  "updatedAt": 1,
  "createdAt": 1,
  "verified": true,
  "verification": [
    {
      "type": "…",
      "domain": "…",
      "value": "…",
      "reason": "…"
    }
  ]
}

The domain was successfully added to the project

v0.0.1

OAS 3.0.3

Vercel REST API

The Vercel REST API is a REST-styled API that gives you full control over the entire Vercel platform. You can use it with any programming language or framework that can send HTTP requests. You need to authenticate with a Vercel access token for every request.

Server

Production API