On this page
List API keys
Lists API keys in an environment, project, or org.
Lists API keys in an environment, project, or org.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys - Scope
access:read - Effect
read— nothing is written. - Collection api_keys
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
api_keysand, when there is more,next_page_token
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels, filterable spec fields, and Ready. |
order_by | string | AIP-132 ordering over filterable fields. |
Response
| Field | Type | What it is |
|---|---|---|
api_keys | ApiKey[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
ApiKey
| 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. |
limits | UsageLimits | Usage limits on this key, on top of its project's and the plan tier's; the tightest one applies. Unset means no key-level limit. |
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. |
UsageLimits
| Field | Type | What it is |
|---|---|---|
ai_spend | AiSpendLimit | Sylphx AI spend. |
requests_per_minute | int32 | Requests per minute. |
ai_tokens_per_minute | int64 | Sylphx AI tokens per minute, input and output together. |
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.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys" \
-H "Authorization: Bearer $SYLPHX_API_KEY"