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