---
title: "Register a workspace recovery kit"
method: POST
path: "/api/workspaces/{workspaceId}/enterprise/recovery-kits"
tags: ["workspaces"]
---

# Register a workspace recovery kit

`POST /api/workspaces/{workspaceId}/enterprise/recovery-kits`

## Request

- Base URL: `https://rstream.io`
- URL: `https://rstream.io/api/workspaces/{workspaceId}/enterprise/recovery-kits`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, required

## Request body

- RegisterWorkspaceRecoveryKitParams
  - `keysetId` string, required
  - `actorDeviceKeyId` string, required
  - `label` string
  - `fingerprint` string, required
  - `checksum` string, required
  - `envelope` object, required
    - `recipientKind` 'recovery_kit', required
    - `recipientId` 'self', required
    - `ciphertext` string, required
    - `crypto` object, required
      - `suite` 'p256-hkdf-sha256-aes-256-gcm', required
      - `keyId` string
      - `encapsulatedKey` string
      - `context` Schema0 (unresolved $ref)
  - `actorSignature` string, required
  - `keysetSignature` string, required

## Response `201`

Successful response.

- RegisterWorkspaceRecoveryKitResponse
  - `recoveryKitId` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Authentication is required.
- `403`: The token is not authorized.
- `404`: Workspace not found.

---

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