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 experimental API

The experimental API from lakeFS — 14 operation(s) for experimental.

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

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

This API exposes 18 operations across 14 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

18 operations 14 paths 27 schemas 2 DELETE4 GET1 PATCH5 POST6 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 experimental 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 18

Across 14 paths, the API surfaces 18 operations — 2 DELETE, 4 GET, 1 PATCH, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

experimental 18
POST
/auth/external/principal/login
perform a login using an external authenticator
externalPrincipalLogin body → 200400401403404429default
POST
/sts/login
perform a login with STS
stsLogin body → 200400401429default
POST
/auth/users/{userId}/external/principals
attach external principal to user
createUserExternalPrincipal 2 params body → 201400401404409429default
DELETE
/auth/users/{userId}/external/principals
delete external principal from user
deleteUserExternalPrincipal 2 params → 204400401404429default
GET
/auth/users/{userId}/external/principals/ls
list user external policies attached to a user
listUserExternalPrincipals 4 params → 200400401404429default
GET
/auth/external/principals
describe external principal by id
getExternalPrincipal 1 param → 200400401404429default
PUT
/repositories/{repository}/branches/{branch}/hard_reset
hard reset branch
hardResetBranch 4 params → 204400401403404429default
POST
/repositories/{repository}/branches/{branch}/staging/pmpu
Initiate a multipart upload
createPresignMultipartUpload 4 params → 201400401404429default
PUT
/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}
Complete a presign multipart upload request
completePresignMultipartUpload 4 params body → 200400401404409429default
DELETE
/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}
Abort a presign multipart upload
abortPresignMultipartUpload 4 params body → 204400401404429default
PUT
/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}/parts/{partNumber}
Return a presigned URL to upload into a presigned multipart upload.
uploadPart 5 params body → 200400401404429default
PUT
/repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}/parts/{partNumber}/copy
Upload a part by copying part of another object.
uploadPartCopy 5 params body → 204400401404429default
PUT
/repositories/{repository}/branches/{branch}/objects/stat/user_metadata
rewrite (all) object metadata
updateObjectUserMetadata 3 params body → 201401404400429default
GET
/repositories/{repository}/pulls
list pull requests
listPullRequests 5 params → 200400401404429default
POST
/repositories/{repository}/pulls
create pull request
createPullRequest 1 param body → 201400401403404409429default
GET
/repositories/{repository}/pulls/{pull_request}
get pull request
getPullRequest 2 params → 200400401404429default
PATCH
/repositories/{repository}/pulls/{pull_request}
update pull request
updatePullRequest 2 params body → 200400401403404429default
PUT
/repositories/{repository}/pulls/{pull_request}/merge
merge pull request
mergePullRequest 2 params → 200400401403404409412429

Schemas 27

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

PullRequestCreationResponse
object
1 property 1 required
ObjectStats
object
9 properties 5 required
PullRequestCreation
object
4 properties 3 required
PullRequest
UploadPartCopyFrom
StsAuthRequest
object
4 properties 3 required
PullRequestBasic
object
3 properties
ObjectUserMetadata
object
ExternalPrincipal
object
3 properties 2 required
ExternalPrincipalCreation
object
1 property
PresignMultipartUpload
object
3 properties 2 required
CopyPartSource
object
4 properties 3 required
ExternalLoginInformation
object
2 properties 1 required
StagingLocation
object
location for placing an object when staging it
3 properties
ExternalPrincipalSettings
object
Additional settings to be consumed by the remote authenticator
CompletePresignMultipartUpload
object
4 properties 2 required
Error
object
1 property 1 required
PullRequestsList
object
2 properties 2 required
Pagination
object
4 properties 4 required
AbortPresignMultipartUpload
object
1 property 1 required
UploadPart
object
2 properties 2 required
UploadPartFrom
object
1 property 1 required
MergeResult
object
1 property 1 required
UpdateObjectUserMetadata
object
1 property 1 required
ExternalPrincipalList
object
2 properties 2 required
UploadTo
object
1 property 1 required
AuthenticationToken
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lakefs-experimental-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 external API
lakeFS healthCheck API
lakeFS import API
lakeFS internal API
lakeFS metadata API
lakeFS objects API
lakeFS pulls API
Where this information came from

This is an independent, third-party profile of lakeFS experimental 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.