Skip to main content
GenieACS records a fault when a task fails during a CWMP session. Faults are keyed by device and channel. The default channel is default; task faults use the channel task_<task_id>.
See the fault management guide for a full explanation of the fault lifecycle and retry behaviour.

Query faults

GET /faults/?query=<query>
Returns all faults matching the given query.
query
string
A URL-encoded MongoDB-style JSON filter.
Get all faults for a device:
curl 'http://localhost:7557/faults/?query=%7B%22device%22%3A%22202BC1-BM632w-000000%22%7D'
Decoded query:
{"device": "202BC1-BM632w-000000"}

Delete a fault

DELETE /faults/<fault_id>
Deletes (clears) a fault record. The device will no longer be considered faulted on that channel.
fault_id
string
required
The fault ID in the format <device_id>:<channel>. The default channel is default.
curl -i 'http://localhost:7557/faults/202BC1-BM632w-000000:default' -X DELETE
Response: 200 OK on success. 503 Service Unavailable if the device is currently in a CWMP session.

Fault object structure

_id
string
required
Fault identifier in the format <device_id>:<channel> (e.g., 202BC1-BM632w-000000:default).
device
string
required
The ID of the device this fault belongs to.
channel
string
required
The fault channel. default for general faults; task_<task_id> for task-specific faults.
code
string
The TR-069 fault code or GenieACS internal error code.
message
string
Human-readable error message describing the fault.
timestamp
string
ISO 8601 timestamp of when the fault occurred.
retries
number
Number of times this fault has been retried.

Build docs developers (and LLMs) love