Devices

List devices

get

Requires READ or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Query parameters

pageinteger · min: 1Optional

1-based page.

Default: 1

limitinteger · min: 1 · max: 5000Optional

Max items per page (devices).

Default: 5000

Responses

200

Success

application/json

403

Forbidden

application/json

500

Internal server error

application/json

get

/devices

HTTPcURLJavaScriptPython

GET /v0/devices HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "result": [
      {
        "deviceid": "text",
        "type": "text",
        "model": "text",
        "alias": "text",
        "firmware": "text",
        "serial_number": "text",
        "last_login": "2026-05-17T00:56:21.861Z",
        "creation_date": "2026-05-17T00:56:21.861Z",
        "sessions": 1,
        "device_status": "text",
        "battery_percentage": 1,
        "charging": true,
        "last_telemetry_at": "2026-05-17T00:56:21.861Z",
        "last_reported_latitude": 1,
        "last_reported_longitude": 1
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "has_more": true
    }
  }
}

Bind (create) device

post

Requires WRITE or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Body

application/json

typestringRequired

modelstringRequired

serial_numberstringRequired

aliasstringOptional

firmwarestringOptional

Responses

201

Device binded succesfully

application/json

400

Bad request

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal server error

application/json

post

/devices

HTTPcURLJavaScriptPython

POST /v0/devices HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "type": "CUSTOM_CHRONO",
  "model": "RUFUS_BOX_V1",
  "serial_number": "SN-123",
  "alias": "My timing device"
}

{
  "body": {
    "description": "text",
    "deviceid": "text",
    "already_binded": true
  }
}

Get device by id

get

Requires READ or READ_WRITE api key access type.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

deviceidstring · min: 8Required

Device identifier.

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/devices/{deviceid}

HTTPcURLJavaScriptPython

GET /v0/devices/{deviceid} HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "result": {
      "deviceid": "text",
      "type": "text",
      "model": "text",
      "alias": "text",
      "firmware": "text",
      "serial_number": "text",
      "last_login": "2026-05-17T00:56:21.861Z",
      "creation_date": "2026-05-17T00:56:21.861Z",
      "sessions": 1,
      "device_status": "text",
      "battery_percentage": 1,
      "charging": true,
      "last_telemetry_at": "2026-05-17T00:56:21.861Z",
      "last_reported_latitude": 1,
      "last_reported_longitude": 1,
      "passings": 1,
      "last_seen": "2026-05-17T00:56:21.861Z",
      "battery_volts": 1,
      "temperature_celsius": 1,
      "gps_accuracy_m": 1,
      "network_type": "text",
      "signal_strength": 1
    }
  }
}

Unbind (delete) device

delete

Requires an api key with allow_unbind=true.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

deviceidstring · min: 8Required

Device identifier.

Responses

200

Device unbinded succesfully

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal server error

application/json

delete

/devices/{deviceid}

HTTPcURLJavaScriptPython

DELETE /v0/devices/{deviceid} HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Accept: */*

{
  "body": {
    "description": "text",
    "deviceid": "text"
  }
}

Report device telemetry/status

patch

Requires WRITE or READ_WRITE api key access type.

Stale updates are ignored if reported_at is older than the current last_telemetry_at.

Authorizations

ApiKeyHeaderXApiKeyHeader

api_keystringRequired

API key for authentication.

Path parameters

deviceidstring · min: 8Required

Device identifier.

Body

application/json

At least one telemetry field is required.

reported_atstring · date-timeOptional

device_statusstringOptional

battery_percentageinteger · max: 100Optional

battery_voltsnumberOptional

chargingbooleanOptional

temperature_celsiusinteger · min: -100 · max: 200Optional

latitudenumber · min: -90 · max: 90Optional

longitudenumber · min: -180 · max: 180Optional

gps_accuracy_mnumberOptional

network_typestringOptional

signal_strengthinteger · min: -200 · max: 200Optional

Responses

200

Updated (or ignored if stale)

application/json

400

Bad request

application/json

403

Forbidden

application/json

404

Not found

application/json

413

Payload too large

application/json

500

Internal server error

application/json

patch

/devices/{deviceid}/status

HTTPcURLJavaScriptPython

PATCH /v0/devices/{deviceid}/status HTTP/1.1
Host: api.runonrufus.com
api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "reported_at": "2026-04-12T10:00:00.000Z",
  "device_status": "ONLINE",
  "battery_percentage": 87,
  "charging": true,
  "latitude": 12.3,
  "longitude": 13.4,
  "gps_accuracy_m": 10
}

{
  "body": {
    "description": "text",
    "deviceid": "text",
    "result": {
      "deviceid": "text",
      "last_telemetry_at": "2026-05-17T00:56:21.861Z",
      "device_status": "text",
      "battery_percentage": 1,
      "battery_volts": 1,
      "charging": true,
      "temperature_celsius": 1,
      "last_reported_latitude": 1,
      "last_reported_longitude": 1,
      "gps_accuracy_m": 1,
      "network_type": "text",
      "signal_strength": 1
    }
  }
}