Sample - OpenAI API
POST/vaults

Create a vault

Creates a vault for the current project. See vaults.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 body fields
namestringoptional
The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.
metadataobjectoptional
Key-value pairs to associate with the vault, such as an application or team identifier.

8 status codes
201The created vault.
idstringrequired
The ID of the vault.
objectstringrequired
The object type. Always `vault`.
Allowed:vaultDefault:vault
namestringrequired
The human-readable name of the vault, if set.
metadataobjectrequired
Key-value pairs associated with the vault, such as an application or team identifier.
created_atintegerrequired
The Unix timestamp, in seconds, when the vault was created.
400The request was invalid.
errorobjectrequired
The error returned by the API.
401Authentication or project context was missing.
errorobjectrequired
The error returned by the API.
403The API key lacks the required management permission.
errorobjectrequired
The error returned by the API.
404The requested vault or credential was not found.
errorobjectrequired
The error returned by the API.
409The request conflicted with the current vault state.
errorobjectrequired
The error returned by the API.
500An internal error occurred.
errorobjectrequired
The error returned by the API.
503The service is temporarily unavailable.
errorobjectrequired
The error returned by the API.

Error handling

A 400 is returned: The request was invalid. A 401 is returned: Authentication or project context was missing. A 403 is returned: The API key lacks the required management permission. A 404 is returned: The requested vault or credential was not found. A 409 is returned: The request conflicted with the current vault state. A 500 is returned: An internal error occurred. A 503 is returned: The service is temporarily unavailable.