objects

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

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
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or API key in cookie internal_auth_session

Query parameters

storageClassstring

Deprecated, this capability will not be supported in future releases.

forceboolean

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 multipart/form-data

contentstring binary

Only a single file per upload which must be named "content".

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

Changes

  • 37e11f33e043Revision changes
    • info

      added the new optional header request parameter If-Match

    • info

      added the non-success response with the status

  • 27799ffec9a5Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status