Skip to content

Runners

The runner, the open lokadb runner next to your proxy, that does the database work.

A one-time command to start a runner

POST /v1/accounts/{a}/runners/registrations

The token works once, for 30 minutes. The runner keeps its own secret afterwards.

Parameters

Name In Type Description
a (required) path string Your account's id (the panel's URL, or account in a move).

Responses

Status Description Body
201 The command. object
401 Unauthorized: No valid API key (or session). login_url is for the panel. Error
429 TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. Error
404 NotFound: No such object in your account (another account's ids answer the same). Error

List runners

GET /v1/accounts/{a}/runners

Parameters

Name In Type Description
a (required) path string Your account's id (the panel's URL, or account in a move).

Responses

Status Description Body
200 The runners. object
401 Unauthorized: No valid API key (or session). login_url is for the panel. Error
429 TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. Error
404 NotFound: No such object in your account (another account's ids answer the same). Error

Remove a runner

DELETE /v1/runners/{r}

The account's owner only, from the panel (an API key gets 403). Its secret stops working.

Parameters

Name In Type Description
r (required) path string

Responses

Status Description Body
204 Removed.
401 Unauthorized: No valid API key (or session). login_url is for the panel. Error
429 TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. Error
403 Forbidden: The account is pending (account_pending, activated by us after "request access"), suspended, or the route is the owner's, or the key is read-only. Error
404 NotFound: No such object in your account (another account's ids answer the same). Error