> SLA object

The following objects are directly related to the sla (Service Level Agreement) API.

SLA

The SLA object has the following properties.

PropertyTypeDescription
slaidstring(readonly) ID of the SLA.
name
(required)
stringName of the SLA.
period
(required)
integerReporting period of the SLA.

Possible values:
0 - daily;
1 - weekly;
2 - monthly;
3 - quarterly;
4 - annually.
slo
(required)
floatMinimum acceptable Service Level Objective expressed as a percent. If the Service Level Indicator (SLI) drops lower, the SLA is considered to be in problem/unfulfilled state.

Possible values: 0-100 (up to 4 fractional digits).
effective_dateintegerEffective date of the SLA.

Possible values: date timestamp in UTC.
timezone
(required)
stringReporting time zone, for example: Europe/London, UTC.

For the full list of supported time zones please refer to PHP documentation.
statusintegerStatus of the SLA.

Possible values:
0 - (default) enabled SLA;
1 - disabled SLA.
descriptionstringDescription of the SLA.

SLA Schedule

The SLA schedule object defines periods where the connected service(s) are scheduled to be in working order. It has the following properties.

PropertyTypeDescription
period_from
(required)
integerStarting time of the recurrent weekly period of time (inclusive).

Possible values: number of seconds (counting from Sunday).
period_to
(required)
integerEnding time of the recurrent weekly period of time (exclusive).

Possible values: number of seconds (counting from Sunday).

SLA excluded downtime

The excluded downtime object defines periods where the connected service(s) are scheduled to be out of working order, without affecting SLI, e.g. undergoing planned maintenance.

PropertyTypeDescription
name
(required)
stringName of the excluded downtime.
period_from
(required)
integerStarting time of the excluded downtime (inclusive).

Possible values: timestamp.
period_to
(required)
integerEnding time of the excluded downtime (exclusive).

Possible values: timestamp.

SLA service tag

The SLA service tag object links services to include in the calculations for the SLA. It has the following properties.

PropertyTypeDescription
tag
(required)
stringSLA service tag name.
operatorintegerSLA service tag operator.

Possible values:
0 - (default) equals;
2 - like
valuestringSLA service tag value.