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
On this page
Get a realtime member
Gets one client present in a channel.
Gets one client present in a channel.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members/realtime-member - Scope
events:read - Effect
read— nothing is written. - Collection realtime_members
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the member. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | …/realtime_channels/{realtime_channel}/realtime_members/{realtime_member}. |
uid | string | rtb_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
client_id | string | The client id its token names. Output only. |
data | value | The member's presence data (set at enter, changed by an update). Output only. |
enter_time | timestamp | When the member entered. Output only. |
connection_count | int32 | Open connections of this client in the channel. 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. |
#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/realtime_channels/realtime-channel/realtime_members/realtime-member" \
-H "Authorization: Bearer $SYLPHX_API_KEY"