How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

lakeFS objects API

The objects API from lakeFS — 8 operation(s) for objects.

lakeFS objects API is one of 17 APIs that lakeFS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Objects. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /api/v1.

10 operations 8 paths 11 schemas 1 DELETE4 GET1 HEAD3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
/api/v1
Authentication
HTTP Basic, HTTP Bearer, API Key, API Key, API Key
License
Resource Areas
1

Authentication & Security 5

lakeFS objects API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). It accepts HTTP bearer tokens (JWT) (jwt_token). An API key is passed in the cookie as internal_auth_session (cookie_auth). An API key is passed in the cookie as oidc_auth_session (oidc_auth). An API key is passed in the cookie as saml_auth_session (saml_auth). By default, every request must be authenticated.

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 HEAD, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

objects 10
GET
/repositories/{repository}/refs/{ref}/objects
get object content
getObject 6 params → 200206302304400401404410
HEAD
/repositories/{repository}/refs/{ref}/objects
check if object exists
headObject 4 params → 200206400401404410416429
POST
/repositories/{repository}/branches/{branch}/objects
uploadObject 7 params body → 201400401403404412429501
DELETE
/repositories/{repository}/branches/{branch}/objects
delete object. Missing objects will not return a NotFound error.
deleteObject 5 params → 204400401403404429default
POST
/repositories/{repository}/branches/{branch}/objects/delete
delete objects. Missing objects will not return a NotFound error.
deleteObjects 4 params body → 200400401403404429default
POST
/repositories/{repository}/branches/{branch}/objects/copy
create a copy of an object
copyObject 3 params body → 201400401403404429default
GET
/repositories/{repository}/refs/{ref}/objects/stat
get object metadata
statObject 5 params → 200401404400410429default
PUT
/repositories/{repository}/branches/{branch}/objects/stat/user_metadata
rewrite (all) object metadata
updateObjectUserMetadata 3 params body → 201401404400429default
GET
/repositories/{repository}/refs/{ref}/objects/underlyingProperties
get object properties on underlying storage
getUnderlyingProperties 3 params → 200400401404429default
GET
/repositories/{repository}/refs/{ref}/objects/ls
list objects under a given prefix
listObjects 8 params → 200400401404429default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ObjectStats (9 properties), ObjectCopyCreation (4 properties), Pagination (4 properties), ObjectError (3 properties). Each schema is shown below with its type and property counts.

ObjectStats
object
9 properties 5 required
ObjectUserMetadata
object
ObjectCopyCreation
object
4 properties 1 required
ObjectStatsList
object
2 properties 2 required
Error
object
1 property 1 required
PathList
object
1 property 1 required
Pagination
object
4 properties 4 required
ObjectErrorList
object
1 property 1 required
UpdateObjectUserMetadata
object
1 property 1 required
UnderlyingObjectProperties
object
1 property
ObjectError
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lakefs-objects-api-openapi.yml Raw ↑

Other APIs lakeFS publishes across the network.

lakeFS actions API
lakeFS auth API
lakeFS branches API
lakeFS commits API
lakeFS config API
lakeFS experimental API
lakeFS external API
lakeFS healthCheck API
lakeFS import API
lakeFS internal API
lakeFS metadata API
lakeFS pulls API
Where this information came from

This is an independent, third-party profile of lakeFS objects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.