Get the SLO definitions

GET /s/{spaceId}/internal/observability/slos/_definitions
Api key auth Basic auth

You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

Path parameters

  • spaceId string Required

    An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.

Query parameters

  • includeOutdatedOnly boolean

    Indicates if the API returns only outdated SLO or all SLO definitions

  • tags string

    Specify which SLO tags to query by (comma-separated list)

  • page number

    The page to use for pagination, must be greater or equal than 1

  • perPage integer

    Number of SLOs returned by page

    Maximum value is 1000. Default value is 100.

Responses

  • 200 application/json

    Successful request

    A paginated response of SLO definitions matching the query.

    One of:
    object-1 object object-2 object
    Hide attributes Show attributes
    • page number
    • perPage number
    • results array[object]
      Hide results attributes Show results attributes object
      • budgetingMethod string Required

        The budgeting method to use when computing the rollup data.

        Values are occurrences or timeslices.

      • createdAt string Required

        The creation date

      • description string Required

        The description of the SLO.

      • enabled boolean Required

        Indicate if the SLO is enabled

      • groupBy string | array[string] Required

        optional group by field or fields to use to generate an SLO per distinct value

        One of:
        string-1 string array-2 array[string]
      • id string Required

        The identifier of the SLO.

      • indicator object Required

        One of:
        SLOs_indicator_properties_custom_kql object SLOs_indicator_properties_apm_availability object SLOs_indicator_properties_apm_latency object SLOs_indicator_properties_custom_metric object SLOs_indicator_properties_histogram object SLOs_indicator_properties_timeslice_metric object

        Defines properties for a custom query indicator type

        Hide attributes Show attributes
      • instanceId string Required

        the value derived from the groupBy field, if present, otherwise '*'

      • name string Required

        The name of the SLO.

      • objective object Required

        Defines properties for the SLO objective

        Hide objective attributes Show objective attributes object
        • target number Required

          the target objective between 0 and 1 excluded

          Minimum value is 0, maximum value is 100.

        • timesliceTarget number

          the target objective for each slice when using a timeslices budgeting method

          Minimum value is 0, maximum value is 100.

        • timesliceWindow string

          the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}

      • revision number Required

        The SLO revision

      • settings object Required

        Defines properties for SLO settings.

        Hide settings attributes Show settings attributes object
        • frequency string

          The interval between checks for changes in the source data. The minimum value is 1m and the maximum is 59m. The default value is 1 minute.

          Default value is 1m.

        • preventInitialBackfill boolean

          Start aggregating data from the time the SLO is created, instead of backfilling data from the beginning of the time window.

          Default value is false.

        • syncDelay string

          The time delay in minutes between the current time and the latest source data time. Increasing the value will delay any alerting. The default value is 1 minute. The minimum value is 1m and the maximum is 359m. It should always be greater then source index refresh interval.

          Default value is 1m.

        • syncField string

          The date field that is used to identify new documents in the source. It is strongly recommended to use a field that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it accounts for data transmission delays. When unspecified, we use the indicator timestamp field.

      • summary object Required

        The SLO computed data

        Hide summary attributes Show summary attributes object
        • errorBudget object Required
          Hide errorBudget attributes Show errorBudget attributes object
          • consumed number Required

            The error budget consummed, as a percentage of the initial value.

          • initial number Required

            The initial error budget, as 1 - objective

          • isEstimated boolean Required

            Only for SLO defined with occurrences budgeting method and calendar aligned time window.

          • remaining number Required

            The error budget remaining, as a percentage of the initial value.

        • sliValue number Required
        • status string Required

          Values are NO_DATA, HEALTHY, DEGRADING, or VIOLATED.

      • tags array[string] Required

        List of tags

      • timeWindow object Required

        Defines properties for the SLO time window

        Hide timeWindow attributes Show timeWindow attributes object
        • duration string Required

          the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)

        • type string Required

          Indicates weither the time window is a rolling or a calendar aligned time window.

          Values are rolling or calendarAligned.

      • updatedAt string Required

        The last update date

      • version number Required

        The internal SLO version

    • total number
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
  • 401 application/json

    Unauthorized response

    Hide response attributes Show response attributes object
  • 403 application/json

    Unauthorized response

    Hide response attributes Show response attributes object
GET /s/{spaceId}/internal/observability/slos/_definitions 
curl \
 --request GET 'https://localhost:5601/s/default/internal/observability/slos/_definitions' \
 --header "Authorization: $API_KEY" \
 --header "kbn-xsrf: string"