api/docs/vault/info.md

26 lines
819 B
Markdown

# `/vault/info` - GET
Returns status information about the vault.
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|--------------|--------------------------------------------|
| max_storage | The maximum amount of space in the vault. |
| free_storage | The amount of free space in the vault. |
### 400 - Error: Bad Request
The request was malformed.
### 401 - Error: Unauthorized
The provided auth token doesn't allow you to perform this operation.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The authorized user has no vault.
This can be fixed with a `/vault/init` call.