SLXs, SLIs, SLOs & Runbooks API | Product Documentation

SLXs (Service Level Experiences) are the core observability primitive in RunWhen. Each SLX can contain child resources: an SLI (Service Level Indicator), an SLO (Service Level Objective), and a Runbook (automated remediation).

List SLXs

Retrieve all SLXs in a workspace.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Response 200 OK

JSON

{
  "count": 15,
  "next": null,
  "previous": null,
  "results": [
    {
      "name": "check-cpu-usage",
      "statement": "CPU usage should remain below 80%",
      "asMeasuredBy": "node_cpu_seconds_total",
      "metricType": "gauge",
      "owners": ["sre-team"],
      "tags": {"severity": "warning", "component": "compute"},
      "imageUrl": "https://...",
      "icon": "cpu",
      "createdAt": "2026-01-10T08:00:00Z"
    }
  ]
}

Get SLX Detail

Retrieve details of a specific SLX.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/{slx_name}`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`slx_name`	string	The short name of the SLX

Response 200 OK

Returns the full SLX object including child SLI, SLO, and Runbook references.

Get SLX Groups

Retrieve SLXs organized by their configured groups and sub-groups.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/groups`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace

Response 200 OK

Returns SLXs organized into their group and sub-group hierarchy.

Get SLI Chart Data

Retrieve SLI metric chart data for a specific SLX.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/{slx_name}/sli/chart`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`slx_name`	string	The short name of the SLX

Response 200 OK

Returns time-series chart data for the SLI metric associated with this SLX.

Get SLI

Retrieve the Service Level Indicator configuration for an SLX.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/{slx_name}/sli`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`slx_name`	string	The short name of the SLX

Response 200 OK

JSON

{
  "displayUnitsLong": "percentage",
  "displayUnitsShort": "%",
  "description": "CPU utilization across nodes",
  "locations": ["us-east-1"],
  "intervalStrategy": "fixed",
  "intervalSeconds": 300,
  "codeBundle": {
    "repoUrl": "https://github.com/runwhen-contrib/rw-cli-codecollection",
    "ref": "main",
    "pathToRobot": "codebundles/k8s-cpu-check/sli.robot"
  }
}

Get SLO

Retrieve the Service Level Objective configuration for an SLX.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/{slx_name}/slo`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`slx_name`	string	The short name of the SLX

Response 200 OK

JSON

{
  "objective": 99.9,
  "threshold": 9,
  "operand": "lt",
  "sloSpecType": "standard",
  "ruleGroups": {}
}

Get Runbook

Retrieve the Runbook configuration for an SLX.


Method	`GET`
Path	`/api/v3/workspaces/{workspace_name}/slxs/{slx_name}/runbook`
Auth	Bearer token required

Path Parameters

Parameter	Type	Description
`workspace_name`	string	The unique name of the workspace
`slx_name`	string	The short name of the SLX

Response 200 OK

Returns the runbook definition including code bundle references and task configurations.