Managing projects

You can manage your project on Vercel in your project's dashboard. To learn more, see Project Settings and Managing deployments.

DashboardcURLSDK

To create a new project:

1. On the Vercel dashboard, ensure you have selected the correct team from the team switcher.
2. Click the Add New… drop-down button and select Project:

3. You can either import from an existing Git repository or use one of our templates. For more information, see our Getting Started with Vercel.
4. If you choose to import from a Git repository, you'll be prompted to select the repository you want to deploy.
5. Configure your project settings, such as the name, framework, environment variables, and build and output settings.
6. If you're importing from a monorepo, select the Edit button to select the project from the repository you want to deploy. For more information, see Monorepos.

To create an Authorization Bearer token, see the access token section of the API documentation.

cURL

curl --request POST \
  --url https://api.vercel.com/v11/projects \
  --header "Authorization: Bearer $VERCEL_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "environmentVariables": [
      {
        "key": "<env-key>",
        "target": "production",
        "gitBranch": "<git-branch>",
        "type": "system",
        "value": "<env-value>"
      }
    ],
    "framework": "<framework>",
    "gitRepository": {
      "repo": "<repo-url>",
      "type": "github"
    },
    "installCommand": "<install-command>",
    "name": "<project-name>",
    "rootDirectory": "<root-directory>"
  }'

To create an Authorization Bearer token, see the access token section of the API documentation.

createProject

import { Vercel } from '@vercel/sdk';
 
const vercel = new Vercel({
  bearerToken: '<YOUR_BEARER_TOKEN_HERE>',
});
 
async function run() {
  const result = await vercel.projects.createProject({
    requestBody: {
      name: '<project-name>',
      environmentVariables: [
        {
          key: '<env-key>',
          target: 'production',
          gitBranch: '<git-branch>',
          type: 'system',
          value: '<env-value>',
        },
      ],
      framework: '<framework>',
      gitRepository: {
        repo: '<repo-url>',
        type: 'github',
      },
      installCommand: '<install-command>',
      name: '<project-name>',
      rootDirectory: '<root-directory>',
    },
  });
 
  // Handle the result
  console.log(result);
}
 
run();

You can choose to temporarily pause a project to ensure that you do not incur usage from metered resources on your production deployment.

To automatically pause your projects when you reach your spend amount:

1. On the Vercel dashboard, ensure you have selected the correct team from the team switcher.
2. Open Settings in the sidebar.
3. In the Spend Management section, select the Pause all production deployments option. Then follow the steps to confirm the action.

To learn more, see the Spend Management documentation.

To pause a single project manually:

1. On the Vercel dashboard, ensure you have selected the correct team from the team switcher and select the project you want to pause.
2. Open Settings in the sidebar.
3. On the General page, find the Pause Project section above Delete Project and select the Pause Project button.
4. In the dialog that appears, review the effects of pausing, type the project name to confirm, then select Pause Project.

To pause a project manually or with a webhook you can use the REST API:

1. Ensure you have access token scoped to your team to authenticate the API.
2. Create a webhook that calls the pause project endpoint:
   • You'll need to pass a path parameter of the Project ID and query string of Team ID:
     request

     https://api.vercel.com/v1/projects/<prj_ID>/pause?teamId=<team_ID>

   • Use your access token as the bearer token, to enable you to carry out actions through the API on behalf of your team.
   • Ensure that your Content-Type header is set to application/json.

When you pause your project, any users accessing your production deployment will see a 503 DEPLOYMENT_PAUSED error.

curl --request POST \
  --url "https://api.vercel.com/v1/projects/<project-id>/pause?teamId=<team-id>&slug=<team-slug>" \
  --header "Authorization: Bearer $VERCEL_TOKEN"

Resuming a project can either be done through the REST API or your project settings:

1. Go to your team's dashboard and select your project. When you select it, you should notice it has a paused icon in the team switcher.
2. Open Settings in the sidebar.
3. On the General page, find the Pause Project section above Delete Project and select the Resume Project button.

You can also select Resume Project in the banner at the top of the same page, or in the banner on the project overview page. Resuming takes effect immediately and does not ask for confirmation.

Your production deployment will resume service within a few minutes. You do not need to redeploy it.

Deleting your project will also delete the deployments, domains, environment variables, and settings within it. If you have any deployments that are assigned to a custom domain and do not want them to be removed, make sure to deploy and assign them to the custom domain under a different project first.

To delete a project:

1. On the Vercel dashboard, ensure you have selected the correct team from the team switcher and select the project you want to delete.
2. Open Settings in the sidebar.
3. At the bottom of the General page, you’ll see the Delete Project section. Click the Delete button.

4. In the Delete Project dialog, confirm that you'd like to delete the project by entering the project name and prompt. Then, click the Continue button.