Encrypt a key

Encrypts data with an ENCRYPT key.

Checked 2026-09-28

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

#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 — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
INVALID_FIELD — A field failed validation.
INVALID_STATE — The Resource is in a state that forbids the call.
RATE_LIMITED — The rate limit is reached; see Retry-After.

Every error arrives in the body Errors describes.

#Examples

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":"…"}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links