POST /api/v2/secret-rotations/convex-access-key

v6

latestOpenAPI 3.0.32026-08-082,281012.1 MB

Secret Rotations

Create a Convex Access Key Rotation for the specified project.

post/api/v2/secret-rotations/convex-access-key

namestring required

The name of the Convex Access Key Rotation to create. Must be slug-friendly.

projectIdstring required

The ID of the project to create the rotation in.

descriptionstring nullable

An optional description for the Convex Access Key Rotation.

connectionIdstring uuid required

The ID of the Convex Connection to use for rotation.

environmentstring required

The slug of the project environment to create the rotation in.

secretPathstring required

The secret path of the project to create the rotation in.

isAutoRotationEnabledboolean

Whether secrets should be automatically rotated when the specified rotation interval has elapsed.

rotationIntervalnumber required

The interval, in days, to automatically rotate secrets.

Default Response