Fetch in-depth information about a single SLA

client.slas.retrieve(, ?): SlaRetrieveResponse { description, name, urn, 2 more }

GET/v1/slas/{urn}

ParametersExpand Collapse

urn: string

ReturnsExpand Collapse

SlaRetrieveResponse { description, name, urn, 2 more }

description: string

A description of the SLA

name: string

The name of the SLA

urn: string

A unique identifier for the SLA

vendor_urn: string

A unique identifier for the vendor associated with the SLA

sla_details?: APIUptimeSlaDetails { measurement_period_unit, measurement_period_value, tiers, sla_type } | APITimeUnderSlaDetails { measurement_period_unit, measurement_period_value, tiers, sla_type } | null

The SLA tier configuration details, including type and credit tiers. Null if the SLA does not have incident-based tier rules configured.

Accepts one of the following:

APIUptimeSlaDetails { measurement_period_unit, measurement_period_value, tiers, sla_type }

measurement_period_unit: string

The duration unit of the measurement interval (e.g. DAY, MONTH, QUARTER, YEAR)

measurement_period_value: number

The number of measurement period units (e.g. 1 for a single calendar quarter)

tiers: Array<Tier>

The credit tiers of the SLA, ordered by availability percentage

availability_percentage: number

The availability percentage threshold for the tier, modeled as a float between 0 and 1 (e.g. 0.999 is 99.9% availability)

credit_unit: string

The unit of the credit value (e.g. PERCENT or DAY)

credit_value: number

The credit value for the tier (e.g. 0.5 for 50% credit)

sla_type?: "UPTIME"

The type of SLA

APITimeUnderSlaDetails { measurement_period_unit, measurement_period_value, tiers, sla_type }

measurement_period_unit: string

The duration unit of the measurement interval (e.g. MONTH, QUARTER)

measurement_period_value: number

The number of measurement period units (e.g. 1 for a single calendar quarter)

tiers: Array<Tier>

The credit tiers of the SLA, ordered by availability percentage

availability_percentage: number

The availability percentage threshold for the tier, modeled as a float between 0 and 1 (e.g. 0.999 is 99.9% availability)

credit_unit: string

The unit of the credit value (e.g. PERCENT, DAY, or HOUR)

credit_value: number

The credit value for the tier (e.g. 0.5 for 50% credit)

per_unit: string

The 'per' unit for the time under calculation (e.g. PERCENT or HOUR)

per_value: number

The 'per' value for the time under calculation (e.g. 5% per each 1% below threshold)

sla_type?: "TIME_UNDER"

The type of SLA

Fetch in-depth information about a single SLA

import Clarative from 'clarative';

const client = new Clarative({
  apiKey: process.env['CLARATIVE_API_KEY'], // This is the default and can be omitted
});

const sla = await client.slas.retrieve('urn');

console.log(sla.description);

{
  "description": "description",
  "name": "name",
  "urn": "urn",
  "vendor_urn": "vendor_urn",
  "sla_details": {
    "measurement_period_unit": "measurement_period_unit",
    "measurement_period_value": 0,
    "tiers": [
      {
        "availability_percentage": 0,
        "credit_unit": "credit_unit",
        "credit_value": 0
      }
    ],
    "sla_type": "UPTIME"
  }
}

Returns Examples

{
  "description": "description",
  "name": "name",
  "urn": "urn",
  "vendor_urn": "vendor_urn",
  "sla_details": {
    "measurement_period_unit": "measurement_period_unit",
    "measurement_period_value": 0,
    "tiers": [
      {
        "availability_percentage": 0,
        "credit_unit": "credit_unit",
        "credit_value": 0
      }
    ],
    "sla_type": "UPTIME"
  }
}