---
title: "Set the off-site copy"
method: POST
path: "/captable/offsite"
tags: ["captable"]
---

# Set the off-site copy

`POST /captable/offsite`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/captable/offsite`
- Auth: HTTP bearer

An owner, with a passkey, sets where the cap table's off-site copy goes on the first of each month and after every confirmed change: an S3-compatible bucket with write-only credentials, or every owner's email for copies under 10 MB. enabled false stops it.

## Request body

- object
  - `destination` union
    - object
      - `kind` 's3', required
      - `endpoint` string, uri, required
      - `region` string
      - `bucket` string, required
      - `prefix` string
      - `access_key_id` string, required
      - `secret_access_key` string, required
    - object
      - `kind` 'email', required
  - `enabled` boolean

## Response `200`

The result.

- object
  - `kind` 's3' | 'email', nullable, required
  - `enabled` boolean, required
  - `endpoint` string, nullable, required
  - `region` string, nullable, required
  - `bucket` string, nullable, required
  - `prefix` string, nullable, required
  - `access_key_id` string, nullable, required
  - `set_at` string, date-time, nullable, required
  - `last_delivered_at` string, date-time, nullable, required
  - `failed_on` string, date, nullable, required
  - `last_error` string, nullable, required
  - `deliveries` object[], required
    - `at` string, date-time, required
    - `trigger` 'monthly' | 'change' | 'manual', required
    - `status` 'delivered' | 'failed', required
    - `file_name` string, required
    - `sha256` string, nullable, required
    - `error` string, nullable, required

## Other responses

- `202`: Called by an agent or an API key, so the call did not run. A person approves it at approval_url; then GET the Location.
- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)