List Runbook Rules
curl --request GET \
--url https://use.hoop.dev/api/runbooks/rulesimport requests
url = "https://use.hoop.dev/api/runbooks/rules"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/runbooks/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://use.hoop.dev/api/runbooks/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/runbooks/rules"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/runbooks/rules")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/runbooks/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"connections": [
"pgdemo",
"bash"
],
"name": "Default Runbook Rules",
"runbooks": [
{
"name": "ops/update-user.runbook.sh",
"repository": "github.com/myorg/myrepo"
}
],
"user_groups": [
"dba-team",
"devops-team"
],
"created_at": "2024-07-25T15:56:35.317601Z",
"description": "Runbook rules for production databases",
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
"updated_at": "2024-07-25T15:56:35.317601Z"
}
]{
"message": "the error description"
}Runbooks
List Runbook Rules
List all Runbook Rules
GET
/
runbooks
/
rules
List Runbook Rules
curl --request GET \
--url https://use.hoop.dev/api/runbooks/rulesimport requests
url = "https://use.hoop.dev/api/runbooks/rules"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/runbooks/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://use.hoop.dev/api/runbooks/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/runbooks/rules"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/runbooks/rules")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/runbooks/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"connections": [
"pgdemo",
"bash"
],
"name": "Default Runbook Rules",
"runbooks": [
{
"name": "ops/update-user.runbook.sh",
"repository": "github.com/myorg/myrepo"
}
],
"user_groups": [
"dba-team",
"devops-team"
],
"created_at": "2024-07-25T15:56:35.317601Z",
"description": "Runbook rules for production databases",
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
"updated_at": "2024-07-25T15:56:35.317601Z"
}
]{
"message": "the error description"
}Response
OK
The connection names that this rule applies to
Example:
["pgdemo", "bash"]
The name of the runbook rule
Example:
"Default Runbook Rules"
The runbook files associated with this rule
Show child attributes
Show child attributes
The user groups names that can access this runbook rule
Example:
["dba-team", "devops-team"]
The time the resource was created
Example:
"2024-07-25T15:56:35.317601Z"
The description of the runbook rule
Example:
"Runbook rules for production databases"
The unique identifier of the runbook rule
Example:
"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"
Organization ID that owns this runbook rule
Example:
"37EEBC20-D8DF-416B-8AC2-01B6EB456318"
The time the resource was updated
Example:
"2024-07-25T15:56:35.317601Z"
Was this page helpful?