List Runbooks By Connection
Authentication
Connections
Guard Rails
Server Management
Jira
Organization Management
Reports
User Management
List Runbooks By Connection
List Runbooks templates by connection
GET
/
plugins
/
runbooks
/
connections
/
{name}
/
templates
curl --request GET \
--url https://use.hoop.dev/api/plugins/runbooks/connections/{name}/templates{
"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"
}
]
}Path Parameters
The name of the connection
Response
200
application/json
OK
The commit sha
Example:
"03c25fd64c74712c71798250d256d4b859dd5853"
The commit author
Example:
"John Wick <john.wick@bad.org>"
The commit message
Example:
"runbook update"
The connections that could be used for this runbook
Example:
["pgdemo", "bash"]
The error description if it failed to render
Metadata contains the attributes parsed from a template. Payload Example:
{
"customer_id" : {
"description": "the id of the customer",
"required": true,
"type": "text",
"default": "Default value to use"
},
"country": {
"description": "the country code US; BR, etc",
"required": false,
"type": "select",
"options": ["US", "BR"]
}
}
By default it will have the attributes description="", required=false and type="text".
File path relative to repository root containing runbook file in the following format: /path/to/file.runbook.<ext>
Example:
"ops/update-user.runbook.sh"
curl --request GET \
--url https://use.hoop.dev/api/plugins/runbooks/connections/{name}/templates{
"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"
}
]
}