Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Get an event

Gets an event.

Gets an event.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/events/event
  • Scope events:read
  • Effect read — nothing is written.
  • Collection events

#Request

FieldTypeWhat it is
namestringThe name of the event to get. Required.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/events/{event}.
uidstringevt_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
topicstringThe Topic it was published to. Output only.
sourcestringThe producer's CloudEvents source. Output only.
event_idstringThe producer's CloudEvents id, unique per source. Output only.
typestringThe CloudEvents type. Output only.
subjectstringThe CloudEvents subject. Output only.
event_timetimestampThe CloudEvents time. Output only.
data_content_typestringThe CloudEvents datacontenttype. Output only.
data_schemastringThe CloudEvents dataschema. Output only.
datavalueThe payload. Output only.
extensionsmap<string, string>CloudEvents extension attributes. Output only.
admit_timetimestampWhen Events admitted it. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/events/event" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"