Check out the configuration docs for Supabase API Key Rotations to learn how to obtain the required parameters.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A unique name for the rotation (max 100 characters). |
projectId | string (UUID) | Yes | The project ID. |
connectionId | string (UUID) | Yes | ID of the Supabase app connection. |
environment | string | Yes | Environment slug (e.g. dev, prod). |
secretPath | string | Yes | Path where the generated API key secret will be stored. |
isAutoRotationEnabled | boolean | No | Whether to rotate automatically on the schedule. Defaults to true. |
rotationInterval | number | Yes | Days between rotations (minimum 1). |
rotateAtUtc | object | No | Time of day (UTC) to run rotation: { "hours", "minutes" }. Defaults to { "hours": 0, "minutes": 0 }. |
parameters.projectRef | string | Yes | The reference ID of the Supabase project to rotate the API key for. |
parameters.keyType | string | Yes | The type of the API key to rotate: "publishable" or "secret". |
secretsMapping.apiKey | string | Yes | Secret key name to store the generated API key (e.g. SUPABASE_SECRET_API_KEY). |
description | string | No | Optional description. |