Create or update delivery

Creates or updates a delivery configuration: the delivery query parameter sets the identifier; the body defines the display name, wire type (e.g. WebSocket), and which objects (patterns) receive updates. On success the API returns 204 No Content with an empty body.

POST
{{host}}/v1/delivery?delivery={{delivery}}
VERB:POST
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.

    *provide api key here*
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

See authentication headers here.

Request body#

  • WebSocket delivery for all objects
    {

      "name": "ws all subjects",

      "type": 1,

      "objects": [

        "*"

      ]

    }

Request parameters#

  • namestring
    Required

    Human-readable name for this delivery configuration.

  • typenumber
    Required

    Channel used to push state updates to subscribers.

    Values

    • WS = 1
    • HTTP = 2
    • FILE = 3
  • objectsarray[string]
    Required

    Object name patterns (e.g. glob) whose state updates are sent through this delivery. Use "*" to include all objects.

Response parameters#

  • 204Response body · no content

    Delivery was created or updated. No response body.

  • 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. See the error codes reference for the full list.

    • descstring

      Human-readable description of the error.

Examples#

Create WebSocket delivery

Create or replace a delivery: WebSocket channel, human-readable name, and object patterns (e.g. all objects). Success: 204, no body.

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

  --request POST \

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

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

  --header 'Accept: application/json' \

  --data '{

  "name": "ws all subjects",

  "type": 1,

  "objects": [

    "*"

  ]

}'
MatchGet

© 2024 BigState