# Convex Deploy Keys API

**Canonical:** https://apis.io/apis/convex/convex-deploy-keys-api/  
**Provider:** Convex — https://apis.io/providers/convex/  
**Base URL:** wss://{deployment-name}.convex.cloud/api/{clientVersion}/sync  
**Documentation:** https://docs.convex.dev/understanding/

Convex Deploy Keys API is one of 15 APIs that [Convex](https://apis.io/providers/convex/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Deploy Keys. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Create, list, and delete deploy keys

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| POST | `/deployments/{deployment_name}/create_deploy_key` | Create deploy key |
| GET | `/deployments/{deployment_name}/list_deploy_keys` | List deploy keys |
| POST | `/deployments/{deployment_name}/delete_deploy_key` | Delete deploy key |
| POST | `/projects/{project_id}/create_preview_deploy_key` | Create preview deploy key |
| GET | `/projects/{project_id}/list_preview_deploy_keys` | List preview deploy keys |
| POST | `/projects/{project_id}/delete_preview_deploy_key` | Delete preview deploy key |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/convex/refs/heads/main/openapi/convex-deploy-keys-api-openapi.yml
- **Documentation** — https://docs.convex.dev/http-api/
- **Documentation** — https://docs.convex.dev/management-api
- **Documentation** — https://docs.convex.dev/deployment-platform-api

## Other Convex APIs (12)

- [Convex Sync Protocol](https://apis.io/apis/convex/sync-protocol/)
- [Convex JavaScript SDK](https://apis.io/apis/convex/javascript-sdk/)
- [Convex Server SDK](https://apis.io/apis/convex/server-sdk/)
- [Convex Actions API](https://apis.io/apis/convex/convex-actions-api/)
- [Convex Deployments API](https://apis.io/apis/convex/convex-deployments-api/)
- [Convex Functions API](https://apis.io/apis/convex/convex-functions-api/)
- [Convex Mutations API](https://apis.io/apis/convex/convex-mutations-api/)
- [Convex Projects API](https://apis.io/apis/convex/convex-projects-api/)
- [Convex Queries API](https://apis.io/apis/convex/convex-queries-api/)
- [Convex Teams API](https://apis.io/apis/convex/convex-teams-api/)
- [Convex Access Tokens API](https://apis.io/apis/convex/convex-access-tokens-api/)
- [Convex Custom Domains API](https://apis.io/apis/convex/convex-custom-domains-api/)

## Tags

Deploy Keys

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/convex/convex-deploy-keys-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/convex/.