Get 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.
Returns the configuration identified by the delivery query parameter. The response contains name, channel type, and the objects patterns whose updates are delivered.
Use Create or update a delivery to create a missing configuration or replace it. Use List deliveries when you need identifiers and full configuration rows.
A successful lookup returns 200 OK, while an unknown identifier returns 404. For 401 or 403, check the x-api-key header and the key's access to the delivery.
{{host}}/v1/delivery?delivery={{delivery}}- deliverystringRequired
Unique identifier of the delivery configuration in the URL.
example: wsall
- 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.
- 200Response body · object
Current delivery configuration for the requested identifier.
- namestring
Human-readable name for this delivery configuration.
- typenumber
Channel used to push state updates to subscribers.
Values
- WS = 1
- HTTP = 2
- FILE = 3
- objectsarray[string]
Object name patterns (e.g. glob) whose state updates are sent through this delivery. Use "*" to include all objects.
- 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.
Get a delivery
Fetch the current configuration for a delivery identifier.
curl https://api.bigstate.dev/v1/delivery?delivery=wsall \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'