Setup key
Collecting the token with a short-lived key, after an install.
| Operation | Kind | HTTP |
|---|---|---|
setup_key.check | call | GET /v1/setup-key |
setup_key.claim | call | POST /v1/setup-key |
setup_key.done | call | DELETE /v1/setup-key |
setup_key.check
Whether a setup key works, and the rookery serve it is for.
Not on the portal, because it is for a caller that has no token yet. It takes the setup key as the bearer, not the token or a role.
Result
| Field | Type | Description |
|---|---|---|
api | integer | |
expires | string | When the key stops working, in RFC 3339. |
version | string | The version of rookery serve. |
Errors
| Status | When |
|---|---|
| 401 | The key is wrong, missing or expired |
Not on the portal: it is for a caller that has no token yet.
setup_key.claim
Collect the server's token with a setup key. It can be asked again until the key is done.
Not on the portal, because it is for a caller that has no token yet. It takes the setup key as the bearer, not the token or a role.
Result
| Field | Type | Description |
|---|---|---|
api | integer | |
expires | string | |
token | string | The token of rookery serve, as in its serve.token. |
version | string |
Errors
| Status | When |
|---|---|
| 401 | The key is wrong, missing or expired |
| 501 | This rookery serve takes no token over the network |
Not on the portal: it is for a caller that has no token yet.
setup_key.done
End the setup key, once its user has the token.
Not on the portal, because it is for a caller that has no token yet. It takes the setup key as the bearer, not the token or a role.
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
Errors
| Status | When |
|---|---|
| 401 | The key is wrong, missing or expired |
Not on the portal: it is for a caller that has no token yet.