# Vercel API Docs ## Docs - [Create an access group project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/create-an-access-group-project.md): Allows creation of an access group project - [Creates an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/creates-an-access-group.md): Allows to create an access group - [Delete an access group project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/delete-an-access-group-project.md): Allows deletion of an access group project - [Deletes an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/deletes-an-access-group.md): Allows to delete an access group - [List access groups for a team, project or member](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/list-access-groups-for-a-team-project-or-member.md): List access groups - [List members of an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/list-members-of-an-access-group.md): List members of an access group - [List projects of an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/list-projects-of-an-access-group.md): List projects of an access group - [Reads an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/reads-an-access-group.md): Allows to read an access group - [Reads an access group project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/reads-an-access-group-project.md): Allows reading an access group project - [Update an access group](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/update-an-access-group.md): Allows to update an access group metadata - [Update an access group project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/access-groups/update-an-access-group-project.md): Allows update of an access group project - [Assign an Alias](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/assign-an-alias.md): 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](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/delete-an-alias.md): Delete an Alias with the specified ID. - [Get an Alias](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/get-an-alias.md): Retrieves an Alias for the given host name or alias ID. - [List aliases](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/list-aliases.md): 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. - [List Deployment Aliases](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/list-deployment-aliases.md): Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. - [Update the protection bypass for a URL](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/aliases/update-the-protection-bypass-for-a-url.md): Update the protection bypass for the alias or deployment URL (used for user access & comment access for deployments). Used as shareable links and user scoped access for Vercel Authentication and also to allow external (logged in) people to comment on previews for Preview Comments (next-live-mode). - [Check if a cache artifact exists](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/check-if-a-cache-artifact-exists.md): 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. - [Download a cache artifact](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/download-a-cache-artifact.md): 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. - [Get status of Remote Caching for this principal](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/get-status-of-remote-caching-for-this-principal.md): 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. - [Query information about an artifact](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/query-information-about-an-artifact.md): Query information about an array of artifacts. - [Record an artifacts cache usage event](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/record-an-artifacts-cache-usage-event.md): 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. - [Upload a cache artifact](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/artifacts/upload-a-cache-artifact.md): Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. - [Create an Auth Token](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/authentication/create-an-auth-token.md): 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. - [Delete an authentication token](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/authentication/delete-an-authentication-token.md): Invalidate an authentication token, such that it will no longer be valid for future HTTP requests. - [Get Auth Token Metadata](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/authentication/get-auth-token-metadata.md): Retrieve metadata about an authentication token belonging to the currently authenticated User. - [List Auth Tokens](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/authentication/list-auth-tokens.md): Retrieve a list of the current User's authentication tokens. - [SSO Token Exchange](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/authentication/sso-token-exchange.md): 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. Providers should not persist the returned `id_token` in a database since the token will expire. See [**Authentication with SSO**](https://vercel.com/docs/integrations/create-integration/marketplace-api#authentication-with-sso) for more details. - [List FOCUS billing charges](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/billing/list-focus-billing-charges.md): Returns the billing charge data in FOCUS v1.3 JSONL format for a specified Vercel team, within a date range specified by `from` and `to` query parameters. Supports 1-day granularity with a maximum date range of 1 year. The response is streamed as newline-delimited JSON (JSONL) and can be optionally compressed with gzip if the `Accept-Encoding: gzip` header is provided. - [List FOCUS contract commitments](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/billing/list-focus-contract-commitments.md): Returns commitment allocations per contract period in FOCUS v1.3 JSONL format for a specified Vercel team. The response is streamed as newline-delimited JSON (JSONL). This endpoint is only applicable to Enterprise Vercel customers. An empty response is returned for non-Enterprise (Pro/Flex) customers. - [Delete project-level redirects.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/delete-project-level-redirects.md): Deletes the provided redirects from the latest version of the projects' bulk redirects. Stages a new change with the new redirects and returns the alias for the new version in the response. - [Edit a project-level redirect.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/edit-a-project-level-redirect.md): Edits a single redirect identified by its source path. Stages a new change with the modified redirect and returns the alias for the new version in the response. - [Get the version history for a project's redirects.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/get-the-version-history-for-a-projects-redirects.md): Get the version history for a project's bulk redirects - [Gets project-level redirects.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/gets-project-level-redirects.md): Get the version history for a project's bulk redirects - [Promote a staging version to production or restore a previous production version.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/promote-a-staging-version-to-production-or-restore-a-previous-production-version.md): Update a version by promoting staging to production or restoring a previous production version - [Restore staged project-level redirects to their production version.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/restore-staged-project-level-redirects-to-their-production-version.md): Restores the provided redirects in the staging version to the value in the production version. If no production version exists, removes the redirects from staging. - [Stages new redirects for a project.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/bulk-redirects/stages-new-redirects-for-a-project.md): Stages new redirects for a project and returns the new version. - [Get cert by id](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/certs/get-cert-by-id.md): Get cert by id - [Issue a new cert](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/certs/issue-a-new-cert.md): Issue a new cert - [Remove cert](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/certs/remove-cert.md): Remove cert - [Upload a cert](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/certs/upload-a-cert.md): Upload a cert - [Creates a new Check](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/checks/creates-a-new-check.md): Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error. - [Get a single check](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/checks/get-a-single-check.md): Return a detailed response for a single check. - [Rerequest a check](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/checks/rerequest-a-check.md): Rerequest a selected check that has failed. - [Retrieve a list of all checks](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/checks/retrieve-a-list-of-all-checks.md): List all of the checks created for a deployment. - [Update a check](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/checks/update-a-check.md): Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error. - [Configures Static IPs for a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/configures-static-ips-for-a-project.md): Allows configuring Static IPs for a project - [Create a Secure Compute network](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/create-a-secure-compute-network.md): Allows to create a Secure Compute network. - [Delete a Secure Compute network](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/delete-a-secure-compute-network.md): Allows to delete a Secure Compute network. - [List Secure Compute networks](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/list-secure-compute-networks.md): Allows to list Secure Compute networks. - [Read a Secure Compute network](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/read-a-secure-compute-network.md): Allows to read a Secure Compute network. - [Update a Secure Compute network](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/connect/update-a-secure-compute-network.md): Allows to update a Secure Compute network. - [Cancel a deployment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/cancel-a-deployment.md): This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL. - [Create a new deployment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/create-a-new-deployment.md): 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. - [Delete a Deployment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/delete-a-deployment.md): 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. - [Get a deployment by ID or URL](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/get-a-deployment-by-id-or-url.md): 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 deployment events](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/get-deployment-events.md): 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. - [Get Deployment File Contents](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/get-deployment-file-contents.md): 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 Deployment Files](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/list-deployment-files.md): Allows to retrieve the file structure of the source code of a deployment by supplying the deployment unique identifier. If the deployment was created with the Vercel CLI or the API directly with the `files` key, it will have a file tree that can be retrievable. - [List deployments](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/list-deployments.md): 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`. - [Update deployment integration action](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/update-deployment-integration-action.md): Updates the deployment integration action for the specified integration installation - [Upload Deployment Files](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/deployments/upload-deployment-files.md): 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. - [Create a DNS record](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/dns/create-a-dns-record.md): Creates a DNS record for a domain. - [Delete a DNS record](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/dns/delete-a-dns-record.md): Removes an existing DNS record from a domain name. - [List existing DNS records](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/dns/list-existing-dns-records.md): 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. - [Update an existing DNS record](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/dns/update-an-existing-dns-record.md): Updates an existing DNS record for a domain name. - [Buy a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/buy-a-domain.md): Buy a domain - [Buy multiple domains](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/buy-multiple-domains.md): Buy multiple domains at once - [Get a domain order](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-a-domain-order.md): Get information about a domain order by its ID - [Get a domain's transfer status](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-a-domains-transfer-status.md): Get the transfer status for a domain - [Get availability for a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-availability-for-a-domain.md): Get availability for a specific domain. If the domain is available, it can be purchased using the [Buy a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-a-domain) endpoint or the [Buy multiple domains](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-multiple-domains) endpoint. - [Get availability for multiple domains](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-availability-for-multiple-domains.md): Get availability for multiple domains. If the domains are available, they can be purchased using the [Buy a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-a-domain) endpoint or the [Buy multiple domains](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/buy-multiple-domains) endpoint. - [Get contact info schema](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-contact-info-schema.md): Some TLDs require additional contact information. Use this endpoint to get the schema for the tld-specific contact information for a domain. - [Get price data for a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-price-data-for-a-domain.md): Get price data for a specific domain - [Get supported TLDs](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-supported-tlds.md): Get a list of TLDs supported by Vercel - [Get the auth code for a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-the-auth-code-for-a-domain.md): Get the auth code for a domain. This is required to transfer a domain from Vercel to another registrar. - [Get TLD price data](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/get-tld-price-data.md): Get price data for a specific TLD. This only reflects base prices for the given TLD. Premium domains may have different prices. Use the [Get price data for a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/get-price-data-for-a-domain) endpoint to get the price data for a specific domain. - [Renew a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/renew-a-domain.md): Renew a domain - [Transfer-in a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/transfer-in-a-domain.md): Transfer a domain in from another registrar - [Update auto-renew for a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/update-auto-renew-for-a-domain.md): Update the auto-renew setting for a domain - [Update nameservers for a domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains-registrar/update-nameservers-for-a-domain.md): Update the nameservers for a domain. Pass an empty array to use Vercel's default nameservers. - [Add an existing domain to the Vercel platform](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/add-an-existing-domain-to-the-vercel-platform.md): This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Note: This endpoint is no longer used for initiating domain transfers from external registrars to Vercel. For this, please use the endpoint [Transfer-in a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/transfer-in-a-domain). - [Get a Domain's configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/get-a-domains-configuration.md): Get a Domain's configuration. - [Get Information for a Single Domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/get-information-for-a-single-domain.md): Get information for a single domain in an account or team. - [List all the domains](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/list-all-the-domains.md): 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. - [Remove a domain by name](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/remove-a-domain-by-name.md): Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. - [Update or move apex domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/domains/update-or-move-apex-domain.md): Update or move apex domain. Note: This endpoint is no longer used for updating auto-renew or nameservers. For this, please use the endpoints [Update auto-renew for a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/update-auto-renew-for-a-domain) and [Update nameservers for a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/update-nameservers-for-a-domain). - [Create a new Drain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/create-a-new-drain.md): Create a new Drain with the provided configuration. - [Delete a drain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/delete-a-drain.md): Delete a specific Drain by passing the drain id in the URL. - [Find a Drain by id](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/find-a-drain-by-id.md): Get the information for a specific Drain by passing the drain id in the URL. - [Retrieve a list of all Drains](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/retrieve-a-list-of-all-drains.md): Allows to retrieve the list of Drains of the authenticated team. - [Update an existing Drain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/update-an-existing-drain.md): Update the configuration of an existing drain. - [Validate Drain delivery configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/drains/validate-drain-delivery-configuration.md): Validate the delivery configuration of a Drain using sample events. - [Dangerously delete by source image](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-cache/dangerously-delete-by-source-image.md): Marks a source image as deleted, causing cache entries associated with that source image to be revalidated in the foreground on the next request. Use this method with caution because one source image can be associated with many paths and deleting the cache can cause many concurrent requests to the origin leading to cache stampede problem. This method is for advanced use cases and is not recommended; prefer using `invalidateBySrcImage` instead. - [Dangerously delete by tag](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-cache/dangerously-delete-by-tag.md): Marks a cache tag as deleted, causing cache entries associated with that tag to be revalidated in the foreground on the next request. Use this method with caution because one tag can be associated with many paths and deleting the cache can cause many concurrent requests to the origin leading to cache stampede problem. This method is for advanced use cases and is not recommended; prefer using `invalidateByTag` instead. - [Invalidate by source image](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-cache/invalidate-by-source-image.md): Marks a source image as stale, causing its corresponding transformed images to be revalidated in the background on the next request. - [Invalidate by tag](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-cache/invalidate-by-tag.md): Marks a cache tag as stale, causing cache entries associated with that tag to be revalidated in the background on the next request. - [Create an Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/create-an-edge-config.md): Creates an Edge Config. - [Create an Edge Config token](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/create-an-edge-config-token.md): Adds a token to an existing Edge Config. - [Delete an Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/delete-an-edge-config.md): Delete an Edge Config by id. - [Delete an Edge Config's schema](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/delete-an-edge-configs-schema.md): Deletes the schema of existing Edge Config. - [Delete one or more Edge Config tokens](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/delete-one-or-more-edge-config-tokens.md): Deletes one or more tokens of an existing Edge Config. - [Get all tokens of an Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-all-tokens-of-an-edge-config.md): Returns all tokens of an Edge Config. - [Get an Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-an-edge-config.md): Returns an Edge Config. - [Get an Edge Config item](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-an-edge-config-item.md): Returns a specific Edge Config Item. - [Get Edge Config backup](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-config-backup.md): Retrieves a specific version of an Edge Config from backup storage. - [Get Edge Config backups](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-config-backups.md): Returns backups of an Edge Config. - [Get Edge Config items](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-config-items.md): Returns all items of an Edge Config. - [Get Edge Config schema](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-config-schema.md): Returns the schema of an Edge Config. - [Get Edge Config token meta data](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-config-token-meta-data.md): Return meta data about an Edge Config token. - [Get Edge Configs](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/get-edge-configs.md): Returns all Edge Configs. - [Update an Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/update-an-edge-config.md): Updates an Edge Config. - [Update Edge Config items in batch](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/update-edge-config-items-in-batch.md): Update multiple Edge Config Items in batch. - [Update Edge Config schema](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/edge-config/update-edge-config-schema.md): Update an Edge Config's schema. - [Create a custom environment for the current project.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/create-a-custom-environment-for-the-current-project.md): Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'. - [Create one or more shared environment variables](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/create-one-or-more-shared-environment-variables.md): Creates shared environment variable(s) for a team. - [Delete one or more Env Var](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/delete-one-or-more-env-var.md): Deletes one or many Shared Environment Variables for a given team. - [Disconnects a shared environment variable for a given project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/disconnects-a-shared-environment-variable-for-a-given-project.md): Disconnects a shared environment variable for a given project - [Lists all Shared Environment Variables for a team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/lists-all-shared-environment-variables-for-a-team.md): Lists all Shared Environment Variables for a team, taking into account optional filters. - [Remove a custom environment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/remove-a-custom-environment.md): Remove a custom environment for the project. Must not be named 'Production' or 'Preview'. - [Retrieve a custom environment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/retrieve-a-custom-environment.md): Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'. - [Retrieve custom environments](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/retrieve-custom-environments.md): Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'. - [Retrieve the decrypted value of a Shared Environment Variable by id.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/retrieve-the-decrypted-value-of-a-shared-environment-variable-by-id.md): Retrieve the decrypted value of a Shared Environment Variable by id. - [Update a custom environment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/update-a-custom-environment.md): Update a custom environment for the project. Must not be named 'Production' or 'Preview'. - [Updates one or more shared environment variables](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/environment/updates-one-or-more-shared-environment-variables.md): Updates a given Shared Environment Variable for a Team. - [Connect integration resource to project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/connect-integration-resource-to-project.md): Connects an integration resource to a Vercel project. This endpoint establishes a connection between a provisioned integration resource (from storage APIs like `POST /v1/storage/stores/integration/direct`) and a specific Vercel project. - [Create integration store (free and paid plans)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/create-integration-store-free-and-paid-plans.md): Creates an integration store with automatic billing plan handling. For free resources, omit `billingPlanId` to auto-discover free plans. For paid resources, provide a `billingPlanId` from the billing plans endpoint. - [Delete an integration configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/delete-an-integration-configuration.md): 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. - [Get configurations for the authenticated user or team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/get-configurations-for-the-authenticated-user-or-team.md): 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. - [List git namespaces by provider](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/list-git-namespaces-by-provider.md): 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. - [List git repositories linked to namespace by provider](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/list-git-repositories-linked-to-namespace-by-provider.md): 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. - [List integration billing plans](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/list-integration-billing-plans.md): Get a list of billing plans for an integration and product. - [List products for integration configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/list-products-for-integration-configuration.md): Returns products available for an integration configuration. Each product includes a `metadataSchema` field with the JSON Schema for required and optional metadata fields. - [Retrieve an integration configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/integrations/retrieve-an-integration-configuration.md): 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. - [Creates a Configurable Log Drain (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/creates-a-configurable-log-drain-deprecated.md): Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed) - [Creates a new Integration Log Drain (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/creates-a-new-integration-log-drain-deprecated.md): 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 (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/deletes-a-configurable-log-drain-deprecated.md): 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` (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/deletes-the-integration-log-drain-with-the-provided-`id`-deprecated.md): 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 Configurable Log Drain (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/retrieves-a-configurable-log-drain-deprecated.md): 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 the Log Drains (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/retrieves-a-list-of-all-the-log-drains-deprecated.md): 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 list of Integration log drains (deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logdrains/retrieves-a-list-of-integration-log-drains-deprecated.md): 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. - [Get logs for a deployment](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/logs/get-logs-for-a-deployment.md): Returns a stream of logs for a given deployment. - [Create Event](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/create-event.md): 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.

