Skip to main content
POST
/
runbooks
/
configurations
/
{id}
/
files
Create Runbook File
curl --request POST \
  --url https://use.hoop.dev/api/runbooks/configurations/{id}/files \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "path": "ops/restart.runbook.sh",
  "commit_message": "feat: add restart service runbook",
  "overwrite": true
}
'
{
  "commit_sha": "abc123def456abc123def456abc123def456abc1",
  "path": "ops/restart.runbook.sh"
}

Path Parameters

​
id
string
required

Repository configuration ID

Body

application/json

File to create

​
content
string
required

Content of the runbook file

​
path
string
required

Path of the file to create relative to the repository root, e.g. "ops/restart.runbook.sh"

Example:

"ops/restart.runbook.sh"

​
commit_message
string

Optional commit message. Defaults to "feat: add " when empty.

Example:

"feat: add restart service runbook"

​
overwrite
boolean

If true, overwrite the file if it already exists in the repository

Response

Created

​
commit_sha
string

SHA of the resulting git commit

Example:

"abc123def456abc123def456abc123def456abc1"

​
path
string

Path of the created file relative to the repository root

Example:

"ops/restart.runbook.sh"