Unseal System
This API submits a key share to unseal the system. The system is only unsealed once the number of submitted shares reaches the configured threshold.
Endpoint Details
| URL | /v1/sys/unseal |
| Method | POST |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Body
Use the following format to make a request:
JSON Request
{
"share": "015ca015d04d74ed301d5795c179a33ab869712d8d38baad3f430ba69dad1d668a"
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| share | String | One of the key shares used to unseal the system |
Response
Each request submits one key share. The response reports how many shares have been submitted so far against the threshold.
First share submitted:
Response
{
"sealed": true,
"shares_given": 1,
"threshold": 3
}
Second share submitted (a different key):
Response
{
"sealed": true,
"shares_given": 2,
"threshold": 3
}
Final share submitted (threshold reached, the system is unsealed):
Response
{
"shares_given": 3,
"threshold": 3
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| sealed | Boolean | Indicates whether the system is still sealed after submitting the share |
| shares_given | Integer | Number of key shares that have been submitted so far |
| threshold | Integer | Number of key shares required to unseal the system |
info
- A valid Bearer Token is required to access this endpoint.
- Each request submits a single
share. Submit the endpoint repeatedly with a different key share each time. - The system remains sealed (
sealed: true) untilshares_givenreaches thethreshold. - Once the number of submitted shares equals the
threshold, the system is unsealed and thesealedfield is no longer returned. - The
threshold(the number of shares required) is configured during the initial setup of the system.