Skip to main content

Core Concepts

Workspace

A workspace is the top-level organizational unit in Nonce. It contains all your farms, miners, and configurations.
  • Each workspace has a unique workspace_id (format: org_xxxxxxxxxxxxxxxxxxxxxxxxxxx)
  • API keys are scoped to a specific workspace

Farm

A farm represents a physical or logical grouping of miners.
  • Each farm has a unique farm_id (UUID format)
  • Farms belong to a single workspace
  • Metrics and tasks are organized at the farm level

Miner

A miner represents an individual mining device.
  • Each miner has a unique miner_id
  • Miners belong to a single farm
  • Miner data includes hashrate, power consumption, temperature, and status …

Agent

An agent is a software component that communicates between your mining hardware and the Nonce platform.
  • Agents are registered to a farm
  • Each agent can manage multiple miners in specific farm

Task

A task is an operation performed on a miner. Tasks are created and dispatched in task batches.
  • Creating tasks via the API always creates a task batch; the system generates one task per target miner
  • Common task types include log collection, power mode changes, and pool updates

Tasks Documentation

Learn more about task types, parameters, and statuses

Actor

An actor represents an entity that performs actions in the system. Actors are used to track who created or modified resources.
  • Three actor types: user, apikey, and system
  • Used in audit trails and task batch tracking

Actor Documentation

Learn more about actors and action tracking

Common Parameters

Pagination

Most list endpoints support pagination: