Create

cURL

curl --request POST \
  --url https://us.infisical.com/api/v2/secret-rotations/openai-service-account \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "projectId": "<string>",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "<string>",
  "secretPath": "<string>",
  "rotationInterval": 2,
  "parameters": {
    "projectId": "<string>",
    "name": "<string>"
  },
  "secretsMapping": {
    "apiKey": "<string>"
  },
  "description": "<string>",
  "isAutoRotationEnabled": true
}
'

import requests

url = "https://us.infisical.com/api/v2/secret-rotations/openai-service-account"

payload = {
    "name": "<string>",
    "projectId": "<string>",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment": "<string>",
    "secretPath": "<string>",
    "rotationInterval": 2,
    "parameters": {
        "projectId": "<string>",
        "name": "<string>"
    },
    "secretsMapping": { "apiKey": "<string>" },
    "description": "<string>",
    "isAutoRotationEnabled": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    projectId: '<string>',
    connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    environment: '<string>',
    secretPath: '<string>',
    rotationInterval: 2,
    parameters: {projectId: '<string>', name: '<string>'},
    secretsMapping: {apiKey: '<string>'},
    description: '<string>',
    isAutoRotationEnabled: true
  })
};

fetch('https://us.infisical.com/api/v2/secret-rotations/openai-service-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.infisical.com/api/v2/secret-rotations/openai-service-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'projectId' => '<string>',
    'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'environment' => '<string>',
    'secretPath' => '<string>',
    'rotationInterval' => 2,
    'parameters' => [
        'projectId' => '<string>',
        'name' => '<string>'
    ],
    'secretsMapping' => [
        'apiKey' => '<string>'
    ],
    'description' => '<string>',
    'isAutoRotationEnabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.infisical.com/api/v2/secret-rotations/openai-service-account"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v2/secret-rotations/openai-service-account")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v2/secret-rotations/openai-service-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "secretRotation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "rotationInterval": 123,
    "rotationStatus": "<string>",
    "lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
    "lastRotatedAt": "2023-11-07T05:31:56Z",
    "connection": {
      "app": "openai",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "environment": {
      "slug": "<string>",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "projectId": "<string>",
    "folder": {
      "id": "<string>",
      "path": "<string>"
    },
    "rotateAtUtc": {
      "hours": 11.5,
      "minutes": 29.5
    },
    "type": "openai-service-account",
    "parameters": {
      "projectId": "<string>",
      "name": "<string>"
    },
    "secretsMapping": {
      "apiKey": "<string>"
    },
    "description": "<string>",
    "isAutoRotationEnabled": true,
    "activeIndex": 0,
    "lastRotationJobId": "<string>",
    "nextRotationAt": "2023-11-07T05:31:56Z",
    "isLastRotationManual": true,
    "lastRotationMessage": "<string>"
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

POST

api

secret-rotations

openai-service-account

cURL

curl --request POST \
  --url https://us.infisical.com/api/v2/secret-rotations/openai-service-account \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "projectId": "<string>",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "<string>",
  "secretPath": "<string>",
  "rotationInterval": 2,
  "parameters": {
    "projectId": "<string>",
    "name": "<string>"
  },
  "secretsMapping": {
    "apiKey": "<string>"
  },
  "description": "<string>",
  "isAutoRotationEnabled": true
}
'

import requests

url = "https://us.infisical.com/api/v2/secret-rotations/openai-service-account"

payload = {
    "name": "<string>",
    "projectId": "<string>",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment": "<string>",
    "secretPath": "<string>",
    "rotationInterval": 2,
    "parameters": {
        "projectId": "<string>",
        "name": "<string>"
    },
    "secretsMapping": { "apiKey": "<string>" },
    "description": "<string>",
    "isAutoRotationEnabled": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    projectId: '<string>',
    connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    environment: '<string>',
    secretPath: '<string>',
    rotationInterval: 2,
    parameters: {projectId: '<string>', name: '<string>'},
    secretsMapping: {apiKey: '<string>'},
    description: '<string>',
    isAutoRotationEnabled: true
  })
};

