Sign in
App Connections

Create a Convex Connection.

post/api/v1/app-connections/convex

Request body

method'personal-access-token' required

The method used to authenticate with Convex.

namestring required

The name of the Convex Connection to create. Must be slug-friendly.

descriptionstring nullable

An optional description for the Convex Connection.

projectIdstring

The ID of the project to create the Convex Connection in.

isPlatformManagedCredentialsfalse

Not supported for Convex Connections.

gatewayId'null' nullable

Not supported for Convex Connections.

gatewayPoolId'null' nullable

Not supported for Convex Connections.

isAutoRotationEnabledfalse

Not supported for Convex Connections.

rotation'null' nullable

Not supported for Convex Connections.

Response

Default Response

Changes

No recorded changes to this endpoint across all 22 revisions of this API.