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
Get an API key
Gets an API key.
This method is not served on the public API.
api.sylphx.comdoes 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.
Gets an API key.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key - Scope
access:read - Effect
read— nothing is written. - Collection api_keys
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the API key to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/api_keys/{api_key}, or orgs/{org}/api_keys/{api_key} for an org-wide key. |
uid | string | key_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ApiKeySpec | Desired state. Required. |
status | ApiKeyStatus | 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. |
#ApiKeySpec
| Field | Type | What it is |
|---|---|---|
kind | ApiKeyKind | Secret (server-side) or publishable (browser, publishable_ok methods only). Required. One of secret, publishable. |
scopes | string[] | Scopes <service>:<action>, a subset of the creator's effective scopes. Required. |
label | string | A free-form label, for example the talent id a key was minted for. |
expire_time | timestamp | When the key stops verifying; required in unclaimed projects. |
#ApiKeyStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
secret | string | The full key. Set only in the responses of Create and Roll. Output only. Never returned again. |
last4 | string | The last four characters, for display. Output only. |
principal | string | The key's own principal. Output only. |
revoke_time | timestamp | Set when the key was revoked. Output only. |
revoke_reason | RevokeReason | Why the key was revoked. Output only. One of user, rotation, leaked, claimed, claim_expired, org_deleted, admin, role_changed, logout. |
last_use_time | timestamp | When the key last verified, at snapshot granularity. Output only. |
last_use_ip | string | The client address of the key's last use. Output only. |
role_bound | bool | A device key (sylphx login): bound to the approving human's role in the org, and revoked when that role changes or the human leaves. 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.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key" \
-H "Authorization: Bearer $SYLPHX_API_KEY"