Skip to content
Console
On this page

Delete a realtime channel

Deletes a realtime channel.

Deletes a realtime channel.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
  • Scope events:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection realtime_channels
  • Query etag, allow_missing, validate_only, force

Request

FieldTypeWhat it is
namestringThe name of the realtime channel to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the realtime channel does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso delete the channel's history. Without it, a channel with retained messages is still deleted and its history stops being readable.

Response

The call answers with an empty object.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"