Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List profiles
Lists the profiles of an environment.
Lists the profiles of an environment.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles - Scope
secrets:read - Effect
read— nothing is written. - Collection profiles
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
profilesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment 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 and filterable fields. |
order_by | string | AIP-132 ordering over filterable fields. |
#Response
| Field | Type | What it is |
|---|---|---|
profiles | Profile[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Profile
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/profiles/{profile}. |
uid | string | pfl_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ProfileSpec | Desired state. Required. |
status | ProfileStatus | 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. |
#ProfileSpec
| Field | Type | What it is |
|---|---|---|
kind | ProfileKind | What the profile holds. Required. One of browser, computer. |
grants | ProfileGrant[] | Who may mount it and how. A principal with no grant cannot mount it, whatever its scopes. |
paths | string[] | For a computer profile: the paths under the sandbox's home directory its archive holds, for example .config/app. |
#ProfileStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready. Output only. |
latest_version | string | The newest version; empty until the first write-back. Output only. |
sites | ProfileSite[] | The sites of the latest version and when each last changed. Output only. |
#ProfileGrant
| Field | Type | What it is |
|---|---|---|
principal | string | The Access principal, as its keys carry it (for example a service account's id). Required. |
mode | ProfileMountMode | The most it may mount: READ_ONLY, or WRITE_BACK (which includes READ_ONLY). Required. One of read_only, write_back. |
#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. |
#ProfileSite
| Field | Type | What it is |
|---|---|---|
site | string | The registrable domain (eTLD+1), for example example.com; for a computer profile, one declared path. Output only. |
update_time | timestamp | When this site's record last changed. Output only. |
#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/profiles" \
-H "Authorization: Bearer $SYLPHX_API_KEY"