Vercel REST API Endpoints

Allows to create an access group

Allows creation of an access group project

Allows to delete an access group

Allows deletion of an access group project

List members of an access group

List projects of an access group

List access groups

Allows to read an access group

Allows reading an access group project

Allows to update an access group metadata

Allows update of an access group project

Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one.

Delete an Alias with the specified ID.

Retrieves an Alias for the given host name or alias ID.

Retrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is provided, it will only return the given project aliases.

Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.

Check that a cache artifact with the given hash exists. This request returns response headers only and is equivalent to a GET request to this endpoint where the response contains no body.

Query information about an array of artifacts.

Downloads a cache artifact indentified by its hash specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body.

Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are HIT and MISS. The source is either LOCAL the cache event was on the users filesystem cache or REMOTE if the cache event is for a remote cache. When the event is a HIT the request also accepts a number duration which is the time taken to generate the artifact in the cache.

Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits.

Uploads a cache artifact identified by the hash specified on the path. The cache artifact can then be downloaded with the provided hash.

Creates and returns a new authentication token for the currently authenticated User. The bearerToken property is only provided once, in the response body, so be sure to save it on the client for use with API requests.

Invalidate an authentication token, such that it will no longer be valid for future HTTP requests.

During the autorization process, Vercel sends the user to the provider [redirectLoginUrl](https://vercel.com/docs/integrations/create-integration/submit-integration#redirect-login-url), that includes the OAuth authorization code parameter. The provider then calls the SSO Token Exchange endpoint with the sent code and receives the OIDC token. They log the user in based on this token and redirects the user back to the Vercel account using deep-link parameters included the redirectLoginUrl. This is used to verify the identity of the user during the [**Open in Provider** flow](https://vercel.com/docs/integrations/marketplace-flows#open-in-provider-button-flow). Providers should not persist the returned id_token in a database since the token will expire.

Retrieve metadata about an authentication token belonging to the currently authenticated User.

Retrieve a list of the current User's authentication tokens.

Get cert by id

Issue a new cert

Remove cert

Upload a cert

Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

List all of the checks created for a deployment.

Return a detailed response for a single check.

Rerequest a selected check that has failed.

Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

This endpoint allows you to cancel a deployment which is currently building, by supplying its id in the URL.

Create a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request, either referenced or inlined. Additionally, a deployment id can be specified to redeploy a previous deployment.

This API allows you to delete a deployment, either by supplying its id in the URL or the url of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.

Retrieves information for a deployment either by supplying its ID (id property) or Hostname (url property). Additional details will be included when the authenticated user or team is an owner of the deployment.

Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.

Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain a JSON response containing the contents of the file encoded as base64.

List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the url property will have a value of null.

Allows to retrieve the file structure of a deployment by supplying the deployment unique identifier.

Before you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once that's completed, you can create a new deployment with the uploaded files. The file content must be placed inside the body of the request. In the case of a successful response you'll receive a status code 200 with an empty body.

Creates a DNS record for a domain.

Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.

Removes an existing DNS record from a domain name.

Updates an existing DNS record for a domain name.

Allows to purchase the specified domain.

Check the price to purchase a domain and how long a single purchase period is.

Check if a domain name is available for purchase.

This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel.

Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.

Get information for a single domain in an account or team.

Get a Domain's configuration.

Fetch domain transfer availability or transfer status if a transfer is in progress.

Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided.

Update or move apex domain.

Creates an Edge Config.

Adds a token to an existing Edge Config.

Delete an Edge Config by id.

Deletes the schema of existing Edge Config.

Deletes one or more tokens of an existing Edge Config.

Returns an Edge Config.

Retrieves a specific version of an Edge Config from backup storage.

Returns backups of an Edge Config.

Returns a specific Edge Config Item.

Returns all items of an Edge Config.

Returns the schema of an Edge Config.

Return meta data about an Edge Config token.

Returns all tokens of an Edge Config.

Returns all Edge Configs.

Update multiple Edge Config Items in batch.

Update an Edge Config's schema.

Updates an Edge Config.

Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.

Allows to remove the configuration with the id provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.

Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.

Allows to retrieve all configurations for an authenticated integration. When the project view is used, configurations generated for the authorization flow will be filtered out of the results.

Lists git namespaces for a supported provider. Supported providers are github, gitlab and bitbucket. If the provider is not provided, it will try to obtain it from the user that authenticated the request.

Lists git repositories linked to a namespace id for a supported provider. A specific namespace id can be obtained via the git-namespaces endpoint. Supported providers are github, gitlab and bitbucket. If the provider or namespace is not provided, it will try to obtain it from the user that authenticated the request.

Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed)

Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error.

Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted.

