Convex

Cancel a pending team invitation

Create custom domain

Creates a new custom role for the team with the specified name, description, and permission statements.

Create a deploy key like "dev:happy-animal-123|ey..." which can be used with the Convex CLI to develop against or deploy code. When access to the deployment is granted through an OAuth token this deploy key will use the same OAuth-granted token. When access to the deployment is granted any other way a new token will be created which grants access only to this deployment.

Create a new deployment for a project.

Creates a new personal access token for the authenticated user.

Create a preview deploy key like "preview:team-slug:project-slug|ey..." which can be used with the Convex CLI to create and manage preview deployments within the project. When access to the project is granted through an OAuth token this preview deploy key will use the same OAuth-granted token. When access to the project is granted any other way a new token scoped to preview deployments in this project will be created.

Create a new project on a team, optionally provisioning a dev or prod deployment.

Create a team

Create a team access token

Remove a custom domain from a deployment.

Deletes a custom role from the team. Fails with `CustomRoleInUse` if the role is still attached to any team members; reassign those members (e.g. via `update_team_member_role`) before retrying.

Deletes a deploy key for the specified deployment. The `id` in the request body can be the full deploy key (with prefix), encoded token, or the name of the deploy key.

Delete a deployment. This will delete all data and files in the deployment, so we recommend creating and downloading a backup before calling this endpoint. This does not delete the project itself.

Deletes a personal access token for the authenticated user. The `id` in the request body can be the encoded token secret or the name of the token.

Deletes a preview deploy key for the specified project. The `id` in the request body can be the full preview deploy key (with prefix), encoded token, or the name of the preview deploy key.

Delete a project. Deletes all deployments in the project as well.

Deletes a team access token, identified by its secret value or name.

Get a deployment within a project by reference, default production deployment, or default dev deployment for the calling user.

Get a deployment within a project identified by team and project slug, by reference, default production deployment, or default dev deployment for the calling user.

Get a project by its ID.

Get a project by its slug.

Returns the team ID for team tokens. Especially useful after receiving a team token from an OAuth flow since most endpoints require team ID.

Invite a member to the given team by email. `role` is required and must be one of `admin`, `developer`, or `custom`. Pass `custom` together with a non-empty `customRoles` list to invite a member into a custom role; for `admin` and `developer`, `customRoles` must be omitted.

List a team's audit log events within a time range, with optional filters.

Get all custom domains configured for a deployment.

Lists all custom roles for the team with cursor-based pagination.

Lists all default environment variables for the specified project, with optional filtering by name and deployment type.

Lists all deploy keys for the specified deployment.

Lists the available deployment classes for a team.

Lists the available deployment regions for a team.

List deployments for a projects.

Lists deployments for a team with pagination, sorting, and filtering.

Lists the local deployments for a team.

List the pending invitations for the given team.

Lists all personal access tokens for the authenticated user.

Lists all preview deploy keys for the specified project.

List a page of projects for a team, ordered by descending project ID. Pass `limit` to set the page size and the `nextCursor` from the previous response as `cursor` to fetch the next page.

Lists the team access tokens created by the authenticated member for the given team.

List the members of the given team.

Get details about a cloud deployment.

Transfer a deployment from its current project to another project within the same team. For production deployments, the caller must be a project admin on both the source and destination projects. For other deployment types, any team member can transfer deployments they created, or project admins can transfer any deployment.

Updates an existing custom role's name, description, and permission statements.

Creates, updates, or deletes default environment variables for the specified project. When `value` is a string, the variable is upserted. When `value` is null, the variable is deleted.

Updates properties of an existing deployment. Only the fields provided in the request body are modified; omitted fields are left unchanged.

Update a project's name and/or slug. Returns the updated project.

Sets either the member's built-in `role` (admin/developer) or their `customRoles`. The two fields are mutually exclusive: setting `role` clears `customRoles`, and setting `customRoles` (must be non-empty) puts the member in the `custom` role.