List Runbooks

List all Runbooks

GET /runbooks

List Runbooks

cURL

curl --request GET \
  --url https://use.hoop.dev/api/runbooks

import requests

url = "https://use.hoop.dev/api/runbooks"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://use.hoop.dev/api/runbooks', 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",
  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"

	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")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://use.hoop.dev/api/runbooks")

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

200

{
  "errors": [
    "<string>"
  ],
  "repositories": [
    {
      "commit": "03c25fd64c74712c71798250d256d4b859dd5853",
      "commit_author": "John Wick <[e-mail]>",
      "commit_message": "runbook update",
      "items": [
        {
          "connections": [
            "pgdemo",
            "bash"
          ],
          "error": "<string>",
          "metadata": {},
          "name": "ops/update-user.runbook.sh"
        }
      ],
      "repository": "github.com/myorg/myrepo"
    }
  ]
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

Query Parameters

connection_name · string

Filter runbooks by connection name

list_connections · boolean

Show connections allowed for each runbook.

remove_empty_connections · boolean

Remove runbooks with no connections.

Response

200

application/json

OK

errors · string[]

Errors encountered during fetching runbooks

repositories · object[]

List of runbook repositories

Show child attributes