Deletes the Integration log drain with the provided id. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it.

Retrieves a list of all the Log Drains owned by the account. This endpoint must be called with an account AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated account can be accessed.

Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed.

Retrieves a list of all Integration log drains that are defined for the authenticated user or team. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration.

Partner notifies Vercel of any changes made to an Installation or a Resource. Vercel is expected to use list-resources and other read APIs to get the new state. <br/> <br/> resource.updated event should be dispatched when any state of a resource linked to Vercel is modified by the partner. <br/> <br/> Use cases: <br/> <br/> - The user renames a database in the partner’s application. The partner should dispatch a resource.updated event to notify Vercel to update the resource in Vercel’s datastores. <br/>

During the autorization process, Vercel sends the user to the provider [redirectLoginUrl](https://vercel.com/docs/integrations/create-integration/submit-integration#redirect-login-url), that includes the OAuth authorization code parameter. The provider then calls the SSO Token Exchange endpoint with the sent code and receives the OIDC token. They log the user in based on this token and redirects the user back to the Vercel account using deep-link parameters included the redirectLoginUrl. This is used to verify the identity of the user during the [**Open in Provider** flow](https://vercel.com/docs/integrations/marketplace-flows#open-in-provider-button-flow). Providers should not persist the returned id_token in a database since the token will expire.

Fetches the best account or user’s contact info

Get Invoice details and status for a given invoice ID.<br/> <br/> See Billing Events with Webhooks documentation on how to receive invoice events. This endpoint is used to retrieve the invoice details.

Returns the member role and other information for a given member ID ("user_id" claim in the SSO OIDC token).

Sends the billing and usage data. The partner should do this at least once a day and ideally once per hour. <br/> Use the credentials.access_token we provided in the [Upsert Installation](#upsert-installation) body to authorize this request.

This endpoint allows the partner to submit an invoice to Vercel. The invoice is created in Vercel's billing system and sent to the customer. Depending on the type of billing plan, the invoice can be sent at a time of signup, at the start of the billing period, or at the end of the billing period.<br/> <br/> Use the credentials.access_token we provided in the [Upsert Installation](#upsert-installation) body to authorize this request. <br/> There are several limitations to the invoice submission:<br/> <br/> 1. A resource can only be billed once per the billing period and the billing plan.<br/> 2. The billing plan used to bill the resource must have been active for this resource during the billing period.<br/> 3. The billing plan used must be a subscription plan.<br/> 4. The interim usage data must be sent hourly for all types of subscriptions. See [Send subscription billing and usage data](#send-subscription-billing-and-usage-data) API on how to send interim billing and usage data.<br/>

This endpoint allows the partner to request a refund for an invoice to Vercel. The invoice is created using the [Submit Invoice API](#submit-invoice-api).

This endpoint is deprecated and replaced with the endpoint [Update Resource Secrets](#update-resource-secrets). <br/> This endpoint updates the secrets of a resource. If a resource has projects connected, the connected secrets are updated with the new secrets. The old secrets may still be used by existing connected projects because they are not automatically redeployed. Redeployment is a manual action and must be completed by the user. All new project connections will use the new secrets.<br/> <br/> Use cases for this endpoint:<br/> <br/> - Resetting the credentials of a database in the partner. If the user requests the credentials to be updated in the partner’s application, the partner post the new set of secrets to Vercel, the user should redeploy their application and the expire the old credentials.<br/>

This endpoint updates the secrets of a resource. If a resource has projects connected, the connected secrets are updated with the new secrets. The old secrets may still be used by existing connected projects because they are not automatically redeployed. Redeployment is a manual action and must be completed by the user. All new project connections will use the new secrets.<br/> <br/> Use cases for this endpoint:<br/> <br/> - Resetting the credentials of a database in the partner. If the user requests the credentials to be updated in the partner’s application, the partner post the new set of secrets to Vercel, the user should redeploy their application and the expire the old credentials.<br/>

Adds a new member to the project.

Lists all members of a project.

Remove a member from a specific project

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

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.

Allows to create a new project with the provided configuration. It only requires the project name but more configuration can be provided to override the defaults.

Create one or more environment variables for a project by passing its key, value, type and target and by specifying the project by either passing the project id or name in the URL. If you include upsert=true as a query parameter, a new environment variable will not be created if it already exists but, the existing variable's value will be updated.

Initiates a project transfer request from one team to another. <br/> Returns a code that remains valid for 24 hours and can be used to accept the transfer request by another team using the PUT /projects/transfer-request/:code endpoint. <br/> Users can also accept the project transfer request using the claim URL: https://vercel.com/claim-deployment?code=<code>&returnUrl=<returnUrl>. <br/> The code parameter specifies the project transfer request code generated using this endpoint. <br/> The returnUrl parameter redirects users to a specific page of the application if the claim URL is invalid or expired.

Delete a specific project by passing either the project id or name in the URL.

Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL.

Retrieve the environment variables for a given project by passing either the project id or name in the URL.

Get the information for a specific project by passing either the project id or name in the URL.

Get project domain by project id/name and domain name.

Retrieve the domains associated with a given project by passing either the project id or name in the URL.

Retrieve the environment variable for a given project.

Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.

Get a list of aliases related to the last promote request with their mapping status

Pause a project by passing its project id in the URL. If the project does not exist given the id then the request will fail with 400 status code. If the project disables auto assigning custom production domains and blocks the active Production Deployment then the request will return with 200 status code.

Remove a domain from a project by passing the domain name and by specifying the project by either passing the project id or name in the URL.

Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project id or name in the URL.

Allows users to promote a deployment to production. Note: This does NOT rebuild the deployment. If you need that, then call create-deployments endpoint.

Unpause a project by passing its project id in the URL. If the project does not exist given the id then the request will fail with 400 status code. If the project enables auto assigning custom production domains and unblocks the active Production Deployment then the request will return with 200 status code.

Update the fields of a project using either its name or id.

Update the data cache feature on a project.

Update a project domain's configuration, including the name, git branch and redirect of the domain.

Update the deployment protection automation bypass for a project

Attempts to verify a project domain with verified = false by checking the correctness of the project domain's verification challenge.

Allows to create a new secret.

This deletes the user or team’s secret defined in the URL.

Retrieves the information for a specific secret by passing either the secret id or name in the URL.

Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.

Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.

Create new system bypass rules

Retrieve active attack data within the last 24h window

Retrieve the system bypass rules configured for the specified project

Retrieve the specified firewall configuration for a project. The deployed configVersion will be active

Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.

Remove system bypass rules

Update the setting for determining if the project has Attack Challenge mode enabled.

Process updates to modify the existing firewall config for a project

Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name.

Delete a team under your account. You need to send a DELETE request with the desired team id. An optional array of reasons for deletion may also be sent.

Delete an active Team invite code.

Get information for the Team specified by the teamId parameter.

Check the status of a join request. It'll respond with a 404 if the request has been declined. If no userId path segment was provided, this endpoint will instead return the status of the authenticated user.

Get a paginated list of team members for the provided team.

Get a paginated list of all the Teams the authenticated User is a member of.

Invite a user to join the team specified in the URL. The authenticated user needs to be an OWNER in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority.

Join a team with a provided invite code or team ID.

Update the information of a Team specified by the teamId parameter. The request body should contain the information that will be updated on the Team.

Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.

Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time.

Update the membership of a Team Member on the Team specified by teamId, such as changing the _role_ of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an OWNER of the Team.

Retrieves information related to the currently authenticated User.

Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.

Creates a webhook

Deletes a webhook

Get a webhook

Get a list of webhooks