Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Put in Objects

Writes an object's bytes, replacing the current version.

Writes an object's bytes, replacing the current version. body is the base64 of the bytes.

  • Path PUT https://api.data.sylphx.com/v1/objects/bucket-id/key
  • Scope data:write
  • Effect write — a successful call changes state.
  • Collection objects
  • Host https://api.data.sylphx.com

#Request

FieldTypeWhat it is
bucket_idstringThe bucket's id. Required.
keystringThe object key. Required.
bodybytesThe bytes, base64.
content_typestringThe media type, for example application/pdf.
expected_versionuint64Write only when the current version equals this one (0: any).

#Response

FieldTypeWhat it is
objectObjectRecordThe stored object.

#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 PUT "https://api.data.sylphx.com/v1/objects/bucket-id/key" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'