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
List entitlement grants
Lists entitlement grants.
Lists entitlement grants.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants - Scope
billing:read - Effect
read— nothing is written. - Collection entitlement_grants
- Query
page_size,page_token,filter - Pagination the answer carries
entitlement_grantsand, 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 filterable fields, for example feature = "plus". |
#Response
| Field | Type | What it is |
|---|---|---|
entitlement_grants | EntitlementGrant[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#EntitlementGrant
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/entitlement_grants/{entitlement_grant}. |
uid | string | egr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
subject | Subject | Who holds it. Output only. |
feature | string | The feature key. Output only. |
limit | string | For a limit feature, the allowance as a decimal string. Output only. |
source | string | The resource that grants it, for example a customer subscription's name. Output only. |
expire_time | timestamp | When it ends; unset for no end. 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. |
#Subject
| Field | Type | What it is |
|---|---|---|
end_user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group. |
customer_organization | string | A customer organization's id. One of the kind group. |
#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/entitlement_grants" \
-H "Authorization: Bearer $SYLPHX_API_KEY"