Reference

Create deploy key

Generate secure credentials that allow you to deploy and manage your Convex backend from your development environment or CI/CD pipeline without sharing your main account credentials.

Get token details

Retrieve detailed information about your authentication token, including which team or project it's associated with. This helps you verify token ownership and manage access across your Convex projects.

List Deploy Keys

Retrieve all deploy keys associated with a Convex deployment to manage authentication credentials and monitor which tokens have access to your project.

Create Deployment

Create a new deployment environment for your Convex project, allowing you to set up separate instances for development, production, or testing with custom configurations like region and performance class.

List Deployments

Retrieve a complete list of all deployments for your Convex project, including production, preview, and local environments. Use this to track and monitor the status of your application versions across different deployment stages.

Delete Deployment

Permanently remove a Convex deployment and all its associated data from your project. Use this when you no longer need a specific environment or want to clean up unused deployments.

Get Deployment Details

Retrieve comprehensive information about your Convex cloud deployment, including its configuration, region, and current status to monitor your backend infrastructure.

List deployment classes

Retrieve all available deployment classes that your Convex team can use when deploying applications, helping you understand the deployment options and resources available for your projects.

List deployment regions

Retrieve all available geographic regions where you can deploy your Convex backend infrastructure for your team. Use this to understand deployment options before selecting where to host your application.

Update Deployment

Modify settings and properties of your Convex deployment, such as enabling dashboard edit confirmation or updating deployment references without affecting unchanged settings.

Delete Custom Domain

Remove a custom domain from your Convex deployment when you no longer need it or want to switch to a different domain. This helps you manage your project's web presence and DNS configuration.

List Log Streams

View all log streaming destinations configured for your deployment, such as Datadog, Webhooks, Axiom, or Sentry integrations. Helps you understand where your application logs are being sent and manage your monitoring setup.

Create Project

Set up a new Convex project for your team with optional development or production deployments ready to use. This initializes your backend infrastructure so you can start building your application immediately.

List Projects

Retrieve all projects associated with a Convex team to get a complete inventory of your team's development projects and their current status.

Delete project

Permanently removes a Convex project and all its associated deployments and data. Use this when you're shutting down a project or cleaning up unused development environments.

Get Project by ID

Retrieve detailed information about a specific Convex project, including its name, slug, team association, and creation date. Use this to access project metadata and verify project configuration details.

Get Project by Slug

Retrieve your Convex project details using its human-readable slug identifier, making it easy to fetch project information without needing numeric IDs. This is useful when you need to programmatically access project configuration and settings for automation or integration purposes.

Execute Query Batch

Run multiple Convex queries simultaneously in a single request to fetch related data efficiently without making separate API calls. This reduces latency and simplifies data retrieval when you need information from several database queries at once.

Get Query Timestamp

Retrieves the current query timestamp from your Convex deployment, allowing you to synchronize data operations and track when queries were last executed. This helps ensure your application stays in sync with real-time database changes.