Get the encryption key
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/encryption_keyReturn the customer-managed key the organization uses for stored content, its health, and the progress of any re-encryption.
For how this fits into a full workflow, see Customer-managed keys.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Response
200 OK, Content-Type: application/json
{
"type": "encryption_key",
"provider": "gcp",
"key_ref": "projects/acme-sec/locations/europe-west3/keyRings/syntic/cryptoKeys/content",
"status": "active",
"verified_at": "2026-11-05T10:00:00Z",
"reencryption": {
"status": "running",
"objects_total": 48211,
"objects_done": 1200
}
}| Field | Type | Description |
|---|---|---|
provider | string | gcp, aws or azure. |
key_ref | string | The key’s resource name, ARN or URL in your KMS. |
status | string | verifying, active, unreachable (cannot be used right now) or revoked (your KMS denied access). |
reencryption | object or null | Background re-encryption of existing content: status, objects_total, objects_done. |
Examples
curl -sS https://app.syntic.ai/v1/organizations/encryption_key \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 404 | not_found_error | encryption_key_not_configured | The organization uses Syntic-managed keys. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Related
Was this page helpful?