API section

Registers

Account registers: list with filters and pages, the register card (metrics, alerts, events), own name and on/off switch, register metrics.

GET	`/api/v1/devices/{id}`	Register card
PATCH	`/api/v1/devices/{id}`	Rename or disable a register
GET	`/api/v1/devices`	Account registers
GET	`/api/v1/devices/{id}/metrics`	Register metrics

Register card#

GET/api/v1/devices/{id}

The register, whether it is online, latest metric values for 7 days, open alerts and recent events

Parameters

Name	In	Type	Description
`id`required	path	integer int64	register number from `GET /api/v1/devices`
`events`	query	integer int32	How many recent events (1–500)

Response 200 application/json

Fields · DeviceDetail

idinteger int64
namestring
machineIdstring
agentVersionstring
osstring
createdAtstring date-time
lastSeenAtstring date-time
onlineboolean
metricsarray of MetricPoint
4 fields · MetricPoint
- atstring date-time
- namestring
- valuenumber double
- labelsstring
alertsarray of Alert
10 fields · Alert
- idinteger int64
- deviceIdinteger int64
- codestring
- subjectstring
- severitystring
- messagestring
- valuenumber double
- openedAtstring date-time
- updatedAtstring date-time
- closedAtstring date-time
eventsarray of EventView
4 fields · EventView
- atstring date-time
- typestring
- payloadobject
- deviceIdinteger int64
labelstring
disabledboolean

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/devices/42' \
  -H 'X-Api-Key: hwk_…'

Rename or disable a register#

PATCH/api/v1/devices/{id}

label — your own name (the agent does not overwrite it), disabled — switch off: commands and the proxy answer 403 DEVICE_DISABLED, receipts are not sent to it

Parameters

Name	In	Type	Description
`id`required	path	integer int64	register number from `GET /api/v1/devices`

Request body application/json required

Fields · DevicePatch

labelstring
from 0
to 200
disabledboolean

JSON

{
  "label": "string",
  "disabled": false
}

Response 200 application/json

Fields · DeviceView

idinteger int64
machineIdstring
namestring
agentVersionstring
osstring
lastSeenAtstring date-time
onlineboolean
labelstring
disabledboolean
openAlertsinteger int32

Errors — problem+json with a code field, see error codes.

Request example

curl

curl -X PATCH 'https://cloud.hw-connector.ru/api/v1/devices/42' \
  -H 'X-Api-Key: hwk_…' \
  -H 'Content-Type: application/json' \
  --data '{"label":"string","disabled":false}'

Account registers#

GET/api/v1/devices

Agent version, online now, last seen, open alerts. Filters — online, q (name, installation id), pages — limit/offset, total — in X-Total-Count

Parameters

Name	In	Type	Description
`online`	query	boolean	true — only online, false — only offline
`q`	query	string	Part of the name, own name or installation id
`limit`	query	integer int32
`offset`	query	integer int32

Response 200 application/json

Array · DeviceView

idinteger int64
machineIdstring
namestring
agentVersionstring
osstring
lastSeenAtstring date-time
onlineboolean
labelstring
disabledboolean
openAlertsinteger int32

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/devices' \
  -H 'X-Api-Key: hwk_…'

Register metrics#

GET/api/v1/devices/{id}/metrics

Values for the whole retention period, newest first; name — only this metric

Parameters

Name	In	Type	Description
`id`required	path	integer int64	register number from `GET /api/v1/devices`
`name`	query	string
`limit`	query	integer int32

Response 200 application/json

Array · MetricPoint

atstring date-time
namestring
valuenumber double
labelsstring

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/devices/42/metrics' \
  -H 'X-Api-Key: hwk_…'