/
TR
treeverse
/
lakeFS API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2m ago · Updated 7d ago
View markdown
treeverse
lakeFS API
get
check if the lakeFS installation is already set up
v52
latest
OpenAPI 3.0.0
Apache 2.0
raw.githubusercontent.com
2026-08-03
134
119
177.4 KB
actions
4
auth
36
branches
8
commits
2
config
1
experimental
7
external
1
healthCheck
1
import
3
internal
30
post
setup communications preferences
get
check if the lakeFS installation is already set up
post
setup lakeFS and create a first user
get
list authentication capabilities supported
post
set repository metadata
delete
delete repository metadata
put
Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations
put
Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations
post
create commit record
get
/repositories/{repository}/branches/{branch}/objects/stage_allowed
put
stage an object's metadata for the given branch
post
creates symlink files corresponding to the given directory
get
return a lakeFS metadata object by ID
get
/repositories/{repository}/gc/rules/set_allowed
get
/repositories/{repository}/gc/rules
post
/repositories/{repository}/gc/rules
delete
/repositories/{repository}/gc/rules
post
save lists of active commits for garbage collection
post
prepare gc commits
get
get status of prepare gc commits operation
post
save repository uncommitted metadata for garbage collection
get
/repositories/{repository}/branch_protection/set_allowed
get
get branch protection rules
post
/repositories/{repository}/branch_protection
delete
/repositories/{repository}/branch_protection
get
/config/version
get
/config/storage
get
/config/garbage-collection
post
post stats events, this endpoint is meant for internal use only
get
get usage report summary
metadata
2
objects
10
pulls
5
refs
4
repositories
14
staging
2
tags
4
internal
check if the lakeFS installation is already set up
get
/setup_lakefs
Response
lakeFS setup state
SetupState
required
state
'initialized'
|
'not_initialized'
comm_prefs_missing
boolean
true if the comm prefs are missing.
login_config
LoginConfig