Skip to Content

Setup key

Collecting the token with a short-lived key, after an install.

OperationKindHTTP
setup_key.checkcallGET /v1/setup-key
setup_key.claimcallPOST /v1/setup-key
setup_key.donecallDELETE /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

FieldTypeDescription
apiinteger
expiresstringWhen the key stops working, in RFC 3339.
versionstringThe version of rookery serve.

Errors

StatusWhen
401The 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

FieldTypeDescription
apiinteger
expiresstring
tokenstringThe token of rookery serve, as in its serve.token.
versionstring

Errors

StatusWhen
401The key is wrong, missing or expired
501This 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

FieldTypeDescription
okboolean

Errors

StatusWhen
401The key is wrong, missing or expired

Not on the portal: it is for a caller that has no token yet.

On this page