Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Import a licence key
Imports an existing Ed25519 key (PKCS8), for a key already pinned in shipped clients.
Imports an existing Ed25519 key (PKCS8), for a key already pinned in shipped clients. Refused unless the expected public key is the imported key's public half.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:import - Scope
billing:licence_keys.approve - Effect
write— a successful call changes state. - Collection licence_keys
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment the key belongs to. Required. |
licence_key_id | string | The key's id; as on GenerateLicenceKeyRequest. Required. Required. |
private_key_pkcs8 | bytes | The Ed25519 private key as PKCS8 DER in standard base64. Write-only: sealed on import, never returned. Required. Never returned again. |
expected_public_key | string | The public key shipped clients pin, raw base64url without padding. The import is refused unless it is the public half of the imported key. Required. |
spec | LicenceKeySpec | Shown to operators. |
#LicenceKeySpec
| Field | Type | What it is |
|---|---|---|
description | string | Shown to operators. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/licence_keys/{licence_key}. |
uid | string | lkey_<cell><ulid>; never reused. The keyless public export is addressed by it. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | LicenceKeySpec | Desired state. Required. |
status | LicenceKeyStatus | Observed state. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#LicenceKeySpec
| Field | Type | What it is |
|---|---|---|
description | string | Shown to operators. |
#LicenceKeyStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready while the key exists. Output only. |
state | string | active signs new terms; retired signs only terms already frozen to it and stays exported for verification. Output only. |
origin | string | generated or imported. Output only. |
public_key | string | The raw Ed25519 public key, base64url without padding. Output only. |
retire_time | timestamp | When the key was retired. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.UNKNOWN_FIELD— The request has a field the schema does not know.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:import" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"expected_public_key":"…","licence_key_id":"…","private_key_pkcs8":"…"}'