Forward API reference.
Description
Creates a Vault and sets its metadata.
Path
POST /api/v1/forward/vaults
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Idempotency-Key | No | Optional idempotency key for create requests. The same key can only be reused for the same request. If omitted, local idempotent replay protection is not provided. |
Content-Type | Yes | application/json |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
display_name | string | Yes | Vault Display name. |
metadata | object | No | Metadata object. created_by is reserved and must not be supplied (supplying it returns 400). |
Example request
Example response
HTTP 201 Created
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Vault ID. |
type | string | Always vault. |
display_name | string | Vault Display name. |
metadata | object | Vault Metadata. |
created_at | string | Creation time in RFC 3339 format. |
updated_at | string | Last update time in RFC 3339 format. |
identity_id | string/null | Forward identity owner. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or query parameters are invalid. |
| 400 | invalid_request_error | If the reserved key created_by is supplied, message is metadata key "created_by" is reserved, identifying the invalid field. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | The caller cannot access this resource. |
| 409 | conflict_error | The resource state, references, or idempotency key conflict. |
| 500/502/503 | api_error | Forward or a dependent service failed. |