---
title: "Get workspace key status"
method: GET
path: "/api/workspaces/{workspaceId}/enterprise/keys"
tags: ["workspaces"]
---

# Get workspace key status

`GET /api/workspaces/{workspaceId}/enterprise/keys`

## Request

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

## Path parameters

- `workspaceId` string, required

## Response `200`

Successful response.

- EnterpriseWorkspaceStatus
  - `enterprise` object, nullable, required
    - `workspaceId` string, required
    - `status` 'active' | 'suspended' | 'disabled', required
    - `billingMode` 'contract' | 'workspace_subscription' | 'manual', required
    - `projectCreationMode` 'enterprise_projects', required
    - `workspaceKeyMode` 'disabled' | 'optional' | 'required', required
    - `settings` object, nullable
      - `contractId` string
      - `notes` string
      - `supportTier` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `disabledAt` string, date-time, nullable, required
  - `dedicatedClusters` object[], required
    - `id` string, required
    - `name` string, required
    - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
    - `region` string, required
    - `status` 'active' | 'maintenance' | 'disabled', required
    - `domain` string, required
    - `enginePort` integer, required
    - `turnPort` integer, required
    - `turnsPort` integer, required
  - `keys` object, required
    - `enabled` boolean, required
    - `mode` 'disabled' | 'optional' | 'required', required
    - `protectionState` 'disabled' | 'not_setup' | 'active' | 'recovery_required' | 'degraded', required
    - `activeKeyset` object, nullable, required
      - `id` string, required
      - `status` 'pending' | 'active' | 'rotating' | 'retired' | 'revoked', required
      - `keyEpoch` integer, required
      - `fingerprint` string, required
      - `cryptoSuite` string, required
      - `publicEncryptionKey` string, required
      - `publicSigningKey` string, nullable, required
      - `activatedAt` string, date-time, nullable, required
    - `deviceCount` integer, required
    - `pendingDeviceCount` integer, required
    - `recoveryKitCount` integer, required

## Other responses

- `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)