---
title: deployments
product: vercel
url: /docs/rest-api/deployments
canonical_url: "https://vercel.com/docs/rest-api/deployments"
last_updated: 2026-11-13
type: reference
prerequisites:
  []
related:
  - /docs/rest-api/deployments/get-deployment-events.md
  - /docs/rest-api/deployments/update-deployment-integration-action.md
  - /docs/rest-api/deployments/get-a-deployment-by-id-or-url.md
  - /docs/rest-api/deployments/create-a-new-deployment.md
  - /docs/rest-api/deployments/cancel-a-deployment.md
summary: Learn about deployments on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
search_with_vercel_cli: npx vercel@latest docs search "<query>"
---

# Deployments

Endpoints in the Deployments group of the Vercel REST API Reference.

| Method | Endpoint | Description |
|---|---|---|
| **GET** | [`/v3/deployments/{idOrUrl}/events`](/docs/rest-api/deployments/get-deployment-events.md) | Get deployment events |
| **PATCH** | [`/v1/deployments/{deploymentId}/integrations/{integrationConfigurationId}/resources/{resourceId}/actions/{action}`](/docs/rest-api/deployments/update-deployment-integration-action.md) | Update deployment integration action |
| **GET** | [`/v13/deployments/{idOrUrl}`](/docs/rest-api/deployments/get-a-deployment-by-id-or-url.md) | Get a deployment by ID or URL |
| **POST** | [`/v13/deployments`](/docs/rest-api/deployments/create-a-new-deployment.md) | Create a new deployment |
| **PATCH** | [`/v12/deployments/{id}/cancel`](/docs/rest-api/deployments/cancel-a-deployment.md) | Cancel a deployment |
| **POST** | [`/v2/files`](/docs/rest-api/deployments/upload-deployment-files.md) | Upload Deployment Files |
| **GET** | [`/v6/deployments/{id}/files`](/docs/rest-api/deployments/list-deployment-files.md) | List Deployment Files |
| **GET** | [`/v8/deployments/{id}/files/{fileId}`](/docs/rest-api/deployments/get-deployment-file-contents.md) | Get Deployment File Contents |
| **GET** | [`/v7/deployments`](/docs/rest-api/deployments/list-deployments.md) | List deployments |
| **DELETE** | [`/v13/deployments/{id}`](/docs/rest-api/deployments/delete-a-deployment.md) | Delete a Deployment |

---

## Related

- [REST API overview](/docs/rest-api)

## Search the docs from your terminal

Search the Vercel docs and read pages as Markdown with the Vercel CLI. No login required.

```bash
# Find docs pages by keyword
npx vercel@latest docs search "environment variables"
npx vercel@latest docs search "function timeout"

# Print a docs page as Markdown, by path or URL
npx vercel@latest docs inspect <page>
```

---

[View full sitemap](/docs/sitemap)


If you encounter incorrect information, can’t find what you need, need a capability Vercel doesn’t currently offer, or have any other feedback to report, please do it by following the instructions at https://vercel.com/feedback.md.