Create Vault
Updated at:
Creates a Vault for centrally storing and managing Credentials. The request body carries the display name and optional metadata; the response returns the complete Vault object.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
POST /vaults
Request body
| Field | Required | Type | Description |
|---|---|---|---|
display_name | Yes | string | Human-readable name of the Vault, 1–255 characters |
metadata | No | object | Custom key-value pairs for business metadata |
Request example
curl -X POST "$AGENTSTUDIO_URL/vaults" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"display_name": "production-keys",
"metadata": {
"environment": "production"
}
}'
Response example
{
"id": "vlt_xxx",
"type": "vault",
"display_name": "production-keys",
"metadata": {
"environment": "production"
},
"archived_at": null,
"created_at": "2026-06-20T10:00:00Z",
"updated_at": "2026-06-20T10:00:00Z"
}
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Vault ID, format vlt_xxx |
type | string | Always vault |
display_name | string | Human-readable name of the Vault |
metadata | object | Custom key-value pairs |
archived_at | string | null | Archive timestamp; null if not archived |
created_at | string | Creation time, ISO 8601 |
updated_at | string | Last update time, ISO 8601 |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid |
| 401 | InvalidApiKey | Invalid API key provided |
Is this page helpful?