Fault Rules

Retrieve Fault Rule

Retrieve the details of an existing FaultRule.

get/fault_rules/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
codestring required

The diagnostic trouble code.

descriptionstring nullable required

A short description about the problem.

priority_handling'off' | 'ignore' | 'critical' nullable required

The priority handling for the alert. This is configurable through the Fleetio dashboard under Fault Rules.

namestring nullable required

A short name for the alert.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.