---
title: "Get encryption key status"
method: GET
path: "/v1/account/encryption-key"
tags: ["account"]
---

# Get encryption key status

`GET /v1/account/encryption-key`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/encryption-key`
- Auth: HTTP bearer

Returns whether the workspace can use its own encryption key in Azure Key Vault, what that key covers, its identifier, its status, and the progress of re-encrypting existing data under it.

## Response `200`

Success.

- object
  - `data` object, required
    - `available` boolean, required: Customer-managed keys can be used on this platform.
    - `consentUrl` string, nullable, required: Microsoft admin-consent link for the Key Vault application. A tenant administrator opens it once; null when customer-managed keys are not available.
    - `covers` string, required
    - `doesNotCover` string, required
    - `key` object, nullable, required
      - `provider` 'azure-key-vault', required
      - `tenantId` string, required
      - `keyId` string, required: The key identifier in the vault (a URL). Not key material.
      - `status` 'error' | 'pending' | 'active' | 'disabling', required
      - `reencryptDone` integer, required
      - `reencryptTotal` integer, required
      - `lastUnwrapAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `lastError` string, nullable, required
      - `verifiedAt` string, required: ISO-8601 timestamp (UTC).
      - `createdBy` string, required: User id, or `api-key`.
      - `createdAt` string, required: ISO-8601 timestamp (UTC).
      - `updatedAt` string, required: ISO-8601 timestamp (UTC).
      - `wrappedKeyPreview` string, required: The first characters of the wrapped data key, to tell keys apart. Unusable without your key.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

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