Skip to content
synpute

Monitoring

Create a covenant

Preview

Add a monitored covenant to a facility. A breach opens an alert and fires covenant.breached.

post/v1/facilities/{facility_id}/covenants

Path parameters

facility_idSynpute IDrequired
Facility ID e.g. SYN-FC-5D20

Body parameters

metricstringrequired
Metric
uptime_pctutilization_pctpayment_days_latecontract_coverage_months
thresholdobjectrequired
Breach rule
+Show properties
operatorstring
Comparison
ltltegtgte
valuenumber
Threshold
windowstring
Window
weekmonthquarter

Response 201 · Covenant

facilitySynpute IDrequired
Facility
idstringrequired
Covenant ID
metricstringrequired
What's measured
uptime_pctutilization_pctpayment_days_latecontract_coverage_months
objectstringrequired
Object type
statusstringrequired
Current state
in_compliancebreachedcured
thresholdobjectrequired
Breach rule
+Show properties
operatorstring
Comparison
ltltegtgte
valuenumber
Threshold
windowstring
Measured over
weekmonthquarter

Errors

400404return the standard error shape.