lakefs-enterprise-sdk

lakeFS HTTP API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.97.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/treeverse/lakeFS-Enterprise.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/treeverse/lakeFS-Enterprise.git)

Then import the package:

import lakefs_enterprise_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import lakefs_enterprise_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import lakefs_enterprise_sdk
from lakefs_enterprise_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_enterprise_sdk.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_enterprise_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['oidc_auth'] = 'Bearer'

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_enterprise_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_enterprise_sdk.ActionsApi(api_client)
    repository = 'repository_example' # str | 
    run_id = 'run_id_example' # str | 

    try:
        # get a run
        api_response = api_instance.get_run(repository, run_id)
        print("The response of ActionsApi->get_run:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActionsApi->get_run: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api/v1

Class Method HTTP request Description
ActionsApi get_run GET /repositories/{repository}/actions/runs/{run_id} get a run
ActionsApi get_run_hook_output GET /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output get run hook output
ActionsApi list_repository_runs GET /repositories/{repository}/actions/runs list runs
ActionsApi list_run_hooks GET /repositories/{repository}/actions/runs/{run_id}/hooks list run hooks
AuthApi add_group_membership PUT /auth/groups/{groupId}/members/{userId} add group membership
AuthApi attach_policy_to_group PUT /auth/groups/{groupId}/policies/{policyId} attach policy to group
AuthApi attach_policy_to_user PUT /auth/users/{userId}/policies/{policyId} attach policy to user
AuthApi create_credentials POST /auth/users/{userId}/credentials create credentials
AuthApi create_group POST /auth/groups create group
AuthApi create_policy POST /auth/policies create policy
AuthApi create_user POST /auth/users create user
AuthApi create_user_external_principal POST /auth/users/{userId}/external/principals attach external principal to user
AuthApi delete_credentials DELETE /auth/users/{userId}/credentials/{accessKeyId} delete credentials
AuthApi delete_group DELETE /auth/groups/{groupId} delete group
AuthApi delete_group_membership DELETE /auth/groups/{groupId}/members/{userId} delete group membership
AuthApi delete_policy DELETE /auth/policies/{policyId} delete policy
AuthApi delete_user DELETE /auth/users/{userId} delete user
AuthApi delete_user_external_principal DELETE /auth/users/{userId}/external/principals delete external principal from user
AuthApi detach_policy_from_group DELETE /auth/groups/{groupId}/policies/{policyId} detach policy from group
AuthApi detach_policy_from_user DELETE /auth/users/{userId}/policies/{policyId} detach policy from user
AuthApi external_principal_login POST /auth/external/principal/login perform a login using an external authenticator
AuthApi get_credentials GET /auth/users/{userId}/credentials/{accessKeyId} get credentials
AuthApi get_current_user GET /user get current user
AuthApi get_external_principal GET /auth/external/principals describe external principal by id
AuthApi get_group GET /auth/groups/{groupId} get group
AuthApi get_policy GET /auth/policies/{policyId} get policy
AuthApi get_token_from_mailbox GET /auth/get-token/mailboxes/{mailbox} receive the token after user has authenticated on redirect URL.
AuthApi get_token_redirect GET /auth/get-token/start start acquiring a token by logging in on a browser
AuthApi get_user GET /auth/users/{userId} get user
AuthApi jwt_login POST /auth/jwt/login exchange an external IdP JWT for a lakeFS session token
AuthApi list_group_members GET /auth/groups/{groupId}/members list group members
AuthApi list_group_policies GET /auth/groups/{groupId}/policies list group policies
AuthApi list_groups GET /auth/groups list groups
AuthApi list_policies GET /auth/policies list policies
AuthApi list_user_credentials GET /auth/users/{userId}/credentials list user credentials
AuthApi list_user_external_principals GET /auth/users/{userId}/external/principals/ls list user external policies attached to a user
AuthApi list_user_groups GET /auth/users/{userId}/groups list user groups
AuthApi list_user_policies GET /auth/users/{userId}/policies list user policies
AuthApi list_users GET /auth/users list users
AuthApi login POST /auth/login perform a login
AuthApi oauth_callback GET /oidc/callback
AuthApi release_token_to_mailbox GET /auth/get-token/release-token/{loginRequestToken} release a token for the current (authenticated) user to the mailbox of this login request.
AuthApi update_policy PUT /auth/policies/{policyId} update policy
BranchesApi cherry_pick POST /repositories/{repository}/branches/{branch}/cherry-pick Replay the changes from the given commit on the branch
BranchesApi create_branch POST /repositories/{repository}/branches create branch
BranchesApi delete_branch DELETE /repositories/{repository}/branches/{branch} delete branch
BranchesApi diff_branch GET /repositories/{repository}/branches/{branch}/diff diff branch
BranchesApi get_branch GET /repositories/{repository}/branches/{branch} get branch
BranchesApi list_branches GET /repositories/{repository}/branches list branches
BranchesApi reset_branch PUT /repositories/{repository}/branches/{branch} reset branch
BranchesApi revert_branch POST /repositories/{repository}/branches/{branch}/revert revert
CommitsApi commit POST /repositories/{repository}/branches/{branch}/commits create commit
CommitsApi get_commit GET /repositories/{repository}/commits/{commitId} get commit
ConfigApi get_config GET /config
DatasetsApi close_dataset_pull_request DELETE /datasets/{dataset}/pulls/{pullRequest} close a pull request
DatasetsApi create_dataset POST /datasets create dataset
DatasetsApi create_dataset_metadata_key POST /datasets/metadata create a dataset metadata key
DatasetsApi delete_dataset DELETE /datasets/{dataset} delete dataset
DatasetsApi delete_dataset_metadata_key DELETE /datasets/metadata/{key} delete a dataset metadata key
DatasetsApi diff_dataset GET /datasets/{dataset}/refs/{leftRef}/diff/{rightRef} structured diff of a dataset definition between two refs
DatasetsApi diff_dataset_pull_request GET /datasets/{dataset}/pulls/{pullRequest}/diff compiled JSON diff (base vs proposed) for a pull request
DatasetsApi get_dataset GET /datasets/{dataset} get a dataset and its current definition
DatasetsApi get_dataset_by_ref GET /datasets/{dataset}/refs/{ref} get a dataset definition at a ref (latest or v<N>)
DatasetsApi get_dataset_metadata_key GET /datasets/metadata/{key} get a dataset metadata key
DatasetsApi get_dataset_pull_request GET /datasets/{dataset}/pulls/{pullRequest} get a dataset pull request
DatasetsApi get_dataset_version GET /datasets/{dataset}/versions/{version} get a single dataset version
DatasetsApi list_all_dataset_pull_requests GET /datasets/pulls global list of pull requests across datasets
DatasetsApi list_dataset_metadata_keys GET /datasets/metadata list dataset metadata keys
DatasetsApi list_dataset_pull_requests GET /datasets/{dataset}/pulls list a dataset's pull requests
DatasetsApi list_dataset_versions GET /datasets/{dataset}/versions list dataset versions, newest first
DatasetsApi list_datasets GET /datasets list datasets
DatasetsApi merge_dataset_pull_request POST /datasets/{dataset}/pulls/{pullRequest}/merge merge a pull request, publishing the next dataset version
DatasetsApi open_dataset_pull_request POST /datasets/{dataset}/pulls open a pull request proposing a dataset definition change
DatasetsApi update_dataset PUT /datasets/{dataset} update a dataset, publishing a new version
DatasetsApi update_dataset_metadata_key PUT /datasets/metadata/{key} update a dataset metadata key
DatasetsApi update_dataset_pull_request PATCH /datasets/{dataset}/pulls/{pullRequest} re-author a pull request (title, description, and/or proposed definition)
ExperimentalApi abort_presign_multipart_upload DELETE /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} Abort a presign multipart upload
ExperimentalApi attach_tenant_group PUT /auth/tenants/{tenantName}/groups/{groupId} attach group to tenant
ExperimentalApi attach_tenant_user PUT /auth/tenants/{tenantName}/users/{userId} attach user to tenant
ExperimentalApi close_dataset_pull_request DELETE /datasets/{dataset}/pulls/{pullRequest} close a pull request
ExperimentalApi commit_async POST /repositories/{repository}/branches/{branch}/commits/async create commit asynchronously
ExperimentalApi commit_async_status GET /repositories/{repository}/branches/{branch}/commits/async/{id}/status get status of async commit operation
ExperimentalApi complete_presign_multipart_upload PUT /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} Complete a presign multipart upload request
ExperimentalApi create_dataset POST /datasets create dataset
ExperimentalApi create_dataset_metadata_key POST /datasets/metadata create a dataset metadata key
ExperimentalApi create_presign_multipart_upload POST /repositories/{repository}/branches/{branch}/staging/pmpu Initiate a multipart upload
ExperimentalApi create_pull_request POST /repositories/{repository}/pulls create pull request
ExperimentalApi create_pull_request_comment POST /repositories/{repository}/pulls/{pull_request}/comments create pull request comment
ExperimentalApi create_tenant POST /auth/tenants create tenant
ExperimentalApi create_user_external_principal POST /auth/users/{userId}/external/principals attach external principal to user
ExperimentalApi delete_dataset DELETE /datasets/{dataset} delete dataset
ExperimentalApi delete_dataset_metadata_key DELETE /datasets/metadata/{key} delete a dataset metadata key
ExperimentalApi delete_object_lifecycle_rules DELETE /repositories/{repository}/settings/object_lifecycle clear all object lifecycle rules for this repository
ExperimentalApi delete_pull_request_comment DELETE /repositories/{repository}/pulls/{pull_request}/comments/{comment} delete pull request comment
ExperimentalApi delete_tenant DELETE /auth/tenants/{tenantName} delete tenant
ExperimentalApi delete_user_external_principal DELETE /auth/users/{userId}/external/principals delete external principal from user
ExperimentalApi detach_tenant_group DELETE /auth/tenants/{tenantName}/groups/{groupId} detach group from tenant
ExperimentalApi detach_tenant_user DELETE /auth/tenants/{tenantName}/users/{userId} detach user from tenant
ExperimentalApi diff_dataset GET /datasets/{dataset}/refs/{leftRef}/diff/{rightRef} structured diff of a dataset definition between two refs
ExperimentalApi diff_dataset_pull_request GET /datasets/{dataset}/pulls/{pullRequest}/diff compiled JSON diff (base vs proposed) for a pull request
ExperimentalApi external_principal_login POST /auth/external/principal/login perform a login using an external authenticator
ExperimentalApi get_dataset GET /datasets/{dataset} get a dataset and its current definition
ExperimentalApi get_dataset_by_ref GET /datasets/{dataset}/refs/{ref} get a dataset definition at a ref (latest or v<N>)
ExperimentalApi get_dataset_metadata_key GET /datasets/metadata/{key} get a dataset metadata key
ExperimentalApi get_dataset_pull_request GET /datasets/{dataset}/pulls/{pullRequest} get a dataset pull request
ExperimentalApi get_dataset_version GET /datasets/{dataset}/versions/{version} get a single dataset version
ExperimentalApi get_external_principal GET /auth/external/principals describe external principal by id
ExperimentalApi get_license GET /license
ExperimentalApi get_object_lifecycle_rules GET /repositories/{repository}/settings/object_lifecycle get object lifecycle rules
ExperimentalApi get_pull_request GET /repositories/{repository}/pulls/{pull_request} get pull request
ExperimentalApi get_pull_request_comment GET /repositories/{repository}/pulls/{pull_request}/comments/{comment} get pull request comment
ExperimentalApi get_tenant GET /auth/tenants/{tenantName} get tenant
ExperimentalApi get_token_from_mailbox GET /auth/get-token/mailboxes/{mailbox} receive the token after user has authenticated on redirect URL.
ExperimentalApi get_token_redirect GET /auth/get-token/start start acquiring a token by logging in on a browser
ExperimentalApi hard_reset_branch PUT /repositories/{repository}/branches/{branch}/hard_reset hard reset branch
ExperimentalApi jwt_login POST /auth/jwt/login exchange an external IdP JWT for a lakeFS session token
ExperimentalApi list_all_dataset_pull_requests GET /datasets/pulls global list of pull requests across datasets
ExperimentalApi list_dataset_metadata_keys GET /datasets/metadata list dataset metadata keys
ExperimentalApi list_dataset_pull_requests GET /datasets/{dataset}/pulls list a dataset's pull requests
ExperimentalApi list_dataset_versions GET /datasets/{dataset}/versions list dataset versions, newest first
ExperimentalApi list_datasets GET /datasets list datasets
ExperimentalApi list_pull_request_comments GET /repositories/{repository}/pulls/{pull_request}/comments list pull request comments
ExperimentalApi list_pull_requests GET /repositories/{repository}/pulls list pull requests
ExperimentalApi list_tenant_groups GET /auth/tenants/{tenantName}/groups list groups attached to tenant
ExperimentalApi list_tenant_users GET /auth/tenants/{tenantName}/users list users attached to tenant
ExperimentalApi list_tenants GET /auth/tenants list tenants
ExperimentalApi list_user_external_principals GET /auth/users/{userId}/external/principals/ls list user external policies attached to a user
ExperimentalApi list_user_tenants GET /user/tenants list the tenants the current user is a member of
ExperimentalApi merge_dataset_pull_request POST /datasets/{dataset}/pulls/{pullRequest}/merge merge a pull request, publishing the next dataset version
ExperimentalApi merge_into_branch_async POST /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch}/async merge references asynchronously
ExperimentalApi merge_into_branch_async_status GET /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch}/async/{id}/status get status of async merge operation
ExperimentalApi merge_pull_request PUT /repositories/{repository}/pulls/{pull_request}/merge merge pull request
ExperimentalApi open_dataset_pull_request POST /datasets/{dataset}/pulls open a pull request proposing a dataset definition change
ExperimentalApi release_token_to_mailbox GET /auth/get-token/release-token/{loginRequestToken} release a token for the current (authenticated) user to the mailbox of this login request.
ExperimentalApi run_mds_query POST /mds/query run a metadata search query
ExperimentalApi set_object_lifecycle_rules PUT /repositories/{repository}/settings/object_lifecycle replace all object lifecycle rules for this repository
ExperimentalApi sts_login POST /sts/login perform a login with STS
ExperimentalApi update_dataset PUT /datasets/{dataset} update a dataset, publishing a new version
ExperimentalApi update_dataset_metadata_key PUT /datasets/metadata/{key} update a dataset metadata key
ExperimentalApi update_dataset_pull_request PATCH /datasets/{dataset}/pulls/{pullRequest} re-author a pull request (title, description, and/or proposed definition)
ExperimentalApi update_object_user_metadata PUT /repositories/{repository}/branches/{branch}/objects/stat/user_metadata rewrite (all) object metadata
ExperimentalApi update_pull_request PATCH /repositories/{repository}/pulls/{pull_request} update pull request
ExperimentalApi update_pull_request_comment PATCH /repositories/{repository}/pulls/{pull_request}/comments/{comment} update pull request comment
ExperimentalApi update_tenant PATCH /auth/tenants/{tenantName} update tenant description
ExperimentalApi upload_part PUT /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}/parts/{partNumber}
ExperimentalApi upload_part_copy PUT /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId}/parts/{partNumber}/copy
ExternalApi create_user_external_principal POST /auth/users/{userId}/external/principals attach external principal to user
ExternalApi delete_user_external_principal DELETE /auth/users/{userId}/external/principals delete external principal from user
ExternalApi external_principal_login POST /auth/external/principal/login perform a login using an external authenticator
ExternalApi get_external_principal GET /auth/external/principals describe external principal by id
ExternalApi list_user_external_principals GET /auth/users/{userId}/external/principals/ls list user external policies attached to a user
HealthCheckApi health_check GET /healthcheck
ImportApi import_cancel DELETE /repositories/{repository}/branches/{branch}/import cancel ongoing import
ImportApi import_start POST /repositories/{repository}/branches/{branch}/import import data from object store
ImportApi import_status GET /repositories/{repository}/branches/{branch}/import get import status
InternalApi create_branch_protection_rule_preflight GET /repositories/{repository}/branch_protection/set_allowed
InternalApi create_commit_record POST /repositories/{repository}/commits create commit record
InternalApi create_symlink_file POST /repositories/{repository}/refs/{branch}/symlink creates symlink files corresponding to the given directory
InternalApi delete_repository_metadata DELETE /repositories/{repository}/metadata delete repository metadata
InternalApi dump_refs PUT /repositories/{repository}/refs/dump Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations
InternalApi get_auth_capabilities GET /auth/capabilities list authentication capabilities supported
InternalApi get_garbage_collection_config GET /config/garbage-collection
InternalApi get_lake_fs_version GET /config/version
InternalApi get_metadata_object GET /repositories/{repository}/metadata/object/{type}/{object_id} return a lakeFS metadata object by ID
InternalApi get_setup_state GET /setup_lakefs check if the lakeFS installation is already set up
InternalApi get_storage_config GET /config/storage
InternalApi get_usage_report_summary GET /usage-report/summary get usage report summary
InternalApi internal_create_branch_protection_rule POST /repositories/{repository}/branch_protection
InternalApi internal_delete_branch_protection_rule DELETE /repositories/{repository}/branch_protection
InternalApi internal_delete_garbage_collection_rules DELETE /repositories/{repository}/gc/rules
InternalApi internal_get_branch_protection_rules GET /repositories/{repository}/branch_protection get branch protection rules
InternalApi internal_get_garbage_collection_rules GET /repositories/{repository}/gc/rules
InternalApi internal_set_garbage_collection_rules POST /repositories/{repository}/gc/rules
InternalApi post_stats_events POST /statistics post stats events, this endpoint is meant for internal use only
InternalApi prepare_garbage_collection_commits POST /repositories/{repository}/gc/prepare_commits save lists of active commits for garbage collection
InternalApi prepare_garbage_collection_commits_async POST /repositories/{repository}/gc/prepare_commits/async prepare gc commits
InternalApi prepare_garbage_collection_commits_status GET /repositories/{repository}/gc/prepare_commits/status get status of prepare gc commits operation
InternalApi prepare_garbage_collection_uncommitted POST /repositories/{repository}/gc/prepare_uncommited save repository uncommitted metadata for garbage collection
InternalApi pull_request_comment_write_allowed GET /repositories/{repository}/pulls/{pull_request}/write_allowed check whether the user may write comments on this pull request
InternalApi restore_refs PUT /repositories/{repository}/refs/restore Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations
InternalApi set_branch_lifecycle_policies_preflight GET /repositories/{repository}/settings/branch_lifecycle/set_allowed
InternalApi set_garbage_collection_rules_preflight GET /repositories/{repository}/gc/rules/set_allowed
InternalApi set_repository_metadata POST /repositories/{repository}/metadata set repository metadata
InternalApi setup POST /setup_lakefs setup lakeFS and create a first user
InternalApi stage_object PUT /repositories/{repository}/branches/{branch}/objects stage an object's metadata for the given branch
InternalApi upload_object_preflight GET /repositories/{repository}/branches/{branch}/objects/stage_allowed
LicenseApi get_license GET /license
MetadataApi get_meta_range GET /repositories/{repository}/metadata/meta_range/{meta_range} return URI to a meta-range file
MetadataApi get_range GET /repositories/{repository}/metadata/range/{range} return URI to a range file
MetadataApi run_mds_query POST /mds/query run a metadata search query
ObjectsApi copy_object POST /repositories/{repository}/branches/{branch}/objects/copy create a copy of an object
ObjectsApi delete_object DELETE /repositories/{repository}/branches/{branch}/objects delete object. Missing objects will not return a NotFound error.
ObjectsApi delete_objects POST /repositories/{repository}/branches/{branch}/objects/delete delete objects. Missing objects will not return a NotFound error.
ObjectsApi get_object GET /repositories/{repository}/refs/{ref}/objects get object content
ObjectsApi get_underlying_properties GET /repositories/{repository}/refs/{ref}/objects/underlyingProperties get object properties on underlying storage
ObjectsApi head_object HEAD /repositories/{repository}/refs/{ref}/objects check if object exists
ObjectsApi list_objects GET /repositories/{repository}/refs/{ref}/objects/ls list objects under a given prefix
ObjectsApi stat_object GET /repositories/{repository}/refs/{ref}/objects/stat get object metadata
ObjectsApi update_object_user_metadata PUT /repositories/{repository}/branches/{branch}/objects/stat/user_metadata rewrite (all) object metadata
ObjectsApi upload_object POST /repositories/{repository}/branches/{branch}/objects
PullsApi create_pull_request POST /repositories/{repository}/pulls create pull request
PullsApi create_pull_request_comment POST /repositories/{repository}/pulls/{pull_request}/comments create pull request comment
PullsApi delete_pull_request_comment DELETE /repositories/{repository}/pulls/{pull_request}/comments/{comment} delete pull request comment
PullsApi get_pull_request GET /repositories/{repository}/pulls/{pull_request} get pull request
PullsApi get_pull_request_comment GET /repositories/{repository}/pulls/{pull_request}/comments/{comment} get pull request comment
PullsApi list_pull_request_comments GET /repositories/{repository}/pulls/{pull_request}/comments list pull request comments
PullsApi list_pull_requests GET /repositories/{repository}/pulls list pull requests
PullsApi merge_pull_request PUT /repositories/{repository}/pulls/{pull_request}/merge merge pull request
PullsApi update_pull_request PATCH /repositories/{repository}/pulls/{pull_request} update pull request
PullsApi update_pull_request_comment PATCH /repositories/{repository}/pulls/{pull_request}/comments/{comment} update pull request comment
RefsApi diff_refs GET /repositories/{repository}/refs/{leftRef}/diff/{rightRef} diff references
RefsApi find_merge_base GET /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} find the merge base for 2 references
RefsApi log_commits GET /repositories/{repository}/refs/{ref}/commits get commit log from ref. If both objects and prefixes are empty, return all commits.
RefsApi merge_into_branch POST /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} merge references
RemotesApi pull_iceberg_table POST /iceberg/remotes/{catalog}/pull take a table previously pushed from lakeFS into a remote catalog, and pull its state back into the originating lakeFS repository
RemotesApi push_iceberg_table POST /iceberg/remotes/{catalog}/push register existing lakeFS table in remote catalog
RepositoriesApi create_repository POST /repositories create repository
RepositoriesApi delete_branch_lifecycle_policies DELETE /repositories/{repository}/settings/branch_lifecycle/policies clear all branch lifecycle policies for this repository
RepositoriesApi delete_gc_rules DELETE /repositories/{repository}/settings/gc_rules
RepositoriesApi delete_object_lifecycle_rules DELETE /repositories/{repository}/settings/object_lifecycle clear all object lifecycle rules for this repository
RepositoriesApi delete_repository DELETE /repositories/{repository} delete repository
RepositoriesApi dump_status GET /repositories/{repository}/dump Status of a repository dump task
RepositoriesApi dump_submit POST /repositories/{repository}/dump Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
RepositoriesApi get_branch_lifecycle_policies GET /repositories/{repository}/settings/branch_lifecycle/policies get branch lifecycle policies
RepositoriesApi get_branch_protection_rules GET /repositories/{repository}/settings/branch_protection get branch protection rules
RepositoriesApi get_gc_rules GET /repositories/{repository}/settings/gc_rules get repository GC rules
RepositoriesApi get_object_lifecycle_rules GET /repositories/{repository}/settings/object_lifecycle get object lifecycle rules
RepositoriesApi get_pull_request_settings GET /repositories/{repository}/settings/pull_request get repository pull request settings
RepositoriesApi get_repository GET /repositories/{repository} get repository
RepositoriesApi get_repository_metadata GET /repositories/{repository}/metadata get repository metadata
RepositoriesApi list_repositories GET /repositories list repositories
RepositoriesApi restore_status GET /repositories/{repository}/restore Status of a restore request
RepositoriesApi restore_submit POST /repositories/{repository}/restore Restore repository from a dump in the object store
RepositoriesApi set_branch_lifecycle_policies PUT /repositories/{repository}/settings/branch_lifecycle/policies
RepositoriesApi set_branch_protection_rules PUT /repositories/{repository}/settings/branch_protection
RepositoriesApi set_gc_rules PUT /repositories/{repository}/settings/gc_rules
RepositoriesApi set_object_lifecycle_rules PUT /repositories/{repository}/settings/object_lifecycle replace all object lifecycle rules for this repository
RepositoriesApi set_pull_request_settings PUT /repositories/{repository}/settings/pull_request set repository pull request settings
StagingApi get_physical_address GET /repositories/{repository}/branches/{branch}/staging/backing generate an address to which the client can upload an object
StagingApi link_physical_address PUT /repositories/{repository}/branches/{branch}/staging/backing associate staging on this physical address with a path
TagsApi create_tag POST /repositories/{repository}/tags create tag
TagsApi delete_tag DELETE /repositories/{repository}/tags/{tag} delete tag
TagsApi get_tag GET /repositories/{repository}/tags/{tag} get tag
TagsApi list_tags GET /repositories/{repository}/tags list tags

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basic_auth

  • Type: HTTP basic authentication

