worker

Get a worker account

Changed on

Returns the account the worker maintains with the specified host for payment.

get/worker/account/{hostkey}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

hostkeystring required

A ed25519 public key

The host's public key

Response

Successfully retrieved worker account

idstring

The account's ID

cleanShutdownboolean

Whether the account has been cleanly shutdown. If not, the account will require a sync with the host.

hostKeystring

The host's public key

balancestring

The account's balance as expected by the worker

driftstring

The accumulated drift between the worker's expected balance and the host's actual balance. Used to track if a host is trying to cheat the renter over time.

ownerstring

The owner of the account that manages it. This is the id of the worker that maintains the account.

requiresSyncboolean

Whether the account requires a sync with the host. This is usually the case when the host reports insufficient balance for an account that the worker still believes to be funded.

Changes

  • fede87b22e1cRevision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • 922f156353c9Revision changes
    • info

      api tag worker added