Skip to main content
POST
/
api
/
v4
/
mining
/
watcher-links
/
create
Create Watcher Link
curl --request POST \
  --url https://whitebit.com/api/v4/mining/watcher-links/create \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "accounts": [
    "my_miner_01",
    "my_miner_02"
  ],
  "name": "monitoring_link",
  "permissions": [
    "dashboard",
    "workers"
  ],
  "liveUntil": "7d"
}
'
{
  "data": {
    "id": "abc123-external-id",
    "link": "https://whitebit.com/mining-pool/watcher-link/abc123-external-id",
    "liveUntil": 1709944800,
    "createdAt": 1709340000
  }
}

Authorizations

​
X-TXC-APIKEY
string
header
required

API key authentication using signed requests

Body

application/json
​
accounts
string[]
required

Array of mining account names

Minimum array length: 1
Maximum string length: 255
Example:
["my_miner_01", "my_miner_02"]
​
name
string
required

Link name. Accepts alphanumeric characters and underscores only (^[a-zA-Z0-9_]+$). An invalid format returns: {"code":0,"errors":{"name":["The name format is invalid."]},"message":"Validation failed"}.

Maximum string length: 255
Pattern: ^[a-zA-Z0-9_]+$
Example:

"monitoring_link"

​
permissions
enum<string>[]
required

Array of permissions

Required array length: 1 - 3 elements
Available options:
dashboard,
rewards,
workers
Example:
["dashboard", "workers"]
​
liveUntil
enum<string>
required

Expiration period

Available options:
1h,
24h,
7d,
always
Example:

"7d"

Response

Watcher link created successfully

​
data
object