v52

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-03134119177.4 KB
staging

associate staging on this physical address with a path

Link the physical address with the path in lakeFS, creating an uncommitted change. The given address can be one generated by getPhysicalAddress, or an address outside the repository's storage namespace.

put/repositories/{repository}/branches/{branch}/staging/backing

Headers

If-None-Matchstring

Set to "*" to atomically allow the upload only if the key has no object yet. Other values are not supported.

If-Matchstring

Set to the object's ETag to atomically allow operations only if the object's current ETag matches the provided value.

Request body

checksumstring required

unique identifier of object content on backing store (typically ETag)

size_bytesinteger required
user_metadataobject
content_typestring

Object media type

mtimeinteger

Unix Epoch in seconds. May be ignored by server.

forceboolean

Response

object metadata

pathstring required
path_type'common_prefix' | 'object' required
physical_addressstring required

The location of the object on the underlying object store. Formatted as a native URI with the object store type as scheme ("s3://...", "gs://...", etc.) Or, in the case of presign=true, will be an HTTP URL to be consumed via regular HTTP GET

physical_address_expiryinteger

If present and nonzero, physical_address is a pre-signed URL and will expire at this Unix Epoch time. This will be shorter than the pre-signed URL lifetime if an authentication token is about to expire.

This field is optional.

checksumstring required
size_bytesinteger

The number of bytes in the object. lakeFS always populates this field when returning ObjectStats. This field is optional for the client to supply, for instance on upload.

mtimeinteger required

Unix Epoch in seconds

metadataObjectUserMetadata
content_typestring

Object media type