Get delivery

Returns the current name, type, and objects patterns for a delivery identifier passed in the query string.

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

Response parameters#

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

    • descstring

      Human-readable description of the error.

Examples#

Get 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'
UpsertDelete

© 2024 BigState