Recovery Objective methods: update, delete
The Recovery Objective Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Recovery Objective, one group of Recovery Objective methods.
RecoveryObjective.update
Changes the given properties of a Recovery Objective. Verb page.
interface RecoveryObjectiveVerbs {
update(input: RecoveryObjectiveUpdateInput, options?: SB.CallOptions): SB.Call<RecoveryObjective>
}Emits RecoveryObjective.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Recovery Objective. |
recoveryPoint | string | The most data a failure may lose, as a window such as 15m. | |
recoveryTime | string | How fast the Capability returns after a failure, as a window such as 4h. | |
drillEvery | string | The restore drill cadence, such as quarterly. | |
lastDrill | datetime | When the last restore drill met both objectives. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
recoveryObjective | Recovery Objective | required | The Recovery Objective. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const recoveryObjective = await $.RecoveryObjective.update({ id: 'recovery_MSAgl5dysq', lastDrill: '2026-10-22T12:RecoveryObjective.delete
Deletes a Recovery Objective: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface RecoveryObjectiveVerbs {
delete(input: RecoveryObjectiveDeleteInput, options?: SB.CallOptions): SB.Call<RecoveryObjective>
}Emits RecoveryObjective.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Recovery Objective. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
recoveryObjective | Recovery Objective | required | The Recovery Objective. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const recoveryObjective = await $.RecoveryObjective.delete({ id: 'recovery_MSAgl5dysq' })