lakefs-sdk


Namelakefs-sdk JSON
Version 1.20.0 PyPI version JSON
download
home_pagehttps://github.com/treeverse/lakeFS/tree/master/clients/python
SummarylakeFS API
upload_time2024-04-16 13:34:23
maintainerNone
docs_urlNone
authorTreeverse
requires_python>=3.6
licenseApache 2.0
keywords openapi openapi-generator lakefs api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # lakefs-sdk
lakeFS HTTP API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.20.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:

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

Then import the package:
```python
import lakefs_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import lakefs_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import lakefs_sdk
from lakefs_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_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_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_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lakefs_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**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#get_run) | **GET** /repositories/{repository}/actions/runs/{run_id} | get a run
*ActionsApi* | [**get_run_hook_output**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#get_run_hook_output) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output | get run hook output
*ActionsApi* | [**list_repository_runs**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#list_repository_runs) | **GET** /repositories/{repository}/actions/runs | list runs
*ActionsApi* | [**list_run_hooks**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#list_run_hooks) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks | list run hooks
*AuthApi* | [**add_group_membership**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#add_group_membership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership
*AuthApi* | [**attach_policy_to_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#attach_policy_to_group) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group
*AuthApi* | [**attach_policy_to_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#attach_policy_to_user) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user
*AuthApi* | [**create_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_credentials) | **POST** /auth/users/{userId}/credentials | create credentials
*AuthApi* | [**create_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_group) | **POST** /auth/groups | create group
*AuthApi* | [**create_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_policy) | **POST** /auth/policies | create policy
*AuthApi* | [**create_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_user) | **POST** /auth/users | create user
*AuthApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
*AuthApi* | [**delete_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_credentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials
*AuthApi* | [**delete_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_group) | **DELETE** /auth/groups/{groupId} | delete group
*AuthApi* | [**delete_group_membership**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_group_membership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership
*AuthApi* | [**delete_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_policy) | **DELETE** /auth/policies/{policyId} | delete policy
*AuthApi* | [**delete_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_user) | **DELETE** /auth/users/{userId} | delete user
*AuthApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
*AuthApi* | [**detach_policy_from_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group
*AuthApi* | [**detach_policy_from_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user
*AuthApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
*AuthApi* | [**get_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials
*AuthApi* | [**get_current_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_current_user) | **GET** /user | get current user
*AuthApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
*AuthApi* | [**get_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_group) | **GET** /auth/groups/{groupId} | get group
*AuthApi* | [**get_group_acl**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_group_acl) | **GET** /auth/groups/{groupId}/acl | get ACL of group
*AuthApi* | [**get_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_policy) | **GET** /auth/policies/{policyId} | get policy
*AuthApi* | [**get_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_user) | **GET** /auth/users/{userId} | get user
*AuthApi* | [**list_group_members**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_group_members) | **GET** /auth/groups/{groupId}/members | list group members
*AuthApi* | [**list_group_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_group_policies) | **GET** /auth/groups/{groupId}/policies | list group policies
*AuthApi* | [**list_groups**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_groups) | **GET** /auth/groups | list groups
*AuthApi* | [**list_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_policies) | **GET** /auth/policies | list policies
*AuthApi* | [**list_user_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_credentials) | **GET** /auth/users/{userId}/credentials | list user credentials
*AuthApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
*AuthApi* | [**list_user_groups**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_groups) | **GET** /auth/users/{userId}/groups | list user groups
*AuthApi* | [**list_user_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_policies) | **GET** /auth/users/{userId}/policies | list user policies
*AuthApi* | [**list_users**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_users) | **GET** /auth/users | list users
*AuthApi* | [**login**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#login) | **POST** /auth/login | perform a login
*AuthApi* | [**set_group_acl**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#set_group_acl) | **POST** /auth/groups/{groupId}/acl | set ACL of group
*AuthApi* | [**update_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#update_policy) | **PUT** /auth/policies/{policyId} | update policy
*BranchesApi* | [**cherry_pick**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#cherry_pick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch
*BranchesApi* | [**create_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#create_branch) | **POST** /repositories/{repository}/branches | create branch
*BranchesApi* | [**delete_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#delete_branch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch
*BranchesApi* | [**diff_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#diff_branch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch
*BranchesApi* | [**get_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#get_branch) | **GET** /repositories/{repository}/branches/{branch} | get branch
*BranchesApi* | [**list_branches**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#list_branches) | **GET** /repositories/{repository}/branches | list branches
*BranchesApi* | [**reset_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#reset_branch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch
*BranchesApi* | [**revert_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#revert_branch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert
*CommitsApi* | [**commit**](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitsApi.html#commit) | **POST** /repositories/{repository}/branches/{branch}/commits | create commit
*CommitsApi* | [**get_commit**](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitsApi.html#get_commit) | **GET** /repositories/{repository}/commits/{commitId} | get commit
*ConfigApi* | [**get_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/ConfigApi.html#get_config) | **GET** /config | 
*ExperimentalApi* | [**abort_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#abort_presign_multipart_upload) | **DELETE** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Abort a presign multipart upload
*ExperimentalApi* | [**complete_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#complete_presign_multipart_upload) | **PUT** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Complete a presign multipart upload request
*ExperimentalApi* | [**create_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#create_presign_multipart_upload) | **POST** /repositories/{repository}/branches/{branch}/staging/pmpu | Initiate a multipart upload
*ExperimentalApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
*ExperimentalApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
*ExperimentalApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
*ExperimentalApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
*ExperimentalApi* | [**hard_reset_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#hard_reset_branch) | **PUT** /repositories/{repository}/branches/{branch}/hard_reset | hard reset branch
*ExperimentalApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
*ExperimentalApi* | [**sts_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#sts_login) | **POST** /sts/login | perform a login with STS
*ExternalApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
*ExternalApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
*ExternalApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
*ExternalApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
*ExternalApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
*HealthCheckApi* | [**health_check**](https://pydocs-sdk.lakefs.io/v1.20/docs/HealthCheckApi.html#health_check) | **GET** /healthcheck | 
*ImportApi* | [**import_cancel**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_cancel) | **DELETE** /repositories/{repository}/branches/{branch}/import | cancel ongoing import
*ImportApi* | [**import_start**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_start) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store
*ImportApi* | [**import_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_status) | **GET** /repositories/{repository}/branches/{branch}/import | get import status
*InternalApi* | [**create_branch_protection_rule_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | 
*InternalApi* | [**create_commit_record**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_commit_record) | **POST** /repositories/{repository}/commits | create commit record
*InternalApi* | [**create_symlink_file**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_symlink_file) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory
*InternalApi* | [**delete_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#delete_repository_metadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata
*InternalApi* | [**dump_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#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**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported
*InternalApi* | [**get_garbage_collection_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_garbage_collection_config) | **GET** /config/garbage-collection | 
*InternalApi* | [**get_lake_fs_version**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_lake_fs_version) | **GET** /config/version | 
*InternalApi* | [**get_setup_state**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up
*InternalApi* | [**get_storage_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_storage_config) | **GET** /config/storage | 
*InternalApi* | [**get_usage_report_summary**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_usage_report_summary) | **GET** /usage-report/summary | get usage report summary
*InternalApi* | [**internal_create_branch_protection_rule**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | 
*InternalApi* | [**internal_delete_branch_protection_rule**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | 
*InternalApi* | [**internal_delete_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_delete_garbage_collection_rules) | **DELETE** /repositories/{repository}/gc/rules | 
*InternalApi* | [**internal_get_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_get_branch_protection_rules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules
*InternalApi* | [**internal_get_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_get_garbage_collection_rules) | **GET** /repositories/{repository}/gc/rules | 
*InternalApi* | [**internal_set_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | 
*InternalApi* | [**post_stats_events**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only
*InternalApi* | [**prepare_garbage_collection_commits**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection
*InternalApi* | [**prepare_garbage_collection_uncommitted**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection
*InternalApi* | [**restore_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#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_garbage_collection_rules_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | 
*InternalApi* | [**set_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#set_repository_metadata) | **POST** /repositories/{repository}/metadata | set repository metadata
*InternalApi* | [**setup**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user
*InternalApi* | [**setup_comm_prefs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences
*InternalApi* | [**stage_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch
*InternalApi* | [**upload_object_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | 
*MetadataApi* | [**get_meta_range**](https://pydocs-sdk.lakefs.io/v1.20/docs/MetadataApi.html#get_meta_range) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file
*MetadataApi* | [**get_range**](https://pydocs-sdk.lakefs.io/v1.20/docs/MetadataApi.html#get_range) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file
*ObjectsApi* | [**copy_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#copy_object) | **POST** /repositories/{repository}/branches/{branch}/objects/copy | create a copy of an object
*ObjectsApi* | [**delete_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#delete_object) | **DELETE** /repositories/{repository}/branches/{branch}/objects | delete object. Missing objects will not return a NotFound error.
*ObjectsApi* | [**delete_objects**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#delete_objects) | **POST** /repositories/{repository}/branches/{branch}/objects/delete | delete objects. Missing objects will not return a NotFound error.
*ObjectsApi* | [**get_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#get_object) | **GET** /repositories/{repository}/refs/{ref}/objects | get object content
*ObjectsApi* | [**get_underlying_properties**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#get_underlying_properties) | **GET** /repositories/{repository}/refs/{ref}/objects/underlyingProperties | get object properties on underlying storage
*ObjectsApi* | [**head_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#head_object) | **HEAD** /repositories/{repository}/refs/{ref}/objects | check if object exists
*ObjectsApi* | [**list_objects**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#list_objects) | **GET** /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix
*ObjectsApi* | [**stat_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata
*ObjectsApi* | [**upload_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | 
*RefsApi* | [**diff_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#diff_refs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references
*RefsApi* | [**find_merge_base**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#find_merge_base) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references
*RefsApi* | [**log_commits**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#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**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#merge_into_branch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references
*RepositoriesApi* | [**create_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#create_repository) | **POST** /repositories | create repository
*RepositoriesApi* | [**delete_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#delete_gc_rules) | **DELETE** /repositories/{repository}/settings/gc_rules | 
*RepositoriesApi* | [**delete_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#delete_repository) | **DELETE** /repositories/{repository} | delete repository
*RepositoriesApi* | [**dump_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#dump_status) | **GET** /repositories/{repository}/dump | Status of a repository dump task
*RepositoriesApi* | [**dump_submit**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#dump_submit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
*RepositoriesApi* | [**get_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_branch_protection_rules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules
*RepositoriesApi* | [**get_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_gc_rules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules
*RepositoriesApi* | [**get_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_repository) | **GET** /repositories/{repository} | get repository
*RepositoriesApi* | [**get_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_repository_metadata) | **GET** /repositories/{repository}/metadata | get repository metadata
*RepositoriesApi* | [**list_repositories**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#list_repositories) | **GET** /repositories | list repositories
*RepositoriesApi* | [**restore_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#restore_status) | **GET** /repositories/{repository}/restore | Status of a restore request
*RepositoriesApi* | [**restore_submit**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#restore_submit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store
*RepositoriesApi* | [**set_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#set_branch_protection_rules) | **PUT** /repositories/{repository}/settings/branch_protection | 
*RepositoriesApi* | [**set_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#set_gc_rules) | **PUT** /repositories/{repository}/settings/gc_rules | 
*StagingApi* | [**get_physical_address**](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingApi.html#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**](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingApi.html#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path
*TagsApi* | [**create_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#create_tag) | **POST** /repositories/{repository}/tags | create tag
*TagsApi* | [**delete_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#delete_tag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag
*TagsApi* | [**get_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#get_tag) | **GET** /repositories/{repository}/tags/{tag} | get tag
*TagsApi* | [**list_tags**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#list_tags) | **GET** /repositories/{repository}/tags | list tags


## Documentation For Models

 - [ACL](https://pydocs-sdk.lakefs.io/v1.20/docs/ACL.html)
 - [AbortPresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/AbortPresignMultipartUpload.html)
 - [AccessKeyCredentials](https://pydocs-sdk.lakefs.io/v1.20/docs/AccessKeyCredentials.html)
 - [ActionRun](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionRun.html)
 - [ActionRunList](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionRunList.html)
 - [AuthCapabilities](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthCapabilities.html)
 - [AuthenticationToken](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthenticationToken.html)
 - [BranchCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchCreation.html)
 - [BranchProtectionRule](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchProtectionRule.html)
 - [CherryPickCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CherryPickCreation.html)
 - [CommPrefsInput](https://pydocs-sdk.lakefs.io/v1.20/docs/CommPrefsInput.html)
 - [Commit](https://pydocs-sdk.lakefs.io/v1.20/docs/Commit.html)
 - [CommitCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitCreation.html)
 - [CommitList](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitList.html)
 - [CommitRecordCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitRecordCreation.html)
 - [CompletePresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/CompletePresignMultipartUpload.html)
 - [Config](https://pydocs-sdk.lakefs.io/v1.20/docs/Config.html)
 - [Credentials](https://pydocs-sdk.lakefs.io/v1.20/docs/Credentials.html)
 - [CredentialsList](https://pydocs-sdk.lakefs.io/v1.20/docs/CredentialsList.html)
 - [CredentialsWithSecret](https://pydocs-sdk.lakefs.io/v1.20/docs/CredentialsWithSecret.html)
 - [CurrentUser](https://pydocs-sdk.lakefs.io/v1.20/docs/CurrentUser.html)
 - [Diff](https://pydocs-sdk.lakefs.io/v1.20/docs/Diff.html)
 - [DiffList](https://pydocs-sdk.lakefs.io/v1.20/docs/DiffList.html)
 - [Error](https://pydocs-sdk.lakefs.io/v1.20/docs/Error.html)
 - [ErrorNoACL](https://pydocs-sdk.lakefs.io/v1.20/docs/ErrorNoACL.html)
 - [ExternalLoginInformation](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalLoginInformation.html)
 - [ExternalPrincipal](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipal.html)
 - [ExternalPrincipalCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipalCreation.html)
 - [ExternalPrincipalList](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipalList.html)
 - [FindMergeBaseResult](https://pydocs-sdk.lakefs.io/v1.20/docs/FindMergeBaseResult.html)
 - [GarbageCollectionConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionConfig.html)
 - [GarbageCollectionPrepareResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionPrepareResponse.html)
 - [GarbageCollectionRule](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionRule.html)
 - [GarbageCollectionRules](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionRules.html)
 - [Group](https://pydocs-sdk.lakefs.io/v1.20/docs/Group.html)
 - [GroupCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/GroupCreation.html)
 - [GroupList](https://pydocs-sdk.lakefs.io/v1.20/docs/GroupList.html)
 - [HookRun](https://pydocs-sdk.lakefs.io/v1.20/docs/HookRun.html)
 - [HookRunList](https://pydocs-sdk.lakefs.io/v1.20/docs/HookRunList.html)
 - [ImportCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportCreation.html)
 - [ImportCreationResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportCreationResponse.html)
 - [ImportLocation](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportLocation.html)
 - [ImportStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportStatus.html)
 - [InstallationUsageReport](https://pydocs-sdk.lakefs.io/v1.20/docs/InstallationUsageReport.html)
 - [InternalDeleteBranchProtectionRuleRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalDeleteBranchProtectionRuleRequest.html)
 - [LoginConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/LoginConfig.html)
 - [LoginInformation](https://pydocs-sdk.lakefs.io/v1.20/docs/LoginInformation.html)
 - [Merge](https://pydocs-sdk.lakefs.io/v1.20/docs/Merge.html)
 - [MergeResult](https://pydocs-sdk.lakefs.io/v1.20/docs/MergeResult.html)
 - [MetaRangeCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/MetaRangeCreation.html)
 - [MetaRangeCreationResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/MetaRangeCreationResponse.html)
 - [ObjectCopyCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectCopyCreation.html)
 - [ObjectError](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectError.html)
 - [ObjectErrorList](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectErrorList.html)
 - [ObjectStageCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStageCreation.html)
 - [ObjectStats](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStats.html)
 - [ObjectStatsList](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStatsList.html)
 - [Pagination](https://pydocs-sdk.lakefs.io/v1.20/docs/Pagination.html)
 - [PathList](https://pydocs-sdk.lakefs.io/v1.20/docs/PathList.html)
 - [Policy](https://pydocs-sdk.lakefs.io/v1.20/docs/Policy.html)
 - [PolicyList](https://pydocs-sdk.lakefs.io/v1.20/docs/PolicyList.html)
 - [PrepareGCUncommittedRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/PrepareGCUncommittedRequest.html)
 - [PrepareGCUncommittedResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/PrepareGCUncommittedResponse.html)
 - [PresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/PresignMultipartUpload.html)
 - [RangeMetadata](https://pydocs-sdk.lakefs.io/v1.20/docs/RangeMetadata.html)
 - [Ref](https://pydocs-sdk.lakefs.io/v1.20/docs/Ref.html)
 - [RefList](https://pydocs-sdk.lakefs.io/v1.20/docs/RefList.html)
 - [RefsDump](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsDump.html)
 - [RefsRestore](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsRestore.html)
 - [Repository](https://pydocs-sdk.lakefs.io/v1.20/docs/Repository.html)
 - [RepositoryCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryCreation.html)
 - [RepositoryDumpStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryDumpStatus.html)
 - [RepositoryList](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryList.html)
 - [RepositoryMetadataKeys](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryMetadataKeys.html)
 - [RepositoryMetadataSet](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryMetadataSet.html)
 - [RepositoryRestoreStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryRestoreStatus.html)
 - [ResetCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ResetCreation.html)
 - [RevertCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/RevertCreation.html)
 - [Setup](https://pydocs-sdk.lakefs.io/v1.20/docs/Setup.html)
 - [SetupState](https://pydocs-sdk.lakefs.io/v1.20/docs/SetupState.html)
 - [StagingLocation](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingLocation.html)
 - [StagingMetadata](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingMetadata.html)
 - [Statement](https://pydocs-sdk.lakefs.io/v1.20/docs/Statement.html)
 - [StatsEvent](https://pydocs-sdk.lakefs.io/v1.20/docs/StatsEvent.html)
 - [StatsEventsList](https://pydocs-sdk.lakefs.io/v1.20/docs/StatsEventsList.html)
 - [StorageConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/StorageConfig.html)
 - [StorageURI](https://pydocs-sdk.lakefs.io/v1.20/docs/StorageURI.html)
 - [StsAuthRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/StsAuthRequest.html)
 - [TagCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/TagCreation.html)
 - [TaskInfo](https://pydocs-sdk.lakefs.io/v1.20/docs/TaskInfo.html)
 - [UnderlyingObjectProperties](https://pydocs-sdk.lakefs.io/v1.20/docs/UnderlyingObjectProperties.html)
 - [UpdateToken](https://pydocs-sdk.lakefs.io/v1.20/docs/UpdateToken.html)
 - [UploadPart](https://pydocs-sdk.lakefs.io/v1.20/docs/UploadPart.html)
 - [UsageReport](https://pydocs-sdk.lakefs.io/v1.20/docs/UsageReport.html)
 - [User](https://pydocs-sdk.lakefs.io/v1.20/docs/User.html)
 - [UserCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/UserCreation.html)
 - [UserList](https://pydocs-sdk.lakefs.io/v1.20/docs/UserList.html)
 - [VersionConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/VersionConfig.html)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="basic_auth"></a>
### basic_auth

- **Type**: HTTP basic authentication

<a id="jwt_token"></a>
### jwt_token

- **Type**: Bearer authentication (JWT)

<a id="cookie_auth"></a>
### cookie_auth

- **Type**: API key
- **API key parameter name**: internal_auth_session
- **Location**: 

<a id="oidc_auth"></a>
### oidc_auth

- **Type**: API key
- **API key parameter name**: oidc_auth_session
- **Location**: 

<a id="saml_auth"></a>
### saml_auth

- **Type**: API key
- **API key parameter name**: saml_auth_session
- **Location**: 


## Author

services@treeverse.io

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/treeverse/lakeFS/tree/master/clients/python",
    "name": "lakefs-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, lakeFS API",
    "author": "Treeverse",
    "author_email": "services@treeverse.io",
    "download_url": "https://files.pythonhosted.org/packages/08/89/77600d4f91fb1c932932a3d69efd07fbe5aa2c262a3021ad3d508b9f5bfd/lakefs_sdk-1.20.0.tar.gz",
    "platform": null,
    "description": "# lakefs-sdk\nlakeFS HTTP API\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.20.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/treeverse/lakeFS.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/treeverse/lakeFS.git`)\n\nThen import the package:\n```python\nimport lakefs_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport lakefs_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport lakefs_sdk\nfrom lakefs_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to /api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = lakefs_sdk.Configuration(\n    host = \"/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: basic_auth\nconfiguration = lakefs_sdk.Configuration(\n    username = os.environ[\"USERNAME\"],\n    password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookie_auth\nconfiguration.api_key['cookie_auth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookie_auth'] = 'Bearer'\n\n# Configure API key authorization: oidc_auth\nconfiguration.api_key['oidc_auth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['oidc_auth'] = 'Bearer'\n\n# Configure API key authorization: saml_auth\nconfiguration.api_key['saml_auth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['saml_auth'] = 'Bearer'\n\n# Configure Bearer authorization (JWT): jwt_token\nconfiguration = lakefs_sdk.Configuration(\n    access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith lakefs_sdk.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = lakefs_sdk.ActionsApi(api_client)\n    repository = 'repository_example' # str | \n    run_id = 'run_id_example' # str | \n\n    try:\n        # get a run\n        api_response = api_instance.get_run(repository, run_id)\n        print(\"The response of ActionsApi->get_run:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling ActionsApi->get_run: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ActionsApi* | [**get_run**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#get_run) | **GET** /repositories/{repository}/actions/runs/{run_id} | get a run\n*ActionsApi* | [**get_run_hook_output**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#get_run_hook_output) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output | get run hook output\n*ActionsApi* | [**list_repository_runs**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#list_repository_runs) | **GET** /repositories/{repository}/actions/runs | list runs\n*ActionsApi* | [**list_run_hooks**](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionsApi.html#list_run_hooks) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks | list run hooks\n*AuthApi* | [**add_group_membership**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#add_group_membership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership\n*AuthApi* | [**attach_policy_to_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#attach_policy_to_group) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group\n*AuthApi* | [**attach_policy_to_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#attach_policy_to_user) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user\n*AuthApi* | [**create_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_credentials) | **POST** /auth/users/{userId}/credentials | create credentials\n*AuthApi* | [**create_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_group) | **POST** /auth/groups | create group\n*AuthApi* | [**create_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_policy) | **POST** /auth/policies | create policy\n*AuthApi* | [**create_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_user) | **POST** /auth/users | create user\n*AuthApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user\n*AuthApi* | [**delete_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_credentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials\n*AuthApi* | [**delete_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_group) | **DELETE** /auth/groups/{groupId} | delete group\n*AuthApi* | [**delete_group_membership**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_group_membership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership\n*AuthApi* | [**delete_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_policy) | **DELETE** /auth/policies/{policyId} | delete policy\n*AuthApi* | [**delete_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_user) | **DELETE** /auth/users/{userId} | delete user\n*AuthApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user\n*AuthApi* | [**detach_policy_from_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group\n*AuthApi* | [**detach_policy_from_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user\n*AuthApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator\n*AuthApi* | [**get_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials\n*AuthApi* | [**get_current_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_current_user) | **GET** /user | get current user\n*AuthApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id\n*AuthApi* | [**get_group**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_group) | **GET** /auth/groups/{groupId} | get group\n*AuthApi* | [**get_group_acl**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_group_acl) | **GET** /auth/groups/{groupId}/acl | get ACL of group\n*AuthApi* | [**get_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_policy) | **GET** /auth/policies/{policyId} | get policy\n*AuthApi* | [**get_user**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#get_user) | **GET** /auth/users/{userId} | get user\n*AuthApi* | [**list_group_members**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_group_members) | **GET** /auth/groups/{groupId}/members | list group members\n*AuthApi* | [**list_group_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_group_policies) | **GET** /auth/groups/{groupId}/policies | list group policies\n*AuthApi* | [**list_groups**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_groups) | **GET** /auth/groups | list groups\n*AuthApi* | [**list_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_policies) | **GET** /auth/policies | list policies\n*AuthApi* | [**list_user_credentials**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_credentials) | **GET** /auth/users/{userId}/credentials | list user credentials\n*AuthApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user\n*AuthApi* | [**list_user_groups**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_groups) | **GET** /auth/users/{userId}/groups | list user groups\n*AuthApi* | [**list_user_policies**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_user_policies) | **GET** /auth/users/{userId}/policies | list user policies\n*AuthApi* | [**list_users**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#list_users) | **GET** /auth/users | list users\n*AuthApi* | [**login**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#login) | **POST** /auth/login | perform a login\n*AuthApi* | [**set_group_acl**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#set_group_acl) | **POST** /auth/groups/{groupId}/acl | set ACL of group\n*AuthApi* | [**update_policy**](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthApi.html#update_policy) | **PUT** /auth/policies/{policyId} | update policy\n*BranchesApi* | [**cherry_pick**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#cherry_pick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch\n*BranchesApi* | [**create_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#create_branch) | **POST** /repositories/{repository}/branches | create branch\n*BranchesApi* | [**delete_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#delete_branch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch\n*BranchesApi* | [**diff_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#diff_branch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch\n*BranchesApi* | [**get_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#get_branch) | **GET** /repositories/{repository}/branches/{branch} | get branch\n*BranchesApi* | [**list_branches**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#list_branches) | **GET** /repositories/{repository}/branches | list branches\n*BranchesApi* | [**reset_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#reset_branch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch\n*BranchesApi* | [**revert_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchesApi.html#revert_branch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert\n*CommitsApi* | [**commit**](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitsApi.html#commit) | **POST** /repositories/{repository}/branches/{branch}/commits | create commit\n*CommitsApi* | [**get_commit**](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitsApi.html#get_commit) | **GET** /repositories/{repository}/commits/{commitId} | get commit\n*ConfigApi* | [**get_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/ConfigApi.html#get_config) | **GET** /config | \n*ExperimentalApi* | [**abort_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#abort_presign_multipart_upload) | **DELETE** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Abort a presign multipart upload\n*ExperimentalApi* | [**complete_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#complete_presign_multipart_upload) | **PUT** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Complete a presign multipart upload request\n*ExperimentalApi* | [**create_presign_multipart_upload**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#create_presign_multipart_upload) | **POST** /repositories/{repository}/branches/{branch}/staging/pmpu | Initiate a multipart upload\n*ExperimentalApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user\n*ExperimentalApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user\n*ExperimentalApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator\n*ExperimentalApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id\n*ExperimentalApi* | [**hard_reset_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#hard_reset_branch) | **PUT** /repositories/{repository}/branches/{branch}/hard_reset | hard reset branch\n*ExperimentalApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user\n*ExperimentalApi* | [**sts_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExperimentalApi.html#sts_login) | **POST** /sts/login | perform a login with STS\n*ExternalApi* | [**create_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user\n*ExternalApi* | [**delete_user_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user\n*ExternalApi* | [**external_principal_login**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator\n*ExternalApi* | [**get_external_principal**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#get_external_principal) | **GET** /auth/external/principals | describe external principal by id\n*ExternalApi* | [**list_user_external_principals**](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalApi.html#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user\n*HealthCheckApi* | [**health_check**](https://pydocs-sdk.lakefs.io/v1.20/docs/HealthCheckApi.html#health_check) | **GET** /healthcheck | \n*ImportApi* | [**import_cancel**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_cancel) | **DELETE** /repositories/{repository}/branches/{branch}/import | cancel ongoing import\n*ImportApi* | [**import_start**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_start) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store\n*ImportApi* | [**import_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportApi.html#import_status) | **GET** /repositories/{repository}/branches/{branch}/import | get import status\n*InternalApi* | [**create_branch_protection_rule_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | \n*InternalApi* | [**create_commit_record**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_commit_record) | **POST** /repositories/{repository}/commits | create commit record\n*InternalApi* | [**create_symlink_file**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#create_symlink_file) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory\n*InternalApi* | [**delete_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#delete_repository_metadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata\n*InternalApi* | [**dump_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#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 \n*InternalApi* | [**get_auth_capabilities**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported\n*InternalApi* | [**get_garbage_collection_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_garbage_collection_config) | **GET** /config/garbage-collection | \n*InternalApi* | [**get_lake_fs_version**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_lake_fs_version) | **GET** /config/version | \n*InternalApi* | [**get_setup_state**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up\n*InternalApi* | [**get_storage_config**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_storage_config) | **GET** /config/storage | \n*InternalApi* | [**get_usage_report_summary**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#get_usage_report_summary) | **GET** /usage-report/summary | get usage report summary\n*InternalApi* | [**internal_create_branch_protection_rule**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | \n*InternalApi* | [**internal_delete_branch_protection_rule**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | \n*InternalApi* | [**internal_delete_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_delete_garbage_collection_rules) | **DELETE** /repositories/{repository}/gc/rules | \n*InternalApi* | [**internal_get_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_get_branch_protection_rules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules\n*InternalApi* | [**internal_get_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_get_garbage_collection_rules) | **GET** /repositories/{repository}/gc/rules | \n*InternalApi* | [**internal_set_garbage_collection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#internal_set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | \n*InternalApi* | [**post_stats_events**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only\n*InternalApi* | [**prepare_garbage_collection_commits**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection\n*InternalApi* | [**prepare_garbage_collection_uncommitted**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection\n*InternalApi* | [**restore_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#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 \n*InternalApi* | [**set_garbage_collection_rules_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | \n*InternalApi* | [**set_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#set_repository_metadata) | **POST** /repositories/{repository}/metadata | set repository metadata\n*InternalApi* | [**setup**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user\n*InternalApi* | [**setup_comm_prefs**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences\n*InternalApi* | [**stage_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object&#39;s metadata for the given branch\n*InternalApi* | [**upload_object_preflight**](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalApi.html#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | \n*MetadataApi* | [**get_meta_range**](https://pydocs-sdk.lakefs.io/v1.20/docs/MetadataApi.html#get_meta_range) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file\n*MetadataApi* | [**get_range**](https://pydocs-sdk.lakefs.io/v1.20/docs/MetadataApi.html#get_range) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file\n*ObjectsApi* | [**copy_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#copy_object) | **POST** /repositories/{repository}/branches/{branch}/objects/copy | create a copy of an object\n*ObjectsApi* | [**delete_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#delete_object) | **DELETE** /repositories/{repository}/branches/{branch}/objects | delete object. Missing objects will not return a NotFound error.\n*ObjectsApi* | [**delete_objects**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#delete_objects) | **POST** /repositories/{repository}/branches/{branch}/objects/delete | delete objects. Missing objects will not return a NotFound error.\n*ObjectsApi* | [**get_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#get_object) | **GET** /repositories/{repository}/refs/{ref}/objects | get object content\n*ObjectsApi* | [**get_underlying_properties**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#get_underlying_properties) | **GET** /repositories/{repository}/refs/{ref}/objects/underlyingProperties | get object properties on underlying storage\n*ObjectsApi* | [**head_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#head_object) | **HEAD** /repositories/{repository}/refs/{ref}/objects | check if object exists\n*ObjectsApi* | [**list_objects**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#list_objects) | **GET** /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix\n*ObjectsApi* | [**stat_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata\n*ObjectsApi* | [**upload_object**](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectsApi.html#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | \n*RefsApi* | [**diff_refs**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#diff_refs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references\n*RefsApi* | [**find_merge_base**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#find_merge_base) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references\n*RefsApi* | [**log_commits**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#log_commits) | **GET** /repositories/{repository}/refs/{ref}/commits | get commit log from ref. If both objects and prefixes are empty, return all commits.\n*RefsApi* | [**merge_into_branch**](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsApi.html#merge_into_branch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references\n*RepositoriesApi* | [**create_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#create_repository) | **POST** /repositories | create repository\n*RepositoriesApi* | [**delete_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#delete_gc_rules) | **DELETE** /repositories/{repository}/settings/gc_rules | \n*RepositoriesApi* | [**delete_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#delete_repository) | **DELETE** /repositories/{repository} | delete repository\n*RepositoriesApi* | [**dump_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#dump_status) | **GET** /repositories/{repository}/dump | Status of a repository dump task\n*RepositoriesApi* | [**dump_submit**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#dump_submit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store.\n*RepositoriesApi* | [**get_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_branch_protection_rules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules\n*RepositoriesApi* | [**get_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_gc_rules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules\n*RepositoriesApi* | [**get_repository**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_repository) | **GET** /repositories/{repository} | get repository\n*RepositoriesApi* | [**get_repository_metadata**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#get_repository_metadata) | **GET** /repositories/{repository}/metadata | get repository metadata\n*RepositoriesApi* | [**list_repositories**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#list_repositories) | **GET** /repositories | list repositories\n*RepositoriesApi* | [**restore_status**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#restore_status) | **GET** /repositories/{repository}/restore | Status of a restore request\n*RepositoriesApi* | [**restore_submit**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#restore_submit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store\n*RepositoriesApi* | [**set_branch_protection_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#set_branch_protection_rules) | **PUT** /repositories/{repository}/settings/branch_protection | \n*RepositoriesApi* | [**set_gc_rules**](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoriesApi.html#set_gc_rules) | **PUT** /repositories/{repository}/settings/gc_rules | \n*StagingApi* | [**get_physical_address**](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingApi.html#get_physical_address) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | generate an address to which the client can upload an object\n*StagingApi* | [**link_physical_address**](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingApi.html#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path\n*TagsApi* | [**create_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#create_tag) | **POST** /repositories/{repository}/tags | create tag\n*TagsApi* | [**delete_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#delete_tag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag\n*TagsApi* | [**get_tag**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#get_tag) | **GET** /repositories/{repository}/tags/{tag} | get tag\n*TagsApi* | [**list_tags**](https://pydocs-sdk.lakefs.io/v1.20/docs/TagsApi.html#list_tags) | **GET** /repositories/{repository}/tags | list tags\n\n\n## Documentation For Models\n\n - [ACL](https://pydocs-sdk.lakefs.io/v1.20/docs/ACL.html)\n - [AbortPresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/AbortPresignMultipartUpload.html)\n - [AccessKeyCredentials](https://pydocs-sdk.lakefs.io/v1.20/docs/AccessKeyCredentials.html)\n - [ActionRun](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionRun.html)\n - [ActionRunList](https://pydocs-sdk.lakefs.io/v1.20/docs/ActionRunList.html)\n - [AuthCapabilities](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthCapabilities.html)\n - [AuthenticationToken](https://pydocs-sdk.lakefs.io/v1.20/docs/AuthenticationToken.html)\n - [BranchCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchCreation.html)\n - [BranchProtectionRule](https://pydocs-sdk.lakefs.io/v1.20/docs/BranchProtectionRule.html)\n - [CherryPickCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CherryPickCreation.html)\n - [CommPrefsInput](https://pydocs-sdk.lakefs.io/v1.20/docs/CommPrefsInput.html)\n - [Commit](https://pydocs-sdk.lakefs.io/v1.20/docs/Commit.html)\n - [CommitCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitCreation.html)\n - [CommitList](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitList.html)\n - [CommitRecordCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/CommitRecordCreation.html)\n - [CompletePresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/CompletePresignMultipartUpload.html)\n - [Config](https://pydocs-sdk.lakefs.io/v1.20/docs/Config.html)\n - [Credentials](https://pydocs-sdk.lakefs.io/v1.20/docs/Credentials.html)\n - [CredentialsList](https://pydocs-sdk.lakefs.io/v1.20/docs/CredentialsList.html)\n - [CredentialsWithSecret](https://pydocs-sdk.lakefs.io/v1.20/docs/CredentialsWithSecret.html)\n - [CurrentUser](https://pydocs-sdk.lakefs.io/v1.20/docs/CurrentUser.html)\n - [Diff](https://pydocs-sdk.lakefs.io/v1.20/docs/Diff.html)\n - [DiffList](https://pydocs-sdk.lakefs.io/v1.20/docs/DiffList.html)\n - [Error](https://pydocs-sdk.lakefs.io/v1.20/docs/Error.html)\n - [ErrorNoACL](https://pydocs-sdk.lakefs.io/v1.20/docs/ErrorNoACL.html)\n - [ExternalLoginInformation](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalLoginInformation.html)\n - [ExternalPrincipal](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipal.html)\n - [ExternalPrincipalCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipalCreation.html)\n - [ExternalPrincipalList](https://pydocs-sdk.lakefs.io/v1.20/docs/ExternalPrincipalList.html)\n - [FindMergeBaseResult](https://pydocs-sdk.lakefs.io/v1.20/docs/FindMergeBaseResult.html)\n - [GarbageCollectionConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionConfig.html)\n - [GarbageCollectionPrepareResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionPrepareResponse.html)\n - [GarbageCollectionRule](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionRule.html)\n - [GarbageCollectionRules](https://pydocs-sdk.lakefs.io/v1.20/docs/GarbageCollectionRules.html)\n - [Group](https://pydocs-sdk.lakefs.io/v1.20/docs/Group.html)\n - [GroupCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/GroupCreation.html)\n - [GroupList](https://pydocs-sdk.lakefs.io/v1.20/docs/GroupList.html)\n - [HookRun](https://pydocs-sdk.lakefs.io/v1.20/docs/HookRun.html)\n - [HookRunList](https://pydocs-sdk.lakefs.io/v1.20/docs/HookRunList.html)\n - [ImportCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportCreation.html)\n - [ImportCreationResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportCreationResponse.html)\n - [ImportLocation](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportLocation.html)\n - [ImportStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/ImportStatus.html)\n - [InstallationUsageReport](https://pydocs-sdk.lakefs.io/v1.20/docs/InstallationUsageReport.html)\n - [InternalDeleteBranchProtectionRuleRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/InternalDeleteBranchProtectionRuleRequest.html)\n - [LoginConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/LoginConfig.html)\n - [LoginInformation](https://pydocs-sdk.lakefs.io/v1.20/docs/LoginInformation.html)\n - [Merge](https://pydocs-sdk.lakefs.io/v1.20/docs/Merge.html)\n - [MergeResult](https://pydocs-sdk.lakefs.io/v1.20/docs/MergeResult.html)\n - [MetaRangeCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/MetaRangeCreation.html)\n - [MetaRangeCreationResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/MetaRangeCreationResponse.html)\n - [ObjectCopyCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectCopyCreation.html)\n - [ObjectError](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectError.html)\n - [ObjectErrorList](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectErrorList.html)\n - [ObjectStageCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStageCreation.html)\n - [ObjectStats](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStats.html)\n - [ObjectStatsList](https://pydocs-sdk.lakefs.io/v1.20/docs/ObjectStatsList.html)\n - [Pagination](https://pydocs-sdk.lakefs.io/v1.20/docs/Pagination.html)\n - [PathList](https://pydocs-sdk.lakefs.io/v1.20/docs/PathList.html)\n - [Policy](https://pydocs-sdk.lakefs.io/v1.20/docs/Policy.html)\n - [PolicyList](https://pydocs-sdk.lakefs.io/v1.20/docs/PolicyList.html)\n - [PrepareGCUncommittedRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/PrepareGCUncommittedRequest.html)\n - [PrepareGCUncommittedResponse](https://pydocs-sdk.lakefs.io/v1.20/docs/PrepareGCUncommittedResponse.html)\n - [PresignMultipartUpload](https://pydocs-sdk.lakefs.io/v1.20/docs/PresignMultipartUpload.html)\n - [RangeMetadata](https://pydocs-sdk.lakefs.io/v1.20/docs/RangeMetadata.html)\n - [Ref](https://pydocs-sdk.lakefs.io/v1.20/docs/Ref.html)\n - [RefList](https://pydocs-sdk.lakefs.io/v1.20/docs/RefList.html)\n - [RefsDump](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsDump.html)\n - [RefsRestore](https://pydocs-sdk.lakefs.io/v1.20/docs/RefsRestore.html)\n - [Repository](https://pydocs-sdk.lakefs.io/v1.20/docs/Repository.html)\n - [RepositoryCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryCreation.html)\n - [RepositoryDumpStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryDumpStatus.html)\n - [RepositoryList](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryList.html)\n - [RepositoryMetadataKeys](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryMetadataKeys.html)\n - [RepositoryMetadataSet](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryMetadataSet.html)\n - [RepositoryRestoreStatus](https://pydocs-sdk.lakefs.io/v1.20/docs/RepositoryRestoreStatus.html)\n - [ResetCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/ResetCreation.html)\n - [RevertCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/RevertCreation.html)\n - [Setup](https://pydocs-sdk.lakefs.io/v1.20/docs/Setup.html)\n - [SetupState](https://pydocs-sdk.lakefs.io/v1.20/docs/SetupState.html)\n - [StagingLocation](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingLocation.html)\n - [StagingMetadata](https://pydocs-sdk.lakefs.io/v1.20/docs/StagingMetadata.html)\n - [Statement](https://pydocs-sdk.lakefs.io/v1.20/docs/Statement.html)\n - [StatsEvent](https://pydocs-sdk.lakefs.io/v1.20/docs/StatsEvent.html)\n - [StatsEventsList](https://pydocs-sdk.lakefs.io/v1.20/docs/StatsEventsList.html)\n - [StorageConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/StorageConfig.html)\n - [StorageURI](https://pydocs-sdk.lakefs.io/v1.20/docs/StorageURI.html)\n - [StsAuthRequest](https://pydocs-sdk.lakefs.io/v1.20/docs/StsAuthRequest.html)\n - [TagCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/TagCreation.html)\n - [TaskInfo](https://pydocs-sdk.lakefs.io/v1.20/docs/TaskInfo.html)\n - [UnderlyingObjectProperties](https://pydocs-sdk.lakefs.io/v1.20/docs/UnderlyingObjectProperties.html)\n - [UpdateToken](https://pydocs-sdk.lakefs.io/v1.20/docs/UpdateToken.html)\n - [UploadPart](https://pydocs-sdk.lakefs.io/v1.20/docs/UploadPart.html)\n - [UsageReport](https://pydocs-sdk.lakefs.io/v1.20/docs/UsageReport.html)\n - [User](https://pydocs-sdk.lakefs.io/v1.20/docs/User.html)\n - [UserCreation](https://pydocs-sdk.lakefs.io/v1.20/docs/UserCreation.html)\n - [UserList](https://pydocs-sdk.lakefs.io/v1.20/docs/UserList.html)\n - [VersionConfig](https://pydocs-sdk.lakefs.io/v1.20/docs/VersionConfig.html)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"basic_auth\"></a>\n### basic_auth\n\n- **Type**: HTTP basic authentication\n\n<a id=\"jwt_token\"></a>\n### jwt_token\n\n- **Type**: Bearer authentication (JWT)\n\n<a id=\"cookie_auth\"></a>\n### cookie_auth\n\n- **Type**: API key\n- **API key parameter name**: internal_auth_session\n- **Location**: \n\n<a id=\"oidc_auth\"></a>\n### oidc_auth\n\n- **Type**: API key\n- **API key parameter name**: oidc_auth_session\n- **Location**: \n\n<a id=\"saml_auth\"></a>\n### saml_auth\n\n- **Type**: API key\n- **API key parameter name**: saml_auth_session\n- **Location**: \n\n\n## Author\n\nservices@treeverse.io\n\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "lakeFS API",
    "version": "1.20.0",
    "project_urls": {
        "Homepage": "https://github.com/treeverse/lakeFS/tree/master/clients/python"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " lakefs api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4cbe21314db05bda763332eb6a05ceb4a224d8a7c0e81abc3af37ba4cc79d413",
                "md5": "93da806695f1875704ec50f47ab8a763",
                "sha256": "e768f26041cd549c0465629ce0ccf91ed0f6ace70a90e72b95f005f6a4cca47e"
            },
            "downloads": -1,
            "filename": "lakefs_sdk-1.20.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93da806695f1875704ec50f47ab8a763",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 197635,
            "upload_time": "2024-04-16T13:34:20",
            "upload_time_iso_8601": "2024-04-16T13:34:20.746693Z",
            "url": "https://files.pythonhosted.org/packages/4c/be/21314db05bda763332eb6a05ceb4a224d8a7c0e81abc3af37ba4cc79d413/lakefs_sdk-1.20.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "088977600d4f91fb1c932932a3d69efd07fbe5aa2c262a3021ad3d508b9f5bfd",
                "md5": "3eb813c63bd663813ced27108a6dc7d5",
                "sha256": "332c7907d9cd445842134ad797eeb36b763f9dca71f6628b6bed2e48e17a8d94"
            },
            "downloads": -1,
            "filename": "lakefs_sdk-1.20.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3eb813c63bd663813ced27108a6dc7d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 111863,
            "upload_time": "2024-04-16T13:34:23",
            "upload_time_iso_8601": "2024-04-16T13:34:23.140253Z",
            "url": "https://files.pythonhosted.org/packages/08/89/77600d4f91fb1c932932a3d69efd07fbe5aa2c262a3021ad3d508b9f5bfd/lakefs_sdk-1.20.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-16 13:34:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "treeverse",
    "github_project": "lakeFS",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lakefs-sdk"
}
Treeverse
Elapsed time: 0.27668s