Delete a delivery

A delivery is a configured channel that selects objects and routes their state updates to consumers. Deliveries decouple publishers from subscribers: publishers write state over HTTP, while deliveries decide who receives each update.

Deletes the configuration identified by the delivery query parameter. The request has no body, and a successful deletion returns 204 No Content.

After deletion, that configuration no longer delivers matching object updates. Use Get a delivery to review it first, then List deliveries to confirm that it is no longer returned.

An unknown identifier returns 404. For 401 or 403, check the x-api-key header and whether that key can delete the delivery.

DELETE
{{host}}/v1/delivery?delivery={{delivery}}
VERB:DELETE
BASE URL:{{host}}/v1/delivery
QUERY STRING:?delivery={{delivery}}

Query parameters#

  • deliverystring
    Required

    Unique identifier of the delivery configuration in the URL.

    example: wsall

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    {{apiKey}}
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

Need a session token? See Token sign in.

Response parameters#

  • 204Response body · no content

    The delivery was deleted.

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 404

    No delivery exists for the given identifier.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Invalid request"

    }
    • errornumber

      Numeric error code. Use the response `desc` field for the human-readable explanation.

    • descstring

      Human-readable description of the error.

Examples#

Delete a delivery

Remove a delivery configuration by identifier (query only, no body). Success: 204, no body.

curl https://api.bigstate.dev/v1/delivery?delivery=wsall \

  --request DELETE \

  --header 'x-api-key: YOUR_API_KEY' \

  --header 'Content-Type: application/json' \

  --header 'Accept: application/json'
GetList

© 2024 BigState