On this page
Update a subscription
Updates a subscription.
Updates a subscription.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions/subscription - Scope
events:write - Effect
write— a successful call changes state. - Collection subscriptions
- Query
update_mask,allow_missing,validate_only
Request
| Field | Type | What it is |
|---|---|---|
subscription | Subscription | The subscription to update; name identifies it. Required. |
update_mask | field_mask | The fields to write; unset writes every populated field. |
allow_missing | bool | Create the subscription when it does not exist (declarative upsert). |
validate_only | bool | Validate and return the result without writing anything. |
Subscription
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/subscriptions/{subscription}. |
meta | ResourceMeta | Resource metadata. |
spec | SubscriptionSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
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. |
SubscriptionSpec
| Field | Type | What it is |
|---|---|---|
topic | string | The Topic to read. Required. |
types | string[] | Match these CloudEvents types; empty matches all. A trailing * matches a prefix. |
sources | string[] | Match these sources; empty matches all. |
queue | string | A Queue. One of the destination group. |
webhook_endpoint | string | A Webhook Endpoint. One of the destination group. |
realtime_channel | string | A Realtime Channel. One of the destination group. |
paused | bool | Whether matching is paused; events published while paused are not delivered. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/subscriptions/{subscription}. |
uid | string | sub_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | SubscriptionSpec | Desired state. Required. |
status | SubscriptionStatus | 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. |
SubscriptionSpec
| Field | Type | What it is |
|---|---|---|
topic | string | The Topic to read. Required. |
types | string[] | Match these CloudEvents types; empty matches all. A trailing * matches a prefix. |
sources | string[] | Match these sources; empty matches all. |
queue | string | A Queue. One of the destination group. |
webhook_endpoint | string | A Webhook Endpoint. One of the destination group. |
realtime_channel | string | A Realtime Channel. One of the destination group. |
paused | bool | Whether matching is paused; events published while paused are not delivered. |
SubscriptionStatus
| 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.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
Examples
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions/subscription" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/subscriptions/subscription","spec":{"topic":"…"}}'