Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Encrypt a key
Encrypts data with an ENCRYPT key.
Encrypts data with an ENCRYPT key.
- 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":"…"}'