Vaults
Create Vault
Create a new Vault
Request
POST /vaults
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Name of vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
description | string | description of Vault |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | identifier for Vault |
uri | string | URI of this Vault API resource |
created_at | string | Timestamp when the Vault was created (RFC 3339 format) |
updated_at | string | Timestamp when the Vault was last updated (RFC 3339 format) |
name | string | Name of vault |
description | string | description of Vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
created_by | string | Reference to who created this Vault |
last_updated_by | string | Reference to who created this Vault |
Update Vault
Update an existing Vault by ID
Request
PATCH /vaults/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | identifier for Vault |
name | string | Name of vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
description | string | description of Vault |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | identifier for Vault |
uri | string | URI of this Vault API resource |
created_at | string | Timestamp when the Vault was created (RFC 3339 format) |
updated_at | string | Timestamp when the Vault was last updated (RFC 3339 format) |
name | string | Name of vault |
description | string | description of Vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
created_by | string | Reference to who created this Vault |
last_updated_by | string | Reference to who created this Vault |
Delete Vault
Delete a Vault
Request
DELETE /vaults/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Vault
Get a Vault by ID
Request
GET /vaults/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | identifier for Vault |
uri | string | URI of this Vault API resource |
created_at | string | Timestamp when the Vault was created (RFC 3339 format) |
updated_at | string | Timestamp when the Vault was last updated (RFC 3339 format) |
name | string | Name of vault |
description | string | description of Vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
created_by | string | Reference to who created this Vault |
last_updated_by | string | Reference to who created this Vault |
List Vaults
List all Vaults owned by account
Request
GET /vaults
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
vaults | Vault | The list of Vaults for this account |
uri | string | |
next_page_uri | string | URI of the next page of results, or null if there is no next page |
Vault fields
| Name | Type | Description |
|---|---|---|
id | string | identifier for Vault |
uri | string | URI of this Vault API resource |
created_at | string | Timestamp when the Vault was created (RFC 3339 format) |
updated_at | string | Timestamp when the Vault was last updated (RFC 3339 format) |
name | string | Name of vault |
description | string | description of Vault |
metadata | string | Arbitrary user-defined metadata for this Vault |
created_by | string | Reference to who created this Vault |
last_updated_by | string | Reference to who created this Vault |