last verified · 2026-07-16

Runbooks

A runbook is a named reference procedure for your project — a slug, a title, a description, and a markdown body.

This resource is read-only today. There is no public endpoint to create, edit, or trigger a runbook — only to list and read the ones that already exist.

GET/api/v1/runbooks

List runbooks for your project.

Name	Type	Required	Default	Description
`limit`	`integer`	No	`100`	Max rows to return.

curl


curl https://lumis.work/api/v1/runbooks \
  -H "Authorization: Bearer $LUMIS_MCP_TOKEN"

TypeScript


const res = await fetch('https://lumis.work/api/v1/runbooks', {
  headers: { authorization: `Bearer ${process.env.LUMIS_MCP_TOKEN}` },
});
const { runbooks } = await res.json();

Python


res = requests.get(
    "https://lumis.work/api/v1/runbooks",
    headers={"authorization": f"Bearer {os.environ['LUMIS_MCP_TOKEN']}"},
)
runbooks = res.json()["runbooks"]


{
  "version": "v1",
  "runbooks": [
    {
      "slug": "incident-rollback",
      "title": "Roll back a bad deploy",
      "description": "Steps to revert a production deploy safely."
    }
  ]
}

Each list entry is a summary (slug, title, description); fetch the individual runbook below for its full body.

GET/api/v1/runbooks/:slug

Read a single runbook’s full body by slug. Returns 404 if it doesn’t exist.


{
  "version": "v1",
  "runbook": {
    "slug": "incident-rollback",
    "title": "Roll back a bad deploy",
    "description": "Steps to revert a production deploy safely.",
    "body": "1. Confirm the bad deploy...\n2. Revert...",
    "updated_at": "2026-07-01T09:00:00.000Z"
  }
}