Vault
6 routes. Paths are relative to https://api.intersink.com/v1.
- GET/vault/itemsMy vault items: metadata only, never the password (paged)
- POST/vault/itemsSave a password (encrypted at rest)
- GET/vault/items/{id}One vault item's metadata (no password)
- PATCH/vault/items/{id}Edit a vault item (a new password is re-encrypted)
- DELETE/vault/items/{id}Delete a vault item
- POST/vault/items/{id}/revealReturn the decrypted password (10/min, written to the security log)
My vault items: metadata only, never the password (paged)
GET/vault/items
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| q | string, query | At most 200 characters. |
| channel_id | string, query | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1. |
Response
200. The payload in data is not described in the spec yet.
Save a password (encrypted at rest)
POST/vault/items
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| labelrequired | string | At most 200 characters. Example: "Stripe Dashboard" |
| username | string | At most 255 characters. Example: "billing@example.com" |
| passwordrequired | string | At most 1024 characters. Example: "correct horse battery staple" |
| url | string | Checked by the server against /^(|https?:\/\/[^\s]{1,2040})$/i. Example: "https://dashboard.stripe.com" |
| notes | string | At most 2000 characters. |
| channel_id | string |
Response
201. The payload in data is not described in the spec yet.
One vault item's metadata (no password)
GET/vault/items/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Edit a vault item (a new password is re-encrypted)
PATCH/vault/items/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| label | string | At most 200 characters. |
| username | string | At most 255 characters. |
| password | string | At most 1024 characters. |
| url | string | Checked by the server against /^(|https?:\/\/[^\s]{1,2040})$/i. |
| notes | string | At most 2000 characters. |
| channel_id | string |
Response
200. The payload in data is not described in the spec yet.
Delete a vault item
DELETE/vault/items/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Return the decrypted password (10/min, written to the security log)
POST/vault/items/{id}/reveal
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.