Convex Deployments API
Create, list, retrieve, update, and delete Convex cloud and local deployments. Deployments are the runtime environments where Convex backend functions execute.
Convex Deployments API is one of 14 APIs that Convex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://api.convex.dev/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Convex Deployments API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (teamToken).
It accepts HTTP bearer tokens (oauthTeamToken).
It accepts HTTP bearer tokens (oauthProjectToken).
By default, every request must be authenticated.
teamToken— Team Access Token created in the Convex dashboard team settings. Grants management access to all projects and deployments within the team.oauthTeamToken— OAuth Application Token issued by Convex for third-party integrations acting on behalf of a user's team. Obtained via the Convex OAuth flow.oauthProjectToken— OAuth Application Token scoped to a specific project, issued by Convex for third-party integrations.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Create, list, retrieve, update, and delete Convex cloud and local deployments. Deployments are the runtime environments where Convex backend functions execute.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Deployment (7 properties), CreateCloudDeploymentRequest (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Convex 12
Other APIs Convex publishes across the network.
This is an independent, third-party profile of Convex Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.