Get an org
Gets an org.
Gets an org.
- Path
GET https://api.sylphx.com/v1/orgs/acme - Scope
access:read - Effect
read— nothing is written. - Collection orgs
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the org to get. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}. |
uid | string | org_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | OrgSpec | Desired state. Required. |
status | OrgStatus | 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. |
OrgSpec
| Field | Type | What it is |
|---|---|---|
slug | string | Globally unique handle, resolved to the id by clients, never the server. Required. |
api_version | string | The API version (YYYY-MM-DD) requests are served at when neither the request nor the key pins one. |
OrgStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
kind | OrgKind | How the org was created. Output only. One of standard, unclaimed, partner_sub. |
state | OrgState | The org's lifecycle state. Output only. One of active, suspended, deleting. |
parent_org | string | The partner org, set iff kind is PARTNER_SUB. Output only. |
home_cell | string | The org's home cell code, for example fs01. 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" \
-H "Authorization: Bearer $SYLPHX_API_KEY"