Sign a key
Signs data or a digest with a SIGN key.
Signs data or a digest with a SIGN key. Every use is audited.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:sign - Scope
keys:sign - Effect
read— nothing is written. - Collection keys
Request
| Field | Type | What it is |
|---|---|---|
name | string | The key to use. Required. |
key_version | string | The version to use; default the primary version. |
data | bytes | The message to sign, at most 64 KiB. Set exactly one of data and digest. |
digest | bytes | The digest of the message under the algorithm's hash. |
Response
| Field | Type | What it is |
|---|---|---|
signature | bytes | The signature. |
key_version | string | The version that signed. |
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:sign" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'