objects

create a copy of an object

Changed on
post/repositories/{repository}/branches/{branch}/objects/copy

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/repositories/{repository}/branches/{branch}/objects/copy
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or API key in cookie internal_auth_session

Request body

src_pathstring required

path of the copied object relative to the ref

src_refstring

a reference, if empty uses the provided branch as ref

forceboolean
shallowboolean

Create a shallow copy of the object (without copying the actual data). At the moment shallow copy only works for same repository and branch. Please note that shallow copied objects might be in contention with garbage collection and branch retention policies - use with caution.

Response

Copy object response

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

Changes