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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
lakeFS

lakeFS internal API

The internal API from lakeFS — 24 operation(s) for internal.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 30 operations across 24 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

30 operations 24 paths 32 schemas 3 DELETE13 GET11 POST3 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
Apache 2.0
Resource Areas
1

Authentication & Security 5

lakeFS internal 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 30

Across 24 paths, the API surfaces 30 operations — 3 DELETE, 13 GET, 11 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

internal 30
POST
/setup_comm_prefs
setup communications preferences
setupCommPrefs body → 200400409412429default
GET
/setup_lakefs
check if the lakeFS installation is already set up
getSetupState → 200429default
POST
/setup_lakefs
setup lakeFS and create a first user
setup body → 200400409429default
GET
/auth/capabilities
list authentication capabilities supported
getAuthCapabilities → 200429default
POST
/repositories/{repository}/metadata
set repository metadata
setRepositoryMetadata 1 param body → 204400401404429default
DELETE
/repositories/{repository}/metadata
delete repository metadata
deleteRepositoryMetadata 1 param body → 204400401429default
PUT
/repositories/{repository}/refs/dump
Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations
dumpRefs 1 param → 201400401404429default
PUT
/repositories/{repository}/refs/restore
Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations
restoreRefs 1 param body → 200400401404429default
POST
/repositories/{repository}/commits
create commit record
CreateCommitRecord 1 param body → 204400401403404429default
GET
/repositories/{repository}/branches/{branch}/objects/stage_allowed
uploadObjectPreflight 3 params → 204400401403404429default
PUT
/repositories/{repository}/branches/{branch}/objectsdeprecated
stage an object's metadata for the given branch
stageObject 3 params body → 201400401403404429default
POST
/repositories/{repository}/refs/{branch}/symlink
creates symlink files corresponding to the given directory
createSymlinkFile 3 params → 201400401404429default
GET
/repositories/{repository}/metadata/object/{type}/{object_id}
return a lakeFS metadata object by ID
getMetadataObject 4 params → 200302400401404429default
GET
/repositories/{repository}/gc/rules/set_allowed
setGarbageCollectionRulesPreflight 1 param → 204400401404429default
GET
/repositories/{repository}/gc/rulesdeprecated
Deprecated; use getGCRules.
internalGetGarbageCollectionRules 1 param → 200400401404429default
POST
/repositories/{repository}/gc/rulesdeprecated
Deprecated; use setGCRules.
internalSetGarbageCollectionRules 1 param body → 204400401404429default
DELETE
/repositories/{repository}/gc/rulesdeprecated
Deprecated; use deleteGCRules.
internalDeleteGarbageCollectionRules 1 param → 204400401404429default
POST
/repositories/{repository}/gc/prepare_commits
save lists of active commits for garbage collection
prepareGarbageCollectionCommits 1 param → 201400401403404429default
POST
/repositories/{repository}/gc/prepare_commits/async
prepare gc commits
prepareGarbageCollectionCommitsAsync 1 param → 202400401403404429default
GET
/repositories/{repository}/gc/prepare_commits/status
get status of prepare gc commits operation
prepareGarbageCollectionCommitsStatus 2 params → 200400401403404429default
POST
/repositories/{repository}/gc/prepare_uncommited
save repository uncommitted metadata for garbage collection
prepareGarbageCollectionUncommitted 1 param body → 201400401403404429default
GET
/repositories/{repository}/branch_protection/set_allowed
createBranchProtectionRulePreflight 1 param → 204400401404409429default
GET
/repositories/{repository}/branch_protectiondeprecated
get branch protection rules
internalGetBranchProtectionRules 1 param → 200400401404429default
POST
/repositories/{repository}/branch_protectiondeprecated
internalCreateBranchProtectionRule 1 param body → 204400401404429default
DELETE
/repositories/{repository}/branch_protectiondeprecated
internalDeleteBranchProtectionRule 1 param body → 204400401404429default
GET
/config/versiondeprecated
get version of lakeFS server
getLakeFSVersion → 200401
GET
/config/storagedeprecated
retrieve lakeFS storage configuration
getStorageConfig → 200401
GET
/config/garbage-collection
get information of gc settings
getGarbageCollectionConfig → 200401
POST
/statistics
post stats events, this endpoint is meant for internal use only
postStatsEvents body → 204400401429default
GET
/usage-report/summary
get usage report summary
getUsageReportSummary → 200401404429default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are StorageConfig (11 properties), CommitRecordCreation (10 properties), LoginConfig (10 properties), ObjectStats (9 properties). Each schema is shown below with its type and property counts.

TaskCreation
object
1 property 1 required
LoginConfig
object
10 properties 3 required
PrepareGCUncommittedRequest
object
1 property
ObjectStats
object
9 properties 5 required
AuthCapabilities
object
2 properties
StatsEventsList
object
1 property 1 required
Setup
object
8 properties 1 required
AccessKeyCredentials
object
2 properties 2 required
CommitRecordCreation
object
10 properties 8 required
StorageURI
object
URI to a path in a storage provider (e.g. "s3://bucket1/path/to/object")
1 property 1 required
ObjectUserMetadata
object
RepositoryMetadataKeys
object
1 property 1 required
PrepareGarbageCollectionCommitsStatus
object
5 properties 3 required
SetupState
object
3 properties
GarbageCollectionRules
object
2 properties 2 required
StatsEvent
object
3 properties 3 required
PrepareGCUncommittedResponse
object
3 properties 2 required
BranchProtectionRule
object
1 property 1 required
RefsDump
object
3 properties 3 required
CommPrefsInput
object
6 properties 2 required
Error
object
1 property 1 required
GarbageCollectionRule
object
2 properties 2 required
RefsRestore
object
4 properties 3 required
ObjectStageCreation
object
7 properties 3 required
RepositoryMetadataSet
object
1 property 1 required
VersionConfig
object
5 properties
StorageConfig
object
11 properties 7 required
UsageReport
object
3 properties 3 required
GarbageCollectionPrepareResponse
object
4 properties 3 required
GarbageCollectionConfig
object
1 property
CredentialsWithSecret
object
3 properties 3 required
InstallationUsageReport
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lakefs-internal-api-openapi.yml Raw ↑

Other APIs lakeFS publishes across the network.

lakeFS actions API
AE Profile APIs.io
lakeFS auth API
AE Profile APIs.io
lakeFS branches API
AE Profile APIs.io
lakeFS commits API
AE Profile APIs.io
lakeFS config API
AE Profile APIs.io
lakeFS experimental API
AE Profile APIs.io
lakeFS external API
AE Profile APIs.io
lakeFS healthCheck API
AE Profile APIs.io
lakeFS import API
AE Profile APIs.io
lakeFS metadata API
AE Profile APIs.io
lakeFS objects API
AE Profile APIs.io
lakeFS pulls API
AE Profile APIs.io
#Internal
← Back to L APIs
API Details
ID
lakefs:lakefs-internal-api
Server
/api/v1
Docs
https://lakefs.io/
Provider
lakeFS
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lakefs-internal-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lakefs-internal-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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