`resource.updated` event should be dispatched when any state of a resource linked to Vercel is modified by the partner.
`installation.updated` event should be dispatched when an installation's billing plan is changed via the provider instead of Vercel.

Resource update use cases:

- 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.
- A resource has been suspended due to a lack of use. The partner should dispatch a `resource.updated` event to notify Vercel to update the resource's status in Vercel's datastores.
- [Create one or multiple experimentation items](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/create-one-or-multiple-experimentation-items.md): Create one or multiple experimentation items - [Delete an existing experimentation item](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/delete-an-existing-experimentation-item.md): Delete an existing experimentation item - [Delete Integration Resource](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/delete-integration-resource.md): Delete a resource owned by the selected installation ID. - [Get Account Information](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-account-information.md): Fetches the best account or user’s contact info - [Get Integration Resource](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-integration-resource.md): Get a resource by its partner ID. - [Get Integration Resources](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-integration-resources.md): Get all resources for a given installation ID. - [Get Invoice](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-invoice.md): Get Invoice details and status for a given invoice ID.

See Billing Events with Webhooks documentation on how to receive invoice events. This endpoint is used to retrieve the invoice details. - [Get Member Information](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-member-information.md): Returns the member role and other information for a given member ID ("user_id" claim in the SSO OIDC token). - [Get the data of a user-provided Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-the-data-of-a-user-provided-edge-config.md): When the user enabled Edge Config syncing, then this endpoint can be used by the partner to fetch the contents of the Edge Config. - [Get the data of a user-provided Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/get-the-data-of-a-user-provided-edge-config-1.md): When the user enabled Edge Config syncing, then this endpoint can be used by the partner to fetch the contents of the Edge Config. - [Import Resource](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/import-resource.md): This endpoint imports (upserts) a resource to Vercel's installation. This may be needed if resources can be independently created on the partner's side and need to be synchronized to Vercel. - [Invoice Actions](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/invoice-actions.md): 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). - [Patch an existing experimentation item](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/patch-an-existing-experimentation-item.md): Patch an existing experimentation item - [Push data into a user-provided Edge Config](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/push-data-into-a-user-provided-edge-config.md): When the user enabled Edge Config syncing, then this endpoint can be used by the partner to push their configuration data into the relevant Edge Config. - [Submit Billing Data](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/submit-billing-data.md): Sends the billing and usage data. The partner should do this at least once a day and ideally once per hour.
Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request. - [Submit Invoice](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/submit-invoice.md): 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.

Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request.
There are several limitations to the invoice submission:

