Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

Change requests in Scrubbe represent planned or in-progress modifications to your systems — deployments, configuration updates, infrastructure changes, and similar events. Tracking changes alongside incidents lets Scrubbe correlate service disruptions with recent modifications, improving the speed and accuracy of root cause analysis. Every change record supports scheduling, rollback planning, and risk classification.
All endpoints require Authorization: Bearer <token>.
Base path: https://your-api-domain.com/api/v1/changes

​
Create a change request

POST /
​
title
string
required
Short title for the change request (e.g. "Upgrade PostgreSQL to 16.2").
​
description
string
required
Detailed description of the change being made.
​
type
string
required
Change type: STANDARD, NORMAL, or EMERGENCY.
​
risk
string
Risk level: LOW, MEDIUM, or HIGH.
​
serviceArea
string
Affected service or team area.
​
environment
string
Target environment (e.g. "production", "staging").
​
scheduledAt
string
ISO 8601 timestamp for the planned change window.
​
assignedToEmail
string
Email of the engineer responsible for implementing the change.
​
rollbackPlan
string
Description of how to revert the change if it fails.
curl -X POST https://your-api-domain.com/api/v1/changes \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Upgrade PostgreSQL to 16.2",
    "description": "Rolling upgrade of the primary database cluster from 15.4 to 16.2.",
    "type": "NORMAL",
    "risk": "HIGH",
    "serviceArea": "database",
    "environment": "production",
    "scheduledAt": "2026-05-25T02:00:00Z",
    "assignedToEmail": "dba@example.com",
    "rollbackPlan": "Restore from pre-upgrade snapshot taken at T-30min."
  }'
Response 
{
  "success": true,
  "message": "Change request created",
  "data": {
    "id": "CHG-20260522-0015",
    "title": "Upgrade PostgreSQL to 16.2",
    "type": "NORMAL",
    "risk": "HIGH",
    "status": "PENDING",
    "scheduledAt": "2026-05-25T02:00:00Z",
    "createdAt": "2026-05-22T10:00:00Z"
  }
}

​
List change requests

Returns a paginated list of change requests ordered by creation date descending. GET /
​
page
number
default:"1"
Page number.
​
limit
number
default:"20"
Items per page (max 100).
​
status
string
Filter by status: PENDING, APPROVED, IN_PROGRESS, COMPLETED, or CANCELLED.
​
environment
string
Filter by environment.
​
risk
string
Filter by risk level: LOW, MEDIUM, or HIGH.

​
Get a change request

GET /:id
​
id
string
required
The change request ID.

​
Update a change request

Accepts the same fields as POST /. Only provided fields are updated. Use this endpoint to progress status, adjust the scheduled window, or add a rollback plan after initial creation. PUT /:id
​
id
string
required
The change request ID.
cURL
curl -X PUT https://your-api-domain.com/api/v1/changes/CHG-20260522-0015 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{ "status": "APPROVED" }'

​
Delete a change request

DELETE /:id
​
id
string
required
The change request ID to delete.
Deleted change requests are permanently removed and cannot be recovered. If a change has already been executed or is linked to an incident, update its status to CANCELLED instead to preserve the audit trail.