Rootly

https://docs.rootly.com
Admin
Rootly is a comprehensive incident management platform that enables teams to create, manage, and...
Tokens:3,277,759
Snippets:15,754
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Quick setup with defaults

Source: https://docs.rootly.com/integrations/rust-sdk

Creates a RootlyClient using the default base URL and the provided token. This is the quickest way to get started.

```rust
let client = RootlyClient::from_token("your-token");
```

--------------------------------

### Go example

Source: https://docs.rootly.com/api-reference/statuspageteams/retrieves-a-status-page-team-assignment

Go example using net/http to perform the GET request. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/status-pages/{status_page_id}/teams/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example to list dashboard panels

Source: https://docs.rootly.com/api-reference/dashboardpanels/list-dashboard-panels

Go example using net/http to GET dashboard panels. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/dashboards/{dashboard_id}/panels"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Run Rootly setup command in Cursor

Source: https://docs.rootly.com/integrations/agent-plugins

Run this command in Cursor to start the setup process. OAuth2 login is handled automatically.

```text
/rootly-setup
```

--------------------------------

### Ruby example to list dashboard panels

Source: https://docs.rootly.com/api-reference/dashboardpanels/list-dashboard-panels

Ruby example using net/http to GET dashboard panels. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/dashboards/{dashboard_id}/panels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Go example to start a recording session

Source: https://docs.rootly.com/api-reference/meeting-recordings/start-a-recording-session

