Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Delete in Objects

Deletes an object's current version (history is kept).

Deletes an object's current version (history is kept).

  • Path DELETE https://api.data.sylphx.com/v1/objects/bucket-id/key
  • Scope data:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection objects
  • Query expected_version
  • Host https://api.data.sylphx.com

#Request

FieldTypeWhat it is
bucket_idstringThe bucket's id. Required.
keystringThe object key. Required.
expected_versionuint64Delete only when the current version equals this one (0: any).

#Response

FieldTypeWhat it is
deletedboolWhether a current version existed and was deleted.
objectObjectRecordThe delete marker written.

#ObjectRecord

FieldTypeWhat it is
bucket_idstringThe bucket's id in the environment, for example uploads.
keystringThe object key; / separates path segments.
sha256stringsha256:<hex> of the bytes.
sizeuint64Size in bytes.
content_typestringThe media type given at put.
etagstringThe entity tag of this version.
versionuint64The version, increasing per key.
updated_at_unix_msint64When this version was written, in Unix milliseconds.
delete_markerboolWhether this version is a delete marker (exact-version reads only).
visibilitystringpublic or private (the default); current version only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X DELETE "https://api.data.sylphx.com/v1/objects/bucket-id/key" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"