Integration permissions restrict the API surface the integration is allowed to access. When you install an integration, you'll see an overview of what permissions the integration requires to work.

Note: If you are building an integration, see the scopes documentation for integrators to learn more about the relationship between scopes and endpoints.

Installation

Read

Allows to read the installation for the hobby or team account it's installed on.

Write

Allows to remove the installation for the hobby or team account it's installed on.

Deployment

Read

Allows to retrieve deployments for the hobby or team account the integration is installed on. This includes build logs, a list of builds and files, and the file structure for a specific deployment.

Write

Allows to create, update, and delete deployments for the hobby or team account.

Deployment Checks

Write

Allows to retrieve, create, and update tests and assertions that trigger after deployments for the hobby or team account the integration is installed on.

Project

Read

Allows to retrieve all projects for the hobby or team account the integration is installed on. This also includes retrieving all domains for an individual project.

Write

Allows to create, update, and delete projects for the hobby or team account the integration is installed on.

Project Environment Variables

Write

Allows to read, create, and update environment variables for the hobby or team account the integration is installed on.

Team

Read

Allows to access team details for the team the integration is installed on. This includes listing team members.

Personal

Read

Allows to access information about the hobby the integration installation is associated to.

Log Drains

Write

Allows to retrieve a list of log drains, creating new log drains, and removing existing log drains for the hobby or team account the integration is installed on.

Domain

Read

Allows to retrieve all domains for the hobby or team account the integration is installed on. This includes reading its status and configuration.

Write

Allows to remove a previously registered domain name from Vercel for the hobby or team account the integration is installed on.