List deliveries

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 delivery configurations, optionally filtered by the glob-style pattern query parameter. Each record contains delivery, channel type, name, and objects patterns.

Start with next=0, then pass the response's next value to retrieve another page. A response value of -1 means there are no more pages.

Use Get a delivery for one identifier or Create or update a delivery to save a configuration. If a request returns 400, verify the cursor and pattern; for 401 or 403, check the x-api-key header and access.

GET
{{host}}/v1/delivery/match?next=0&pattern={{pattern}}
VERB:GET
BASE URL:{{host}}/v1/delivery/match
QUERY STRING:?next=0&pattern={{pattern}}

Query parameters#

  • nextnumber
    Required

    Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

    example: 0
  • patternstring
    Optional

    Optional glob-style pattern to filter.

    Values

    • pattern
    • *pattern
    • pattern*
    • *pattern*
    example: *

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#

  • 200Response body · object

    Success. Returns a pagination cursor and full delivery rows (identifier, type, name, object patterns) for each match on this page.

    • nextnumber

      Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

      example: 0
    • deliveriesarray[object]

      Delivery configurations that matched the pattern on this page.

      • deliveries[0].deliverystring

        Unique identifier of this delivery configuration.

        example: wsall
      • deliveries[0].namestring

        Human-readable name for this delivery configuration.

      • deliveries[0].typenumber

        Channel used to push state updates to subscribers.

        Values

        • WS = 1
        • HTTP = 2
        • FILE = 3
      • deliveries[0].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.

  • 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#

List deliveries

List deliveries with optional glob pattern; each row includes id, type, name, and object patterns (paginated with `next`).

curl https://api.bigstate.dev/v1/delivery/match?next=0&pattern=* \

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

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

  --header 'Accept: application/json'
DeleteObjects

© 2024 BigState