Skip to main content
POST
/
runbooks
/
configurations
Create Runbook Configuration Entry
curl --request POST \
  --url https://use.hoop.dev/api/runbooks/configurations \
  --header 'Content-Type: application/json' \
  --data '
{
  "git_url": "https://github.com/myorg/myrepo",
  "git_hook_ttl": 1000,
  "git_password": "mypassword",
  "git_user": "myusername",
  "ssh_key": "-----BEGIN PRIVATE KEY-----...",
  "ssh_keypass": "mykeypassphrase",
  "ssh_known_hosts": "github.com ssh-rsa AAAA...",
  "ssh_user": "myuser"
}
'
{
  "created_at": "2024-07-25T15:56:35.317601Z",
  "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
  "repositories": [
    {
      "git_hook_ttl": 1000,
      "git_password": "mypassword",
      "git_url": "https://github.com/myorg/myrepo",
      "git_user": "myusername",
      "repository": "github.com/myorg/myrepo",
      "ssh_key": "-----BEGIN PRIVATE KEY-----...",
      "ssh_keypass": "mykeypassphrase",
      "ssh_known_hosts": "github.com ssh-rsa AAAA...",
      "ssh_user": "myuser"
    }
  ],
  "updated_at": "2024-07-25T15:56:35.317601Z"
}

Body

application/json

Runbook Repository Configuration

​
git_url
string
required

Git repository URL where the runbook is located

Example:

"https://github.com/myorg/myrepo"

​
git_hook_ttl
integer

Enables runbook hooks when this value is greater than zero

Example:

1000

​
git_password
string

Git password or token for repository authentication

Example:

"mypassword"

​
git_user
string

Git username for repository authentication

Example:

"myusername"

​
ssh_key
string

SSH private key for Git repository authentication

Example:

"-----BEGIN PRIVATE KEY-----..."

​
ssh_keypass
string

SSH key passphrase for encrypted SSH keys

Example:

"mykeypassphrase"

​
ssh_known_hosts
string

Git SSH known hosts for host key verification

Example:

"github.com ssh-rsa AAAA..."

​
ssh_user
string

SSH username for Git repository authentication

Example:

"myuser"

Response

OK

​
created_at
string

The time the resource was created

Example:

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

​
id
string<uuid>

The unique identifier of the runbook

Example:

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

​
org_id
string<uuid>

Organization ID that owns this configuration

Example:

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

​
repositories
object[]

The runbook repository configuration

​
updated_at
string

The time the resource was updated

Example:

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