# Recovery Objective commands: create, get, list

URL: /code/cli/recovery-objective/records · Id: `page:code/cli/recovery-objective/records`

> The Recovery Objective Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for [Recovery Objective](/business/nouns/recovery-objective), one group of [Recovery Objective commands](/code/cli/recovery-objective).

### RecoveryObjective.create
Creates a Recovery Objective. [Verb page](/business/nouns/recovery-objective/create?interface=cli).

```text
npx startup-builder do RecoveryObjective.create --json '<input>' [--try | --send | --do]
```

Emits `RecoveryObjective.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `recoveryPoint` | `string` | Yes | The most data a failure may lose, as a window such as `15m`. |
| `recoveryTime` | `string` | Yes | How fast the Capability returns after a failure, as a window such as `4h`. |
| `drillEvery` | `string` | Yes | The restore drill cadence, such as `quarterly`. |
| `lastDrill` | `datetime` | No | When the last restore drill met both objectives. |
| `capability` | [Capability](/business/nouns/capability) | No | The Capability the objective restores. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `recoveryObjective` | [Recovery Objective](/business/nouns/recovery-objective) | Yes | The Recovery Objective. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

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

### RecoveryObjective.get
Returns one Recovery Objective by id. [Verb page](/business/nouns/recovery-objective/get?interface=cli).

```text
npx startup-builder do RecoveryObjective.get --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Recovery Objective. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `recoveryObjective` | [Recovery Objective](/business/nouns/recovery-objective) | Yes | The Recovery Objective. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do RecoveryObjective.get --json '{"id":"recovery_MSAgl5dysq"}'
```

### RecoveryObjective.list
Returns Recovery Objectives, newest first, one page at a time. [Verb page](/business/nouns/recovery-objective/list?interface=cli).

```text
npx startup-builder do RecoveryObjective.list --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `recoveryObjectives` | list of [Recovery Objective](/business/nouns/recovery-objective) | Yes | One page of Recovery Objectives. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do RecoveryObjective.list --json '{"limit":20}'
```