Check out the configuration docs for OpenAI Service Account 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 OpenAI app connection (Admin API key). |
environment | string | Yes | Environment slug (e.g. dev, prod). |
secretPath | string | Yes | Path where the generated API key secret will be stored. |
isAutoRotationEnabled | boolean | Yes | Whether to rotate automatically on the schedule. |
rotationInterval | number | Yes | Days between rotations (e.g. 30). |
rotateAtUtc | object | Yes | Time of day (UTC) to run rotation: { "hours", "minutes" }. |
parameters.projectId | string | Yes | ID of the OpenAI project to create service accounts in (e.g. proj_abc123). Cannot be changed after creation. |
parameters.name | string | Yes | Name for the generated service account in OpenAI (max 100 characters). |
secretsMapping.apiKey | string | Yes | Secret key name to store the generated API key (e.g. OPENAI_API_KEY). |
description | string | No | Optional description. |