Skip to main content
GET
/
runbooks
List Runbooks
curl --request GET \
  --url https://use.hoop.dev/api/runbooks
{
  "commit": "<string>",
  "commit_author": "<string>",
  "commit_message": "<string>",
  "errors": [
    "<string>"
  ],
  "items": [
    {
      "connections": [
        "pgdemo",
        "bash"
      ],
      "error": "<string>",
      "metadata": {},
      "name": "ops/update-user.runbook.sh"
    }
  ],
  "repositories": [
    {
      "commit": "03c25fd64c74712c71798250d256d4b859dd5853",
      "commit_author": "John Wick <john.wick@bad.org>",
      "commit_message": "runbook update",
      "items": [
        {
          "connections": [
            "pgdemo",
            "bash"
          ],
          "error": "<string>",
          "metadata": {},
          "name": "ops/update-user.runbook.sh"
        }
      ],
      "repository": "github.com/myorg/myrepo"
    }
  ]
}

Query Parameters

​
connection
string

DEPRECATED: use connection_name instead

​
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

OK

​
commit
string

DEPRECATED: use repositories[].commit instead. Commit SHA of the first repository.

​
commit_author
string

DEPRECATED: use repositories[].commit_author instead. Commit author of the first repository.

​
commit_message
string

DEPRECATED: use repositories[].commit_message instead. Commit message of the first repository.

​
errors
string[]

Errors encountered during fetching runbooks

​
items
object[]

DEPRECATED: use repositories[].items instead. Flat list of all runbooks across all repositories.

​
repositories
object[]

List of runbook repositories