Skip to main content
GET
/
runbooks
/
rules
List Runbook Rules
curl --request GET \
  --url https://use.hoop.dev/api/runbooks/rules
[
  {
    "connections": [
      "pgdemo",
      "bash"
    ],
    "created_at": "2024-07-25T15:56:35.317601Z",
    "description": "Runbook rules for production databases",
    "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
    "name": "Default Runbook Rules",
    "org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
    "runbooks": [
      {
        "name": "ops/update-user.runbook.sh",
        "repository": "github.com/myorg/myrepo"
      }
    ],
    "updated_at": "2024-07-25T15:56:35.317601Z",
    "user_groups": [
      "dba-team",
      "devops-team"
    ]
  }
]

Response

OK

​
connections
string[]
required
Example:
["pgdemo", "bash"]
​
name
string
required
Example:

"Default Runbook Rules"

​
runbooks
object[]
required
​
user_groups
string[]
required
Example:
["dba-team", "devops-team"]
​
created_at
string
Example:

"2024-07-25T15:56:35.317601Z"

​
description
string
Example:

"Runbook rules for production databases"

​
id
string<uuid>
Example:

"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"

​
org_id
string<uuid>
Example:

"37EEBC20-D8DF-416B-8AC2-01B6EB456318"

​
updated_at
string
Example:

"2024-07-25T15:56:35.317601Z"