Skip to content

Recovery Objective routes: update, delete

The Recovery Objective Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Recovery Objective, one group of Recovery Objective routes.

RecoveryObjective.update

Changes the given properties of a Recovery Objective. Verb page.

Text
PATCH /{namespace}/recovery-objectives/{id}

Path: id. Body, as JSON: the other inputs. Emits RecoveryObjective.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Recovery Objective.
recoveryPointstringThe most data a failure may lose, as a window such as 15m.
recoveryTimestringHow fast the Capability returns after a failure, as a window such as 4h.
drillEverystringThe restore drill cadence, such as quarterly.
lastDrilldatetimeWhen the last restore drill met both objectives.

Returns

OutputTypeRequiredDescription
recoveryObjectiveRecovery ObjectiverequiredThe Recovery Objective.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/recovery-objectives/recovery_MSAgl5dysq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lastDrill":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "recoveryObjective": {
    "$id": "https://api.sb/leaseline.app/recovery-objectives/recovery_MSAgl5dysq",
    "$type": "RecoveryObjective",
    "recoveryPoint": "Example recovery point",
    "recoveryTime": "Example recovery time",
    "drillEvery": "Example drill every",
    "lastDrill": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "RecoveryObjective.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

RecoveryObjective.delete

Deletes a Recovery Objective: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/recovery-objectives/{id}

Path: id. Emits RecoveryObjective.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Recovery Objective.

Returns

OutputTypeRequiredDescription
recoveryObjectiveRecovery ObjectiverequiredThe Recovery Objective.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/recovery-objectives/recovery_MSAgl5dysq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "recoveryObjective": {
    "$id": "https://api.sb/leaseline.app/recovery-objectives/recovery_MSAgl5dysq",
    "$type": "RecoveryObjective",
    "recoveryPoint": "Example recovery point",
    "recoveryTime": "Example recovery time",
    "drillEvery": "Example drill every"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "RecoveryObjective.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}