Vaults¶
create¶
HTTP Request
POST https://api.solvebio.com/v2/vaults
Parameters
This request does not accept URL parameters.
Authorization
All users can create new vaults.
Request Body
In the request body, provide a single Vault resource.
Property | Value | Description |
---|---|---|
name | string | The name of the vault. This must be unique to your account domain. |
description | string | (Optional) The description of the vault. |
metadata | object | (Optional) A dictionary of key/value pairs. |
tags | string | (Optional) A list of strings to organize the vault. |
default_storage_class | string | (Optional) The default dataset storage class to apply to any datasets created |
Response
The response contains a single Vault resource.
list¶
HTTP Request
GET https://api.solvebio.com/v2/vaults
Parameters
This request accepts the following parameters:
Parameter | Value | Description |
---|---|---|
id | integer | The ID to filter on. |
vault_type | integer | The vault_type to filter on. Possible values are "personal" and "general". |
name | text | The name of the vault. |
provider | text | The provider of the vault. Currently always equal to "SolveBio". |
tags | text | A string representing a single vault tag. Matching vaults must have this tag set. |
account_id | integer | The ID of the account that created this vault. |
user_id | integer | The ID of the user that created this vault. |
exclude_group_id | integer | A group ID to exclude when calculating the current user's permissions for the filtered vaults. |
storage_class | string | Returns vaults with this default dataset storage class |
Authorization
All public vaults are included in this response. If the request is sent by an authenticated user, vaults which the user has "read" permission or higher on are also returned.
Request Body
Do not supply a request body with this method.
Response
The response returns a list of vaults matching the provided filters.
update¶
HTTP Request
PUT https://api.solvebio.com/v2/vaults/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with "write" permission or higher on the vault.
Request Body
In the request body, provide a valid Vault object (see create above).
Response
The response contains the updated Vault resource.
delete¶
HTTP Request
DELETE https://api.solvebio.com/v2/vaults/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with "admin" permission on the vault.
Request Body
Do not supply a request body with this method.
Response
The response returns "HTTP 200 OK" when successful.
get¶
HTTP Request
GET https://api.solvebio.com/v2/vaults/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with "read" permission or higher on the vault.
Request Body
Do not supply a request body with this method.
Response
The response contains a Vault resource.