Skip to main content

Create vault

Create a vault that stores credentials. An empty object creates an anonymous vault.

Endpoint

POST /vaults Paths are relative to the Base URL. Send Authorization: Bearer $DASHSCOPE_API_KEY on every request. For authentication details, see Authentication.

Request body

name string (optional)Display name. 1–256 bytes after trimming. When omitted, the response returns null, an explicit null returns 400metadata object / null (optional)Metadata, string key-value pairs, up to 16 items; key 1–64 characters, value up to 512 characters. When omitted or null, the response is {}Creating an empty object {} generates an anonymous vault. The response name is null; no name is generated automatically.

Request example

curl -sS -X POST "$BASE_URL/vaults" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production-secrets",
    "metadata": {"team": "support"}
  }'

Response fields

201, returns a vault:id stringVault IDobject stringVault object type, fixed as vaultcreated_at integerCreation time in Unix secondsname string / nullDisplay namemetadata objectMetadata, string key-value pairs; {} when not set

Response example

{
  "id": "vlt_xxx",
  "object": "vault",
  "created_at": 1793941200,
  "name": "production-secrets",
  "metadata": {"team": "support"}
}

Error codes

For the error response structure, see Errors.
HTTP statusError type / codeSolution
400invalid_request_error / unknown_parameterRemove the unknown field
400invalid_request_error / invalid_typeFix the field type as described
400invalid_request_error / invalid_request_errorFix name or metadata as described
401authentication_error / invalid_api_keySend a valid Authorization: Bearer $DASHSCOPE_API_KEY header
409conflict_error / conflict_errorRetry later. If it keeps failing, submit a ticket with x-request-id
500server_error / server_errorRetry later. If it keeps failing, submit a ticket with x-request-id