jwt_token

  • Type: Bearer authentication (JWT)

cookie_auth

  • Type: API key
  • API key parameter name: internal_auth_session
  • Location:

oidc_auth

  • Type: API key
  • API key parameter name: oidc_auth_session
  • Location:

saml_auth

  • Type: API key
  • API key parameter name: saml_auth_session
  • Location:

Author

services@treeverse.io

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for treeverse from gravatar.com treeverse

Credits

Author: Treeverse

License

Apache 2.0

Requires

Python >=3.10

Tags

OpenAPI OpenAPI-Generator lakeFS API

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lakefs_enterprise_sdk-1.97.0.tar.gz (185.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lakefs_enterprise_sdk-1.97.0-py3-none-any.whl (319.7 kB view details)

Uploaded Python 3

File details

Details for the file lakefs_enterprise_sdk-1.97.0.tar.gz.

File metadata

  • Download URL: lakefs_enterprise_sdk-1.97.0.tar.gz
  • Upload date:
  • Size: 185.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lakefs_enterprise_sdk-1.97.0.tar.gz
Algorithm Hash digest
SHA256 4fe180a4c0a4bf0a6df1ba6b573125c6addbee0ab4e7c61b79e99907a9a22945
MD5 f227df9b9882a584304e5c6033a7b444
BLAKE2b-256 ed1b76046103a8a4e192ccbd437f94730647bdd1bf97369a6402957eb30f3cbb

See more details on using hashes here.

File details

Details for the file lakefs_enterprise_sdk-1.97.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lakefs_enterprise_sdk-1.97.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67a33f14fa330e0f62abcc57412adbfc31d0f8d734d73f56c081fd51bb26da84
MD5 282920c098b7254e4752c6741e385503
BLAKE2b-256 4c8133df32237c9c674af262ebf6adc22f1cab4cb5744473fc836cd31076874d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.97.0 This release

2 files

1.96.0

2 files

1.95.0

2 files

1.94.0

2 files

1.93.0

2 files

1.92.0

2 files

1.91.0

2 files

1.90.1

2 files

1.90.0

2 files

1.89.0

2 files

1.88.0

2 files

1.87.0

2 files

1.86.0

2 files

1.85.1

2 files

1.85.0

2 files

1.84.0

2 files

1.83.0

2 files

1.82.0

2 files

1.81.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page