Update incident playbook step completion

Sets whether a playbook step is completed and returns the result.

PUT https://app.upfour.io/v1/incidents/{incidentID}/runbook-steps/{stepID}/completion

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

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs incident.write.

Path

incidentIDpath · requiredPart of the request path. stepIDpath · requiredPart of the request path.

Body

More fields1

completed

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 incident.write stable returns 200

Parameters

Field	Type	Description
`incidentID` required	uuid	path parameter
`stepID` required	uuid	path parameter

Body

application/json required 1 field

All other fields1 fields

completedboolean

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data RunbookStepCompletionResponse

RunbookStepCompletionResponse · 1 fields

Field	Type	Description
`success`	boolean

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.

curl -s -X PUT "https://app.upfour.io/v1/incidents/00000000-0000-4000-8000-000000000001/runbook-steps/00000000-0000-4000-8000-000000000002/completion" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "completed": true }'

const res = await fetch("https://app.upfour.io/v1/incidents/00000000-0000-4000-8000-000000000001/runbook-steps/00000000-0000-4000-8000-000000000002/completion", { method: "PUT", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ completed: true, }), }); console.log(res.status, await res.json());

import os import requests res = requests.put( "https://app.upfour.io/v1/incidents/00000000-0000-4000-8000-000000000001/runbook-steps/00000000-0000-4000-8000-000000000002/completion", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "completed": True, }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "completed": true }`) req, _ := http.NewRequest("PUT", "https://app.upfour.io/v1/incidents/00000000-0000-4000-8000-000000000001/runbook-steps/00000000-0000-4000-8000-000000000002/completion", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "completed": true } JSON; $ch = curl_init("https://app.upfour.io/v1/incidents/00000000-0000-4000-8000-000000000001/runbook-steps/00000000-0000-4000-8000-000000000002/completion"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);