---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Encrypt a key"
description: "`keys.keys.encrypt` (POST /v1/{name}:encrypt): Encrypts data with an ENCRYPT key."
type: reference
product: platform
summary: "Encrypts data with an ENCRYPT key."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Encrypts data with an ENCRYPT key.

**Not available yet.** Sylphx Keys is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:encrypt`
- **Scope** `keys:encrypt`
- **Effect** `read` — nothing is written.
- **Collection** [keys](/docs/api/keys)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The key to use. Required. |
| `plaintext` | `bytes` | The plaintext, at most 64 KiB. Required. Never returned again. |
| `additional_authenticated_data` | `bytes` | Data bound to the ciphertext and required again to decrypt it. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `ciphertext` | `bytes` | The ciphertext; it names the version that made it. |
| `key_version` | `string` | The version that encrypted. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`RATE_LIMITED`](/docs/api/errors/RATE_LIMITED) — The rate limit is reached; see Retry-After.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:encrypt" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plaintext":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.keys.keys.encrypt({ name: 'orgs/acme/projects/shop/envs/production/keys/key', plaintext: '…' })
```

**Rust**

```rust
let mut req = sylphx::keys::EncryptRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/keys/key".to_string();
req.plaintext = "…".to_string();
let response = sx.keys().keys().encrypt(req).await?;
```

**CLI**

```bash
sylphx keys keys encrypt orgs/acme/projects/shop/envs/production/keys/key
```

**MCP**

```json
{ "method_id": "keys.keys.encrypt", "args": {"name":"orgs/acme/projects/shop/envs/production/keys/key","plaintext":"…"} }
```