Get an env
Gets an environment.
Gets an environment.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production - Scope
access:read - Effect
read— nothing is written. - Collection envs
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the environment to get. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}. |
uid | string | env_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | EnvironmentSpec | Desired state. Required. |
status | EnvironmentStatus | 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. |
EnvironmentSpec
| Field | Type | What it is |
|---|---|---|
slug | string | Unique within the project, for example production. Required. |
mode | EnvironmentMode | Live or test; a test key never touches a live environment. Required. One of live, test. |
EnvironmentStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. 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" \
-H "Authorization: Bearer $SYLPHX_API_KEY"