Core
List Runbooks By Connection
Core
- GETList Agent Keys
- POSTCreate Agent Key
- DELDelete Agent Key
- GETList Connections
- POSTCreate Connection
- GETGet Connection
- PUTUpdate Connection
- GETList Databases
- GETGet Database Schema
- DELDelete Connection
- GETList Guard Rail Rules
- POSTCreate Guard Rail Rules
- GETGet Guard Rail Rules
- PUTUpdate Guard Rail Rules
- DELDelete a Rule
- GETGet Org Key
- POSTCreate Org Key
- DELRevoke Org Key
- GETList Plugins
- POSTCreate Plugin
- POSTRunbook Exec
- GETList Runbooks By Connection
- GETList Runbooks
- GETGet Plugin
- PUTUpdate Plugin
- PUTUpdate Plugin Config
- GETSession Reports
- GETList Reviews
- GETGet Review
- PUTUpdate Review Status
- GETList Sessions
- POSTExec
- GETGet Session
- GETDownload Session
- POSTReviewed Exec
Authentication
Server Management
Jira
Core
List Runbooks By Connection
List Runbooks templates by connection
GET
/
plugins
/
runbooks
/
connections
/
{name}
/
templates
name
string
*
name
Required
string
The name of the connection
Path Parameters
The name of the connection
Response
200 - application/json
The commit sha
The commit author
The commit message
The connections that could be used for this runbook
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>