Skip to content
Console
On this page

Get a licence key

Gets a licence key (its public half, never the private).

Gets a licence key (its public half, never the private).

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys/licence-key
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection licence_keys

Request

FieldTypeWhat it is
namestringThe name of the licence key to get. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/licence_keys/{licence_key}.
uidstringlkey_<cell><ulid>; never reused. The keyless public export is addressed by it. Output only.
metaResourceMetaResource metadata.
specLicenceKeySpecDesired state. Required.
statusLicenceKeyStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

LicenceKeySpec

FieldTypeWhat it is
descriptionstringShown to operators.

LicenceKeyStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready while the key exists. Output only.
statestringactive signs new terms; retired signs only terms already frozen to it and stays exported for verification. Output only.
originstringgenerated or imported. Output only.
public_keystringThe raw Ed25519 public key, base64url without padding. Output only.
retire_timetimestampWhen the key was retired. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys/licence-key" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"