SVsvix
Message

Expunge all message contents for an application

Changed on

Delete all message payloads for the application.

This operation is only available in the <a href="https://svix.com/pricing" target="_blank">Enterprise</a> plan.

A completed task will return a payload like the following:

{
  "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
  "status": "finished",
  "task": "application.purge_content",
  "data": {
    "messagesPurged": 150
  }
}
post/api/v1/app/{app_id}/msg/expunge-all-contents

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/msg/expunge-all-contents
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

Headers

idempotency-keystring

The request's idempotency key

Response

idstring required

The QueueBackgroundTask's ID.

status'running' | 'finished' | 'failed' required
task'endpoint.replay' | 'endpoint.recover' | 'application.stats' | 'message.broadcast' | 'sdk.generate' | 'event-type.aggregate' | 'application.purge_content' | 'endpoint.bulk-replay' required
updatedAtstring date-time required

Example response

{
  "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}

Changes