Clear the fault log

POST

/api/v1/faults/clear

const url = 'http://pwrman.local/api/v1/faults/clear';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://pwrman.local/api/v1/faults/clear \
  --header 'Authorization: Bearer <token>'

Authorizations

token

Responses

200

Done.

application/json

object

required

boolean

Example

{
  "ok": true
}

401

The token is missing or wrong, or no token is set yet.

application/json

object

error

required

Why the request was refused, in words.

string

Examples

{
  "error": "bearer token required"
}

{
  "error": "no API token set yet: finish first-time setup first"
}

500

The log could not be erased.

application/json

object

error

required

Why the request was refused, in words.

string

Example

{
  "error": "clear failed"
}

503

This controller has no fault log.

application/json

object

error

required

Why the request was refused, in words.

string

Example

{
  "error": "no fault log on this board"
}

USB Type-C® and USB-C® are registered trademarks of USB Implementers Forum.