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 bodynamestring (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 |
Response fields201, 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 |
Error codes
For the error response structure, see Errors.
| HTTP status | Error type / code | Solution |
|---|---|---|
400 | invalid_request_error / unknown_parameter | Remove the unknown field |
400 | invalid_request_error / invalid_type | Fix the field type as described |
400 | invalid_request_error / invalid_request_error | Fix name or metadata as described |
401 | authentication_error / invalid_api_key | Send a valid Authorization: Bearer $DASHSCOPE_API_KEY header |
409 | conflict_error / conflict_error | Retry later. If it keeps failing, submit a ticket with x-request-id |
500 | server_error / server_error | Retry later. If it keeps failing, submit a ticket with x-request-id |