Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
mode
enum<string>

Calculate

Available options:
downtime,
sla,
budget
slaPreset
enum<string>

Common tier

Available options:
99,
99.5,
99.9,
99.95,
99.99,
99.999,
custom
slaPct
number

SLA %

Required range: 0 <= x <= 100
targetDowntime
number

Max downtime

Required range: x >= 0
targetDowntimeUnit
enum<string>

Unit

Available options:
1,
60,
3600,
86400
targetPeriod
enum<string>

Per period

Available options:
31557600,
7889400,
2592000,
604800,
86400
budgetPeriod
enum<string>

Budget period

Available options:
31557600,
7889400,
2592000,
604800,
86400
elapsedDowntime
number

Downtime used so far

Required range: x >= 0
elapsedDowntimeUnit
enum<string>

Unit

Available options:
1,
60,
3600,
86400

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.