fetch('https://us.infisical.com/api/v2/secret-rotations/openai-service-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.infisical.com/api/v2/secret-rotations/openai-service-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'projectId' => '<string>',
    'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'environment' => '<string>',
    'secretPath' => '<string>',
    'rotationInterval' => 2,
    'parameters' => [
        'projectId' => '<string>',
        'name' => '<string>'
    ],
    'secretsMapping' => [
        'apiKey' => '<string>'
    ],
    'description' => '<string>',
    'isAutoRotationEnabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.infisical.com/api/v2/secret-rotations/openai-service-account"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v2/secret-rotations/openai-service-account")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v2/secret-rotations/openai-service-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rotationInterval\": 2,\n  \"parameters\": {\n    \"projectId\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"secretsMapping\": {\n    \"apiKey\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoRotationEnabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "secretRotation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "rotationInterval": 123,
    "rotationStatus": "<string>",
    "lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
    "lastRotatedAt": "2023-11-07T05:31:56Z",
    "connection": {
      "app": "openai",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "environment": {
      "slug": "<string>",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "projectId": "<string>",
    "folder": {
      "id": "<string>",
      "path": "<string>"
    },
    "rotateAtUtc": {
      "hours": 11.5,
      "minutes": 29.5
    },
    "type": "openai-service-account",
    "parameters": {
      "projectId": "<string>",
      "name": "<string>"
    },
    "secretsMapping": {
      "apiKey": "<string>"
    },
    "description": "<string>",
    "isAutoRotationEnabled": true,
    "activeIndex": 0,
    "lastRotationJobId": "<string>",
    "nextRotationAt": "2023-11-07T05:31:56Z",
    "isLastRotationManual": true,
    "lastRotationMessage": "<string>"
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Check out the configuration docs for OpenAI Service Account Rotations to learn how to obtain the required parameters.

Creates an OpenAI Service Account secret rotation. Infisical will create and rotate project service accounts via your OpenAI connection and write their API keys to the specified secret path.

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.

Sample request

curl --request POST \
  --url https://us.infisical.com/api/v2/secret-rotations/openai-service-account \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --data '{
    "name": "my-openai-rotation",
    "projectId": "<project-id>",
    "description": "OpenAI service account rotation",
    "connectionId": "<openai-connection-id>",
    "environment": "dev",
    "secretPath": "/",
    "isAutoRotationEnabled": true,
    "rotationInterval": 30,
    "rotateAtUtc": { "hours": 0, "minutes": 0 },
    "parameters": {
      "projectId": "proj_abc123",
      "name": "my-app-service-account"
    },
    "secretsMapping": {
      "apiKey": "OPENAI_API_KEY"
    }
  }'

Sample response

{
  "secretRotation": {
    "id": "<rotation-id>",
    "name": "my-openai-rotation",
    "description": "OpenAI service account rotation",
    "secretsMapping": { "apiKey": "OPENAI_API_KEY" },
    "isAutoRotationEnabled": true,
    "activeIndex": 0,
    "connectionId": "<openai-connection-id>",
    "rotationInterval": 30,
    "rotateAtUtc": { "hours": 0, "minutes": 0 },
    "type": "openai-service-account",
    "parameters": {
      "projectId": "proj_abc123",
      "name": "my-app-service-account"
    }
  }
}

Body

application/json

name

string

required

The name of the OpenAI Service Account Rotation to create. Must be slug-friendly.

Required string length: 1 - 64

projectId

string

required

The ID of the project to create the rotation in.

Minimum string length: 1

connectionId

string<uuid>

required

The ID of the OpenAI Connection to use for rotation.

environment

string

required

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

Required string length: 1 - 64

secretPath

string

required

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

Minimum string length: 1

rotationInterval

number

required

The interval, in days, to automatically rotate secrets.

Required range: x >= 1

parameters

object

required

Show child attributes

secretsMapping

object

required

Show child attributes

description

string | null

An optional description for the OpenAI Service Account Rotation.

Maximum string length: 256

isAutoRotationEnabled

boolean

default:true

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

rotateAtUtc

object

The hours and minutes rotation should occur at in UTC. Defaults to Midnight (00:00) UTC.

Show child attributes

Response

Default Response

secretRotation

object

required

Show child attributes

Update Delete

Overview

Organization

Project

Shared

Identity Auth

Secrets Management

Certificate Management

Secret Scanning

Secret Sharing

Infisical KMS

KMIP Servers

Gateways

External Migrations

Other

Request body

Sample request

Sample response

Body

Response

​Request body

​Sample request

​Sample response

Body

Response

Request body

Sample request

Sample response