1. A resource can only be billed once per the billing period and the billing plan.
2. The billing plan used to bill the resource must have been active for this resource during the billing period.
3. The billing plan used must be a subscription plan.
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.
- [Submit Prepayment Balances](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/submit-prepayment-balances.md): Sends the prepayment balances. The partner should do this at least once a day and ideally once per hour.
Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request. - [Update Installation](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/update-installation.md): This endpoint updates an integration installation. - [Update Resource](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/update-resource.md): This endpoint updates an existing resource in the installation. All parameters are optional, allowing partial updates. - [Update Resource Secrets](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/update-resource-secrets.md): 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.

Use cases for this endpoint:

- 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.
- [Update Resource Secrets (Deprecated)](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/marketplace/update-resource-secrets-deprecated.md): This endpoint is deprecated and replaced with the endpoint [Update Resource Secrets](#update-resource-secrets).
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.

Use cases for this endpoint:

- 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.
- [Adds a new member to a project.](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projectmembers/adds-a-new-member-to-a-project.md): Adds a new member to the project. - [List project members](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projectmembers/list-project-members.md): Lists all members of a project. - [Remove a Project Member](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projectmembers/remove-a-project-member.md): Remove a member from a specific project - [Accept project transfer request](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/accept-project-transfer-request.md): Accept a project transfer request initated by another team.
The `code` is generated using the `POST /projects/:idOrName/transfer-request` endpoint. - [Add a domain to a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/add-a-domain-to-a-project.md): 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. - [Batch remove environment variables](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/batch-remove-environment-variables.md): Delete multiple environment variables for a given project in a single batch operation. - [Create a new project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/create-a-new-project.md): 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](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/create-one-or-more-environment-variables.md): 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. - [Create project transfer request](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/create-project-transfer-request.md): Initiates a project transfer request from one team to another.
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.
Users can also accept the project transfer request using the claim URL: `https://vercel.com/claim-deployment?code=&returnUrl=`.
The `code` parameter specifies the project transfer request code generated using this endpoint.
The `returnUrl` parameter redirects users to a specific page of the application if the claim URL is invalid or expired. - [Delete a Project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/delete-a-project.md): Delete a specific project by passing either the project `id` or `name` in the URL. - [Edit an environment variable](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/edit-an-environment-variable.md): 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. - [Find a project by id or name](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/find-a-project-by-id-or-name.md): Get the information for a specific project by passing either the project `id` or `name` in the URL. - [Get a project domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/get-a-project-domain.md): Get project domain by project id/name and domain name. - [Gets a list of aliases with status for the current promote](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/gets-a-list-of-aliases-with-status-for-the-current-promote.md): Get a list of aliases related to the last promote request with their mapping status - [Move a project domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/move-a-project-domain.md): Move one project's domain to another project. Also allows the move of all redirects pointed to that domain in the same project. - [Pause a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/pause-a-project.md): 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. - [Points all production domains for a project to the given deploy](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/points-all-production-domains-for-a-project-to-the-given-deploy.md): Allows users to rollback to a deployment. - [Points all production domains for a project to the given deploy](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/points-all-production-domains-for-a-project-to-the-given-deploy-1.md): Allows users to promote a deployment to production. Note: This does NOT rebuild the deployment. If you need that, then call create-deployments endpoint. - [Remove a domain from a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/remove-a-domain-from-a-project.md): 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. - [Remove an environment variable](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/remove-an-environment-variable.md): 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. - [Retrieve a list of projects](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/retrieve-a-list-of-projects.md): 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. - [Retrieve project domains by project by id or name](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/retrieve-project-domains-by-project-by-id-or-name.md): Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. - [Retrieve the decrypted value of an environment variable of a project by id](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/retrieve-the-decrypted-value-of-an-environment-variable-of-a-project-by-id.md): Retrieve the environment variable for a given project. - [Retrieve the environment variables of a project by id or name](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/retrieve-the-environment-variables-of-a-project-by-id-or-name.md): Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL. - [Unpause a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/unpause-a-project.md): 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 a project domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/update-a-project-domain.md): Update a project domain's configuration, including the name, git branch and redirect of the domain. - [Update an existing project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/update-an-existing-project.md): Update the fields of a project using either its `name` or `id`. - [Update Protection Bypass for Automation](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/update-protection-bypass-for-automation.md): Update the deployment protection automation bypass for a project - [Verify project domain](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/projects/verify-project-domain.md): Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge. - [Complete the rolling release for the project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/complete-the-rolling-release-for-the-project.md): Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic. - [Delete rolling release configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/delete-rolling-release-configuration.md): Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. Changing the config never alters a rollout that's already in-flight—it only affects the next production deployment. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint. - [Get rolling release billing status](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/get-rolling-release-billing-status.md): Get the Rolling Releases billing status for a project. The team level billing status is used to determine if the project can be configured for rolling releases. - [Get rolling release configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/get-rolling-release-configuration.md): Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release. - [Get the active rolling release information for a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/get-the-active-rolling-release-information-for-a-project.md): Return the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed. If the feature is enabled but no deployment has occurred yet, null will be returned. - [Update the active rolling release to the next stage for a project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/update-the-active-rolling-release-to-the-next-stage-for-a-project.md): Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval. - [Update the rolling release settings for the project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/rolling-release/update-the-rolling-release-settings-for-the-project.md): Update (or disable) Rolling Releases for a project. When disabling with the resolve-on-disable feature flag enabled, any active rolling release document is resolved using the disableRolloutAction parameter: "abort" to roll back (default), or "complete" to promote the canary to production. When enabling or updating config, changes only affect the next production deployment and do not alter a rollout that's already in-flight. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn't configured already. - [Create System Bypass Rule](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/create-system-bypass-rule.md): Create new system bypass rules - [Put Firewall Configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/put-firewall-configuration.md): Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration. - [Read active attack data](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/read-active-attack-data.md): Retrieve active attack data within the last N days (default: 1 day) - [Read Firewall Actions by Project](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/read-firewall-actions-by-project.md): Retrieve firewall actions for a project - [Read Firewall Configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/read-firewall-configuration.md): Retrieve the specified firewall configuration for a project. The deployed configVersion will be `active` - [Read System Bypass](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/read-system-bypass.md): Retrieve the system bypass rules configured for the specified project - [Remove System Bypass Rule](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/remove-system-bypass-rule.md): Remove system bypass rules - [Update Attack Challenge mode](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/update-attack-challenge-mode.md): Update the setting for determining if the project has Attack Challenge mode enabled. - [Update Firewall Configuration](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/security/update-firewall-configuration.md): Process updates to modify the existing firewall config for a project - [Create a Team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/create-a-team.md): 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](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/delete-a-team.md): 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 a Team invite code](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/delete-a-team-invite-code.md): Delete an active Team invite code. - [Get a Team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/get-a-team.md): Get information for the Team specified by the `teamId` parameter. - [Get access request status](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/get-access-request-status.md): 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. - [Invite a user](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/invite-a-user.md): 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 to be invited must be specified by email. - [Join a team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/join-a-team.md): Join a team with a provided invite code or team ID. - [List all teams](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/list-all-teams.md): Get a paginated list of all the Teams the authenticated User is a member of. - [List team members](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/list-team-members.md): Get a paginated list of team members for the provided team. - [Remove a Team Member](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/remove-a-team-member.md): Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. - [Request access to a team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/request-access-to-a-team.md): 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 a Team](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/update-a-team.md): 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. - [Update a Team Member](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/update-a-team-member.md): 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. - [Update Team Directory Sync Role Mappings](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/teams/update-team-directory-sync-role-mappings.md): Update the Directory Sync role mappings for a Team. This endpoint allows updating the mapping between directory groups and team roles or access groups. - [Updates the description for a rollback](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/updates-the-description-for-a-rollback.md): Updates the reason for a rollback, without changing the rollback status itself. - [Delete User Account](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/user/delete-user-account.md): 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. - [Get the User](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/user/get-the-user.md): Retrieves information related to the currently authenticated User. - [List User Events](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/user/list-user-events.md): 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. - [Creates a webhook](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/webhooks/creates-a-webhook.md): Creates a webhook - [Deletes a webhook](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/webhooks/deletes-a-webhook.md): Deletes a webhook - [Get a list of webhooks](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/webhooks/get-a-list-of-webhooks.md): Get a list of webhooks - [Get a webhook](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/endpoints/webhooks/get-a-webhook.md): Get a webhook - [Errors](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/errors.md): List of general and specific errors you may encounter when using the REST API. - [Deployment Automation](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/deployments-automation.md): Learn how to use the Vercel SDK through real-life examples. - [Domain Management](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/domain-management.md): Learn how to use the Vercel SDK through real-life examples. - [Environment Variables](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/environment-variables.md): Learn how to use the Vercel SDK through real-life examples. - [Vercel WAF Management](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/firewall-management.md): Learn how to use the Vercel SDK through real-life examples. - [Integrations](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/integrations.md): Learn how to use the Vercel SDK through real-life examples. - [Logs and Monitoring](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/logs-monitoring.md): Learn how to use the Vercel SDK through real-life examples. - [Project Management](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/project-management.md): Learn how to use the Vercel SDK through real-life examples. - [Rolling Releases Management](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/rolling-releases.md): Learn how to use the Vercel SDK to manage Rolling Releases through real-life examples. - [Team and User Management](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/examples/team-management.md): Learn how to use the Vercel SDK through real-life examples. - [Using the Vercel SDK](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/sdk.md): Interact programmatically with your Vercel account using the SDK. - [Using the REST API](https://vercel.mintlify-docs-rest-api-reference.com/docs/rest-api/reference/welcome.md): Interact programmatically with your Vercel account using the SDK or direct HTTP requests.