Read the fault log

GET

/api/v1/faults

curl --request GET \
  --url 'http://pwrman.local/api/v1/faults?offset=0'

• Plain HTTP, the default
• HTTPS, once a certificate is installed and HTTPS is on

Eight entries per page, newest first.

Authorizations

• None
• token

Parameters

Query Parameters

offset

integer

0

How many of the newest entries to skip. Use 8 for the second page.

Responses

200

One page of the fault log.

Media typeapplication/json

object

available

required

This controller keeps a fault log.

boolean

count

required

Entries in the log.

integer

offset

required

integer

faults

required

Array<object>

<= 8 items

object

seq

required

Entry number; counts up for the life of the log.

integer

epoch

required

Unix time; 0 for entries logged before the controller knew the time.

integer

uptime_s

required

Seconds since the controller started.

integer

port

required

The port; 0 for chassis entries.

integer

<= 6

type

required

fault (a port fault), probe_fail (a blade did not answer when checked), boot (the controller started), bus (the input voltage went out of range or came back) or pd_reset (a USB PD reset).

string

Allowed values: fault probe_fail boot bus pd_reset

code

required

integer

arg

required

integer

power_w

required

The port’s output power at the time; 0 for boot.

number

contract_w

required

The port’s contract at the time; 0 for boot.

number

text

required

What happened, in words.

string

Example

{
  "available": true,
  "count": 4,
  "offset": 0,
  "faults": [
    {
      "seq": 41,
      "epoch": 1791255690,
      "uptime_s": 262840,
      "port": 4,
      "type": "fault",
      "code": 256,
      "arg": 0,
      "power_w": 26.4,
      "contract_w": 27,
      "text": "ocp"
    }
  ]
}

401

Auth_read is on and the token is missing or wrong.

Media typeapplication/json

object

error

required

Why the request was refused, in words.

string

Example

{
  "error": "bearer token required"
}