Uses net/http to send a POST request with a JSON string body. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/meeting_recordings/start_session"

	payload := strings.NewReader("{\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Ruby example

Source: https://docs.rootly.com/api-reference/statuspageteams/retrieves-a-status-page-team-assignment

Ruby example using net/http to perform the GET request. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/status-pages/{status_page_id}/teams/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest example

Source: https://docs.rootly.com/api-reference/statuspageteams/retrieves-a-status-page-team-assignment

Java example using Unirest to perform the GET request. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/status-pages/{status_page_id}/teams/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Expected startup output

Source: https://docs.rootly.com/edge-connectors-installation

Example output showing the connector starting and polling for events.

```text
INFO Starting Rootly Edge Connector
INFO Registered actions with backend  action_count=1
INFO Polling for events  poll_interval=10s

```

--------------------------------

### Quick Start: Export API key and run init, doctor, plan, sync

Source: https://docs.rootly.com/catalog-sync

Sets the ROOTLY_API_KEY environment variable and shows the recommended workflow: scaffold a demo with 'rootly-catalog-sync init --demo', then verify with 'doctor', preview with 'plan', and apply with 'sync'. A minimal config can be created with 'rootly-catalog-sync init' (without --demo).

```bash
export ROOTLY_API_KEY=rootly_...

# Option 1: Scaffold a complete working example (recommended)
rootly-catalog-sync init --demo

# Option 2: Create a minimal config to customize
# rootly-catalog-sync init

# Then run:
rootly-catalog-sync doctor   # verify auth + connectivity
rootly-catalog-sync plan     # preview changes
rootly-catalog-sync sync     # apply
```

--------------------------------

### Go example to retrieve a Sub-Status

Source: https://docs.rootly.com/api-reference/substatuses/retrieves-a-sub-status

Go example using net/http to GET a Sub-Status. Replace {id} and <token> as needed.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/sub_statuses/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### JavaScript fetch example

Source: https://docs.rootly.com/api-reference/statuspageteams/retrieves-a-status-page-team-assignment

JavaScript example using fetch to make the GET request. Handles the response as JSON and logs it.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/status-pages/{status_page_id}/teams/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Configuration file example

Source: https://docs.rootly.com/integrations/tui

Example configuration file stored at ~/.rootly-tui/config.yaml.

```yaml
api_key: "your-api-key"
endpoint: "api.rootly.com"
timezone: "UTC"
language: "en_US"
layout: "horizontal"
```

--------------------------------

### prometheus.query_range example request

Source: https://docs.rootly.com/private-agent-prometheus

Example JSON payload for the prometheus.query_range capability. Requires query, start, end, and step_seconds; start and end must be RFC3339 strings and step_seconds a positive integer. The query must fit Prometheus input limits.

```json
{
  "query": "sum by (namespace) (rate(container_cpu_usage_seconds_total[5m]))",
  "start": "2026-09-10T10:00:00Z",
  "end": "2026-09-10T10:15:00Z",
  "step_seconds": 30,
  "limit": 20
}
```

--------------------------------

### Ruby example to get a meeting recording

Source: https://docs.rootly.com/api-reference/meeting-recordings/get-a-meeting-recording

Uses net/http to send a GET request with a Bearer token and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/meeting_recordings/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Go example to create an on-call shadow configuration

Source: https://docs.rootly.com/api-reference/oncallshadows/creates-an-shadow-configuration

Uses the net/http package to send a POST request with the shadow configuration payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/schedules/{schedule_id}/on_call_shadows"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"on_call_shadows\",\n    \"attributes\": {\n      \"shadowable_id\": \"<string>\",\n      \"shadow_user_id\": 123,\n      \"starts_at\": \"2023-11-07T05:31:56Z\",\n      \"ends_at\": \"2023-11-07T05:31:56Z\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example to get a meeting recording

Source: https://docs.rootly.com/api-reference/meeting-recordings/get-a-meeting-recording

Uses net/http to send a GET request with a Bearer token and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/meeting_recordings/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example for retrieving a retrospective configuration

Source: https://docs.rootly.com/api-reference/retrospectiveconfigurations/retrieves-a-retrospective-configuration

Uses the net/http package to send a GET request. Requires an Authorization header with a Bearer token.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/retrospective_configurations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### CLI: environments flag examples

Source: https://docs.rootly.com/configuration/pulses

Shows how to specify environments using the --environments flag in the CLI.

```bash
--environments "production"
--environments "staging, production"
```

--------------------------------

### Python requests example to get a meeting recording

Source: https://docs.rootly.com/api-reference/meeting-recordings/get-a-meeting-recording

Uses the requests library to perform a GET request. Prints the response text.

```python
import requests

url = "https://api.rootly.com/v1/meeting_recordings/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby example to retrieve a Sub-Status

Source: https://docs.rootly.com/api-reference/substatuses/retrieves-a-sub-status

Ruby example using Net::HTTP to GET a Sub-Status. Replace {id} and <token> as needed.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/sub_statuses/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest example to retrieve a Sub-Status

Source: https://docs.rootly.com/api-reference/substatuses/retrieves-a-sub-status

Java example using Unirest to GET a Sub-Status. Replace {id} and <token> as needed.

```java
HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/sub_statuses/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Go example for listing retrospective process groups

Source: https://docs.rootly.com/api-reference/retrospectiveprocessgroups/list-retrospective-process-groups

Uses net/http to send a GET request and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/retrospective_processes/{retrospective_process_id}/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### PHP cURL example to retrieve a Sub-Status

Source: https://docs.rootly.com/api-reference/substatuses/retrieves-a-sub-status

PHP example using cURL to GET a Sub-Status. Replace {id} and <token> as needed.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/sub_statuses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Run the Rootly Setup Wizard with npx

Source: https://docs.rootly.com/integrations/rootly-wizard

Executes the wizard without installing it globally. Requires Node.js 18 or newer and a Rootly account. Sign in via browser OAuth or API token.

```bash
npx @rootly/wizard@latest
```

--------------------------------

### Go example to retrieve an On Call Shadow configuration

Source: https://docs.rootly.com/api-reference/oncallshadows/retrieves-an-on-call-shadow-configuration-by-id

Uses the net/http package to send a GET request with a Bearer token header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/on_call_shadows/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### JavaScript fetch example to retrieve a Sub-Status

Source: https://docs.rootly.com/api-reference/substatuses/retrieves-a-sub-status

JavaScript example using fetch to GET a Sub-Status. Replace {id} and <token> as needed.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/sub_statuses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### PHP cURL example

Source: https://docs.rootly.com/api-reference/statuspageteams/retrieves-a-status-page-team-assignment

PHP example using cURL to perform the GET request. Includes error handling and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/status-pages/{status_page_id}/teams/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Go example to create a workflow run

Source: https://docs.rootly.com/api-reference/workflowruns/creates-a-workflow-run

Uses the net/http package to POST the workflow run payload. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/workflows/{workflow_id}/workflow_runs"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"workflow_runs\",\n    \"attributes\": {\n      \"immediate\": true,\n      \"check_conditions\": false,\n      \"context\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Install rootly-catalog-sync via Homebrew, Go, Docker, and Helm

Source: https://docs.rootly.com/catalog-sync

Install the CLI using your preferred method. Homebrew and Go install the binary directly. Docker runs the sync command with mounted config and catalog data. Helm installs the chart in Kubernetes with API key and config file settings.

```bash
# Homebrew
brew install rootlyhq/tap/rootly-catalog-sync

# Go
go install github.com/rootlyhq/rootly-catalog-sync/cmd/rootly-catalog-sync@latest

# Docker (mount your config + catalog data)
docker run --rm -e ROOTLY_API_KEY \
  -v $PWD/rootly-catalog-sync.yaml:/config.yaml:ro \
  -v $PWD/catalog:/catalog:ro \
  rootlyhub/rootly-catalog-sync sync --config=/config.yaml

# Helm (Kubernetes)
helm repo add rootly https://rootlyhq.github.io/helm-charts
helm install catalog-sync rootly/rootly-catalog-sync \
  --set rootly.apiKey=$ROOTLY_API_KEY \
  --set-file configYaml=rootly-catalog-sync.yaml
```

--------------------------------

### Go example to update a retrospective configuration

Source: https://docs.rootly.com/api-reference/retrospectiveconfigurations/update-a-retrospective-configuration

Uses net/http to send a PUT request with the payload as a string. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/retrospective_configurations/{id}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"retrospective_configurations\",\n    \"attributes\": {\n      \"severity_ids\": [\n        \"<string>\"\n      ],\n      \"group_ids\": [\n        \"<string>\"\n      ],\n      \"incident_type_ids\": [\n        \"<string>\"\n      ]\n    },\n    \"id\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example to create a communications stage

Source: https://docs.rootly.com/api-reference/communications-stages/creates-a-communications-stage

Uses the net/http package to send a POST request with a JSON payload. Sets the Authorization and Content-Type headers, then prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/communications/stages"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"communications_stages\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"position\": 123\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### JavaScript fetch example to get a meeting recording

Source: https://docs.rootly.com/api-reference/meeting-recordings/get-a-meeting-recording

Uses the fetch API to send a GET request and logs the JSON response or error.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/meeting_recordings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```
Tokens:
Raw