Targets

POST /target-create-openai

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/target-create-openai
  • Auth
    none declared

Request body

api-keystring

API key for OpenAI

api-key-idstring

API key ID

codex-oauth-access-tokenstring

Codex OAuth access token (auth.json tokens.access_token), used when codex-oauth-mode=chatgpt_oauth

codex-oauth-account-idstring

Codex OAuth account id (auth.json tokens.account_id), used when codex-oauth-mode=chatgpt_oauth

codex-oauth-modestring

Auth mode: empty (default, static api-key) or chatgpt_oauth

codex-oauth-refresh-tokenstring

Codex OAuth refresh token (auth.json tokens.refresh_token), used when codex-oauth-mode=chatgpt_oauth

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the object

jsonboolean

Set output format to JSON

keystring

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)

lock-on-readstring

Lock this secret after each successful value read

lock-ttlstring

Lock TTL in minutes

max-versionsstring

Set the maximum number of versions, limited by the account settings defaults.

modelstring

Default model to use with OpenAI

namestring required

Target name

openai-urlstring

Base URL of the OpenAI API

organization-idstring

Organization ID

rotate-on-unlockstring

Rotate this secret after it is unlocked

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

targetCreateOpenAIResponse wraps response body.

target_idinteger

Changes

No recorded changes to this operation across all 1 revision of this API.