Delete a value

A value is raw binary data stored separately from object state. Uploading a value returns an opaque valueRef that state can reference, so large or binary payloads stay out of the inline state body.

Remove a stored blob identified by its fully qualified object name and valueRef. Success returns 204 with no response body; a 404 means that pair does not identify a stored blob.

Use List stored values to confirm the reference before deleting it. If you need the contents first, retrieve them with Download a value.

Confirm the value reference

Deletion has no confirmation step.

Verify the exact object and valueRef pair before sending the request.

DELETE
{{host}}/v1/value?object={{object}}&valueRef={{valueRef}}
VERB:DELETE
BASE URL:{{host}}/v1/value
QUERY STRING:?object={{object}}&valueRef={{valueRef}}

Query parameters#

  • objectstring
    Required

    Unique name of the object in the URL.

    format:
    abc:0-9@owner
  • valueRefstring
    Required

    Identifier returned when the blob was stored (POST).

    example: Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3

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 blob was deleted. No response body.

  • 401

    Unauthorized.

  • 403

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

  • 404

    No blob exists for this object and valueRef.

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

Remove stored bytes for this object and reference. Success: 204, no body.

curl 'https://api.bigstate.dev/v1/value?object=Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6%3Aposition%3Avalueref%40Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6&valueRef=Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3' \

  --request DELETE \

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

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

  --header 'Accept: application/json'
ListVersion

© 2024 BigState