Skip to content

by Startups.Studio

Legal & trust Recovery Objective

RecoveryObjective.create

POST /{namespace}/recovery-objectives

Creates a Recovery Objective.

Noun: Recovery Objective
Mode: do
Event: RecoveryObjective.created

You, to your agent

Add a recovery objective to PetPantry.

curl -X POST https://api.sb/petpantry.shop/recovery-objectives \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recoveryPoint":"Example recovery point","recoveryTime":"Example recovery time","drillEvery":"Example drill every"}'

import { $ } from 'startup-builder'

const recoveryObjective = await $.RecoveryObjective.create({ recoveryPoint: 'Example recovery point', recoveryTime: 'Example recovery time', drillEvery: 'Example drill every' })

npx startup-builder do RecoveryObjective.create --json '{"recoveryPoint":"Example recovery point","recoveryTime":"Example recovery time","drillEvery":"Example drill every"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.RecoveryObjective.create({ recoveryPoint: 'Example recovery point', recoveryTime: 'Example recovery time', drillEvery: 'Example drill every' })"
  }
}

Create makes a new Recovery Objective from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`recoveryPoint`	`string`	required	The most data a failure may lose, as a window such as `15m`.
`recoveryTime`	`string`	required	How fast the Capability returns after a failure, as a window such as `4h`.
`drillEvery`	`string`	required	The restore drill cadence, such as `quarterly`.
`lastDrill`	`datetime`		When the last restore drill met both objectives.
`capability`	Capability		The Capability the objective restores.

Outputs

Output	Type	Required	Description
`recoveryObjective`	Recovery Objective	required	The Recovery Objective.

Effects

Emits RecoveryObjective.created.
Two-way: try, send, do.

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.	RecoveryObjective.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Recovery Objective

Previous Page

RecoveryObjective.delete

Next Page