Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Update a playbook

Replaces the title, description, owner, attached monitor IDs, client scope, and ordered steps.

PUT https://app.upfour.io/v1/runbooks/{runbookID}
PUT https://app.upfour.io/v1/runbooks/{runbookID}

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs runbook.write.
Path
Body
More fields3

2 more fields are only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope runbook.write stable returns 200

Parameters

FieldTypeDescription
runbookID required uuid path parameter

Body

application/json required 6 fields

titlestringrequired
In the app: Title
All other fields7 fields
client_iduuid · nullable
descriptionstring
In the app: Description
monitor_idsuuid[]

The monitors the runbook is attached to. On update they replace the stored list.

In the app: Linked monitors
ownerstring
In the app: Owner
stepsRunbookStepInput[]

The steps in order. On update they replace the stored steps.

In the app: Steps
Nested fields 2 fields
FieldTypeDescription
description optional string
title optional string

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data Runbook
Runbook · 17 fields
FieldTypeDescription
created_at string (date-time)
description string
id uuid
monitor_ids uuid[] · nullable
org_id uuid
owner string
step_count integer
steps RunbookStep[] · nullable
Each item · 6 fields
FieldTypeDescription
created_at string (date-time)
description string
id uuid
position integer
runbook_id uuid
title string
title string
updated_at string (date-time)
client_id uuid

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.