github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python/README.md (about) 1 # lakefs-sdk 2 lakeFS HTTP API 3 4 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: 5 6 - API version: 1.0.0 7 - Package version: 0.1.0-SNAPSHOT 8 - Build package: org.openapitools.codegen.languages.PythonClientCodegen 9 10 ## Requirements. 11 12 Python 3.7+ 13 14 ## Installation & Usage 15 ### pip install 16 17 If the python package is hosted on a repository, you can install directly using: 18 19 ```sh 20 pip install git+https://github.com/treeverse/lakeFS.git 21 ``` 22 (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/treeverse/lakeFS.git`) 23 24 Then import the package: 25 ```python 26 import lakefs_sdk 27 ``` 28 29 ### Setuptools 30 31 Install via [Setuptools](http://pypi.python.org/pypi/setuptools). 32 33 ```sh 34 python setup.py install --user 35 ``` 36 (or `sudo python setup.py install` to install the package for all users) 37 38 Then import the package: 39 ```python 40 import lakefs_sdk 41 ``` 42 43 ### Tests 44 45 Execute `pytest` to run the tests. 46 47 ## Getting Started 48 49 Please follow the [installation procedure](#installation--usage) and then run the following: 50 51 ```python 52 53 import time 54 import lakefs_sdk 55 from lakefs_sdk.rest import ApiException 56 from pprint import pprint 57 58 # Defining the host is optional and defaults to /api/v1 59 # See configuration.py for a list of all supported configuration parameters. 60 configuration = lakefs_sdk.Configuration( 61 host = "/api/v1" 62 ) 63 64 # The client must configure the authentication and authorization parameters 65 # in accordance with the API server security policy. 66 # Examples for each auth method are provided below, use the example that 67 # satisfies your auth use case. 68 69 # Configure HTTP basic authorization: basic_auth 70 configuration = lakefs_sdk.Configuration( 71 username = os.environ["USERNAME"], 72 password = os.environ["PASSWORD"] 73 ) 74 75 # Configure API key authorization: cookie_auth 76 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 77 78 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 79 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 80 81 # Configure API key authorization: oidc_auth 82 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 83 84 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 85 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 86 87 # Configure API key authorization: saml_auth 88 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 89 90 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 91 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 92 93 # Configure Bearer authorization (JWT): jwt_token 94 configuration = lakefs_sdk.Configuration( 95 access_token = os.environ["BEARER_TOKEN"] 96 ) 97 98 99 # Enter a context with an instance of the API client 100 with lakefs_sdk.ApiClient(configuration) as api_client: 101 # Create an instance of the API class 102 api_instance = lakefs_sdk.ActionsApi(api_client) 103 repository = 'repository_example' # str | 104 run_id = 'run_id_example' # str | 105 106 try: 107 # get a run 108 api_response = api_instance.get_run(repository, run_id) 109 print("The response of ActionsApi->get_run:\n") 110 pprint(api_response) 111 except ApiException as e: 112 print("Exception when calling ActionsApi->get_run: %s\n" % e) 113 114 ``` 115 116 ## Documentation for API Endpoints 117 118 All URIs are relative to */api/v1* 119 120 Class | Method | HTTP request | Description 121 ------------ | ------------- | ------------- | ------------- 122 *ActionsApi* | [**get_run**](docs/ActionsApi.md#get_run) | **GET** /repositories/{repository}/actions/runs/{run_id} | get a run 123 *ActionsApi* | [**get_run_hook_output**](docs/ActionsApi.md#get_run_hook_output) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output | get run hook output 124 *ActionsApi* | [**list_repository_runs**](docs/ActionsApi.md#list_repository_runs) | **GET** /repositories/{repository}/actions/runs | list runs 125 *ActionsApi* | [**list_run_hooks**](docs/ActionsApi.md#list_run_hooks) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks | list run hooks 126 *AuthApi* | [**add_group_membership**](docs/AuthApi.md#add_group_membership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership 127 *AuthApi* | [**attach_policy_to_group**](docs/AuthApi.md#attach_policy_to_group) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group 128 *AuthApi* | [**attach_policy_to_user**](docs/AuthApi.md#attach_policy_to_user) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user 129 *AuthApi* | [**create_credentials**](docs/AuthApi.md#create_credentials) | **POST** /auth/users/{userId}/credentials | create credentials 130 *AuthApi* | [**create_group**](docs/AuthApi.md#create_group) | **POST** /auth/groups | create group 131 *AuthApi* | [**create_policy**](docs/AuthApi.md#create_policy) | **POST** /auth/policies | create policy 132 *AuthApi* | [**create_user**](docs/AuthApi.md#create_user) | **POST** /auth/users | create user 133 *AuthApi* | [**create_user_external_principal**](docs/AuthApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 134 *AuthApi* | [**delete_credentials**](docs/AuthApi.md#delete_credentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials 135 *AuthApi* | [**delete_group**](docs/AuthApi.md#delete_group) | **DELETE** /auth/groups/{groupId} | delete group 136 *AuthApi* | [**delete_group_membership**](docs/AuthApi.md#delete_group_membership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership 137 *AuthApi* | [**delete_policy**](docs/AuthApi.md#delete_policy) | **DELETE** /auth/policies/{policyId} | delete policy 138 *AuthApi* | [**delete_user**](docs/AuthApi.md#delete_user) | **DELETE** /auth/users/{userId} | delete user 139 *AuthApi* | [**delete_user_external_principal**](docs/AuthApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 140 *AuthApi* | [**detach_policy_from_group**](docs/AuthApi.md#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group 141 *AuthApi* | [**detach_policy_from_user**](docs/AuthApi.md#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user 142 *AuthApi* | [**external_principal_login**](docs/AuthApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator 143 *AuthApi* | [**get_credentials**](docs/AuthApi.md#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials 144 *AuthApi* | [**get_current_user**](docs/AuthApi.md#get_current_user) | **GET** /user | get current user 145 *AuthApi* | [**get_external_principal**](docs/AuthApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id 146 *AuthApi* | [**get_group**](docs/AuthApi.md#get_group) | **GET** /auth/groups/{groupId} | get group 147 *AuthApi* | [**get_group_acl**](docs/AuthApi.md#get_group_acl) | **GET** /auth/groups/{groupId}/acl | get ACL of group 148 *AuthApi* | [**get_policy**](docs/AuthApi.md#get_policy) | **GET** /auth/policies/{policyId} | get policy 149 *AuthApi* | [**get_user**](docs/AuthApi.md#get_user) | **GET** /auth/users/{userId} | get user 150 *AuthApi* | [**list_group_members**](docs/AuthApi.md#list_group_members) | **GET** /auth/groups/{groupId}/members | list group members 151 *AuthApi* | [**list_group_policies**](docs/AuthApi.md#list_group_policies) | **GET** /auth/groups/{groupId}/policies | list group policies 152 *AuthApi* | [**list_groups**](docs/AuthApi.md#list_groups) | **GET** /auth/groups | list groups 153 *AuthApi* | [**list_policies**](docs/AuthApi.md#list_policies) | **GET** /auth/policies | list policies 154 *AuthApi* | [**list_user_credentials**](docs/AuthApi.md#list_user_credentials) | **GET** /auth/users/{userId}/credentials | list user credentials 155 *AuthApi* | [**list_user_external_principals**](docs/AuthApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 156 *AuthApi* | [**list_user_groups**](docs/AuthApi.md#list_user_groups) | **GET** /auth/users/{userId}/groups | list user groups 157 *AuthApi* | [**list_user_policies**](docs/AuthApi.md#list_user_policies) | **GET** /auth/users/{userId}/policies | list user policies 158 *AuthApi* | [**list_users**](docs/AuthApi.md#list_users) | **GET** /auth/users | list users 159 *AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /auth/login | perform a login 160 *AuthApi* | [**set_group_acl**](docs/AuthApi.md#set_group_acl) | **POST** /auth/groups/{groupId}/acl | set ACL of group 161 *AuthApi* | [**update_policy**](docs/AuthApi.md#update_policy) | **PUT** /auth/policies/{policyId} | update policy 162 *BranchesApi* | [**cherry_pick**](docs/BranchesApi.md#cherry_pick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch 163 *BranchesApi* | [**create_branch**](docs/BranchesApi.md#create_branch) | **POST** /repositories/{repository}/branches | create branch 164 *BranchesApi* | [**delete_branch**](docs/BranchesApi.md#delete_branch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch 165 *BranchesApi* | [**diff_branch**](docs/BranchesApi.md#diff_branch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch 166 *BranchesApi* | [**get_branch**](docs/BranchesApi.md#get_branch) | **GET** /repositories/{repository}/branches/{branch} | get branch 167 *BranchesApi* | [**list_branches**](docs/BranchesApi.md#list_branches) | **GET** /repositories/{repository}/branches | list branches 168 *BranchesApi* | [**reset_branch**](docs/BranchesApi.md#reset_branch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch 169 *BranchesApi* | [**revert_branch**](docs/BranchesApi.md#revert_branch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert 170 *CommitsApi* | [**commit**](docs/CommitsApi.md#commit) | **POST** /repositories/{repository}/branches/{branch}/commits | create commit 171 *CommitsApi* | [**get_commit**](docs/CommitsApi.md#get_commit) | **GET** /repositories/{repository}/commits/{commitId} | get commit 172 *ConfigApi* | [**get_config**](docs/ConfigApi.md#get_config) | **GET** /config | 173 *ExperimentalApi* | [**abort_presign_multipart_upload**](docs/ExperimentalApi.md#abort_presign_multipart_upload) | **DELETE** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Abort a presign multipart upload 174 *ExperimentalApi* | [**complete_presign_multipart_upload**](docs/ExperimentalApi.md#complete_presign_multipart_upload) | **PUT** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Complete a presign multipart upload request 175 *ExperimentalApi* | [**create_presign_multipart_upload**](docs/ExperimentalApi.md#create_presign_multipart_upload) | **POST** /repositories/{repository}/branches/{branch}/staging/pmpu | Initiate a multipart upload 176 *ExperimentalApi* | [**create_user_external_principal**](docs/ExperimentalApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 177 *ExperimentalApi* | [**delete_user_external_principal**](docs/ExperimentalApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 178 *ExperimentalApi* | [**external_principal_login**](docs/ExperimentalApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator 179 *ExperimentalApi* | [**get_external_principal**](docs/ExperimentalApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id 180 *ExperimentalApi* | [**hard_reset_branch**](docs/ExperimentalApi.md#hard_reset_branch) | **PUT** /repositories/{repository}/branches/{branch}/hard_reset | hard reset branch 181 *ExperimentalApi* | [**list_user_external_principals**](docs/ExperimentalApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 182 *ExperimentalApi* | [**sts_login**](docs/ExperimentalApi.md#sts_login) | **POST** /sts/login | perform a login with STS 183 *ExternalApi* | [**create_user_external_principal**](docs/ExternalApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user 184 *ExternalApi* | [**delete_user_external_principal**](docs/ExternalApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user 185 *ExternalApi* | [**external_principal_login**](docs/ExternalApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator 186 *ExternalApi* | [**get_external_principal**](docs/ExternalApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id 187 *ExternalApi* | [**list_user_external_principals**](docs/ExternalApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user 188 *HealthCheckApi* | [**health_check**](docs/HealthCheckApi.md#health_check) | **GET** /healthcheck | 189 *ImportApi* | [**import_cancel**](docs/ImportApi.md#import_cancel) | **DELETE** /repositories/{repository}/branches/{branch}/import | cancel ongoing import 190 *ImportApi* | [**import_start**](docs/ImportApi.md#import_start) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store 191 *ImportApi* | [**import_status**](docs/ImportApi.md#import_status) | **GET** /repositories/{repository}/branches/{branch}/import | get import status 192 *InternalApi* | [**create_branch_protection_rule_preflight**](docs/InternalApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | 193 *InternalApi* | [**create_commit_record**](docs/InternalApi.md#create_commit_record) | **POST** /repositories/{repository}/commits | create commit record 194 *InternalApi* | [**create_symlink_file**](docs/InternalApi.md#create_symlink_file) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory 195 *InternalApi* | [**delete_repository_metadata**](docs/InternalApi.md#delete_repository_metadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata 196 *InternalApi* | [**dump_refs**](docs/InternalApi.md#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 197 *InternalApi* | [**get_auth_capabilities**](docs/InternalApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported 198 *InternalApi* | [**get_garbage_collection_config**](docs/InternalApi.md#get_garbage_collection_config) | **GET** /config/garbage-collection | 199 *InternalApi* | [**get_lake_fs_version**](docs/InternalApi.md#get_lake_fs_version) | **GET** /config/version | 200 *InternalApi* | [**get_setup_state**](docs/InternalApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up 201 *InternalApi* | [**get_storage_config**](docs/InternalApi.md#get_storage_config) | **GET** /config/storage | 202 *InternalApi* | [**get_usage_report_summary**](docs/InternalApi.md#get_usage_report_summary) | **GET** /usage-report/summary | get usage report summary 203 *InternalApi* | [**internal_create_branch_protection_rule**](docs/InternalApi.md#internal_create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | 204 *InternalApi* | [**internal_delete_branch_protection_rule**](docs/InternalApi.md#internal_delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | 205 *InternalApi* | [**internal_delete_garbage_collection_rules**](docs/InternalApi.md#internal_delete_garbage_collection_rules) | **DELETE** /repositories/{repository}/gc/rules | 206 *InternalApi* | [**internal_get_branch_protection_rules**](docs/InternalApi.md#internal_get_branch_protection_rules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules 207 *InternalApi* | [**internal_get_garbage_collection_rules**](docs/InternalApi.md#internal_get_garbage_collection_rules) | **GET** /repositories/{repository}/gc/rules | 208 *InternalApi* | [**internal_set_garbage_collection_rules**](docs/InternalApi.md#internal_set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | 209 *InternalApi* | [**post_stats_events**](docs/InternalApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only 210 *InternalApi* | [**prepare_garbage_collection_commits**](docs/InternalApi.md#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection 211 *InternalApi* | [**prepare_garbage_collection_uncommitted**](docs/InternalApi.md#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection 212 *InternalApi* | [**restore_refs**](docs/InternalApi.md#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 213 *InternalApi* | [**set_garbage_collection_rules_preflight**](docs/InternalApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | 214 *InternalApi* | [**set_repository_metadata**](docs/InternalApi.md#set_repository_metadata) | **POST** /repositories/{repository}/metadata | set repository metadata 215 *InternalApi* | [**setup**](docs/InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user 216 *InternalApi* | [**setup_comm_prefs**](docs/InternalApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences 217 *InternalApi* | [**stage_object**](docs/InternalApi.md#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch 218 *InternalApi* | [**upload_object_preflight**](docs/InternalApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | 219 *MetadataApi* | [**get_meta_range**](docs/MetadataApi.md#get_meta_range) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file 220 *MetadataApi* | [**get_range**](docs/MetadataApi.md#get_range) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file 221 *ObjectsApi* | [**copy_object**](docs/ObjectsApi.md#copy_object) | **POST** /repositories/{repository}/branches/{branch}/objects/copy | create a copy of an object 222 *ObjectsApi* | [**delete_object**](docs/ObjectsApi.md#delete_object) | **DELETE** /repositories/{repository}/branches/{branch}/objects | delete object. Missing objects will not return a NotFound error. 223 *ObjectsApi* | [**delete_objects**](docs/ObjectsApi.md#delete_objects) | **POST** /repositories/{repository}/branches/{branch}/objects/delete | delete objects. Missing objects will not return a NotFound error. 224 *ObjectsApi* | [**get_object**](docs/ObjectsApi.md#get_object) | **GET** /repositories/{repository}/refs/{ref}/objects | get object content 225 *ObjectsApi* | [**get_underlying_properties**](docs/ObjectsApi.md#get_underlying_properties) | **GET** /repositories/{repository}/refs/{ref}/objects/underlyingProperties | get object properties on underlying storage 226 *ObjectsApi* | [**head_object**](docs/ObjectsApi.md#head_object) | **HEAD** /repositories/{repository}/refs/{ref}/objects | check if object exists 227 *ObjectsApi* | [**list_objects**](docs/ObjectsApi.md#list_objects) | **GET** /repositories/{repository}/refs/{ref}/objects/ls | list objects under a given prefix 228 *ObjectsApi* | [**stat_object**](docs/ObjectsApi.md#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata 229 *ObjectsApi* | [**upload_object**](docs/ObjectsApi.md#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | 230 *RefsApi* | [**diff_refs**](docs/RefsApi.md#diff_refs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references 231 *RefsApi* | [**find_merge_base**](docs/RefsApi.md#find_merge_base) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references 232 *RefsApi* | [**log_commits**](docs/RefsApi.md#log_commits) | **GET** /repositories/{repository}/refs/{ref}/commits | get commit log from ref. If both objects and prefixes are empty, return all commits. 233 *RefsApi* | [**merge_into_branch**](docs/RefsApi.md#merge_into_branch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references 234 *RepositoriesApi* | [**create_repository**](docs/RepositoriesApi.md#create_repository) | **POST** /repositories | create repository 235 *RepositoriesApi* | [**delete_gc_rules**](docs/RepositoriesApi.md#delete_gc_rules) | **DELETE** /repositories/{repository}/settings/gc_rules | 236 *RepositoriesApi* | [**delete_repository**](docs/RepositoriesApi.md#delete_repository) | **DELETE** /repositories/{repository} | delete repository 237 *RepositoriesApi* | [**dump_status**](docs/RepositoriesApi.md#dump_status) | **GET** /repositories/{repository}/dump | Status of a repository dump task 238 *RepositoriesApi* | [**dump_submit**](docs/RepositoriesApi.md#dump_submit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store. 239 *RepositoriesApi* | [**get_branch_protection_rules**](docs/RepositoriesApi.md#get_branch_protection_rules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules 240 *RepositoriesApi* | [**get_gc_rules**](docs/RepositoriesApi.md#get_gc_rules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules 241 *RepositoriesApi* | [**get_repository**](docs/RepositoriesApi.md#get_repository) | **GET** /repositories/{repository} | get repository 242 *RepositoriesApi* | [**get_repository_metadata**](docs/RepositoriesApi.md#get_repository_metadata) | **GET** /repositories/{repository}/metadata | get repository metadata 243 *RepositoriesApi* | [**list_repositories**](docs/RepositoriesApi.md#list_repositories) | **GET** /repositories | list repositories 244 *RepositoriesApi* | [**restore_status**](docs/RepositoriesApi.md#restore_status) | **GET** /repositories/{repository}/restore | Status of a restore request 245 *RepositoriesApi* | [**restore_submit**](docs/RepositoriesApi.md#restore_submit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store 246 *RepositoriesApi* | [**set_branch_protection_rules**](docs/RepositoriesApi.md#set_branch_protection_rules) | **PUT** /repositories/{repository}/settings/branch_protection | 247 *RepositoriesApi* | [**set_gc_rules**](docs/RepositoriesApi.md#set_gc_rules) | **PUT** /repositories/{repository}/settings/gc_rules | 248 *StagingApi* | [**get_physical_address**](docs/StagingApi.md#get_physical_address) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | generate an address to which the client can upload an object 249 *StagingApi* | [**link_physical_address**](docs/StagingApi.md#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path 250 *TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /repositories/{repository}/tags | create tag 251 *TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag 252 *TagsApi* | [**get_tag**](docs/TagsApi.md#get_tag) | **GET** /repositories/{repository}/tags/{tag} | get tag 253 *TagsApi* | [**list_tags**](docs/TagsApi.md#list_tags) | **GET** /repositories/{repository}/tags | list tags 254 255 256 ## Documentation For Models 257 258 - [ACL](docs/ACL.md) 259 - [AbortPresignMultipartUpload](docs/AbortPresignMultipartUpload.md) 260 - [AccessKeyCredentials](docs/AccessKeyCredentials.md) 261 - [ActionRun](docs/ActionRun.md) 262 - [ActionRunList](docs/ActionRunList.md) 263 - [AuthCapabilities](docs/AuthCapabilities.md) 264 - [AuthenticationToken](docs/AuthenticationToken.md) 265 - [BranchCreation](docs/BranchCreation.md) 266 - [BranchProtectionRule](docs/BranchProtectionRule.md) 267 - [CherryPickCreation](docs/CherryPickCreation.md) 268 - [CommPrefsInput](docs/CommPrefsInput.md) 269 - [Commit](docs/Commit.md) 270 - [CommitCreation](docs/CommitCreation.md) 271 - [CommitList](docs/CommitList.md) 272 - [CommitRecordCreation](docs/CommitRecordCreation.md) 273 - [CompletePresignMultipartUpload](docs/CompletePresignMultipartUpload.md) 274 - [Config](docs/Config.md) 275 - [Credentials](docs/Credentials.md) 276 - [CredentialsList](docs/CredentialsList.md) 277 - [CredentialsWithSecret](docs/CredentialsWithSecret.md) 278 - [CurrentUser](docs/CurrentUser.md) 279 - [Diff](docs/Diff.md) 280 - [DiffList](docs/DiffList.md) 281 - [Error](docs/Error.md) 282 - [ErrorNoACL](docs/ErrorNoACL.md) 283 - [ExternalLoginInformation](docs/ExternalLoginInformation.md) 284 - [ExternalPrincipal](docs/ExternalPrincipal.md) 285 - [ExternalPrincipalCreation](docs/ExternalPrincipalCreation.md) 286 - [ExternalPrincipalList](docs/ExternalPrincipalList.md) 287 - [FindMergeBaseResult](docs/FindMergeBaseResult.md) 288 - [GarbageCollectionConfig](docs/GarbageCollectionConfig.md) 289 - [GarbageCollectionPrepareResponse](docs/GarbageCollectionPrepareResponse.md) 290 - [GarbageCollectionRule](docs/GarbageCollectionRule.md) 291 - [GarbageCollectionRules](docs/GarbageCollectionRules.md) 292 - [Group](docs/Group.md) 293 - [GroupCreation](docs/GroupCreation.md) 294 - [GroupList](docs/GroupList.md) 295 - [HookRun](docs/HookRun.md) 296 - [HookRunList](docs/HookRunList.md) 297 - [ImportCreation](docs/ImportCreation.md) 298 - [ImportCreationResponse](docs/ImportCreationResponse.md) 299 - [ImportLocation](docs/ImportLocation.md) 300 - [ImportStatus](docs/ImportStatus.md) 301 - [InstallationUsageReport](docs/InstallationUsageReport.md) 302 - [InternalDeleteBranchProtectionRuleRequest](docs/InternalDeleteBranchProtectionRuleRequest.md) 303 - [LoginConfig](docs/LoginConfig.md) 304 - [LoginInformation](docs/LoginInformation.md) 305 - [Merge](docs/Merge.md) 306 - [MergeResult](docs/MergeResult.md) 307 - [MetaRangeCreation](docs/MetaRangeCreation.md) 308 - [MetaRangeCreationResponse](docs/MetaRangeCreationResponse.md) 309 - [ObjectCopyCreation](docs/ObjectCopyCreation.md) 310 - [ObjectError](docs/ObjectError.md) 311 - [ObjectErrorList](docs/ObjectErrorList.md) 312 - [ObjectStageCreation](docs/ObjectStageCreation.md) 313 - [ObjectStats](docs/ObjectStats.md) 314 - [ObjectStatsList](docs/ObjectStatsList.md) 315 - [Pagination](docs/Pagination.md) 316 - [PathList](docs/PathList.md) 317 - [Policy](docs/Policy.md) 318 - [PolicyList](docs/PolicyList.md) 319 - [PrepareGCUncommittedRequest](docs/PrepareGCUncommittedRequest.md) 320 - [PrepareGCUncommittedResponse](docs/PrepareGCUncommittedResponse.md) 321 - [PresignMultipartUpload](docs/PresignMultipartUpload.md) 322 - [RangeMetadata](docs/RangeMetadata.md) 323 - [Ref](docs/Ref.md) 324 - [RefList](docs/RefList.md) 325 - [RefsDump](docs/RefsDump.md) 326 - [RefsRestore](docs/RefsRestore.md) 327 - [Repository](docs/Repository.md) 328 - [RepositoryCreation](docs/RepositoryCreation.md) 329 - [RepositoryDumpStatus](docs/RepositoryDumpStatus.md) 330 - [RepositoryList](docs/RepositoryList.md) 331 - [RepositoryMetadataKeys](docs/RepositoryMetadataKeys.md) 332 - [RepositoryMetadataSet](docs/RepositoryMetadataSet.md) 333 - [RepositoryRestoreStatus](docs/RepositoryRestoreStatus.md) 334 - [ResetCreation](docs/ResetCreation.md) 335 - [RevertCreation](docs/RevertCreation.md) 336 - [Setup](docs/Setup.md) 337 - [SetupState](docs/SetupState.md) 338 - [StagingLocation](docs/StagingLocation.md) 339 - [StagingMetadata](docs/StagingMetadata.md) 340 - [Statement](docs/Statement.md) 341 - [StatsEvent](docs/StatsEvent.md) 342 - [StatsEventsList](docs/StatsEventsList.md) 343 - [StorageConfig](docs/StorageConfig.md) 344 - [StorageURI](docs/StorageURI.md) 345 - [StsAuthRequest](docs/StsAuthRequest.md) 346 - [TagCreation](docs/TagCreation.md) 347 - [TaskInfo](docs/TaskInfo.md) 348 - [UnderlyingObjectProperties](docs/UnderlyingObjectProperties.md) 349 - [UpdateToken](docs/UpdateToken.md) 350 - [UploadPart](docs/UploadPart.md) 351 - [UsageReport](docs/UsageReport.md) 352 - [User](docs/User.md) 353 - [UserCreation](docs/UserCreation.md) 354 - [UserList](docs/UserList.md) 355 - [VersionConfig](docs/VersionConfig.md) 356 357 358 <a id="documentation-for-authorization"></a> 359 ## Documentation For Authorization 360 361 362 Authentication schemes defined for the API: 363 <a id="basic_auth"></a> 364 ### basic_auth 365 366 - **Type**: HTTP basic authentication 367 368 <a id="jwt_token"></a> 369 ### jwt_token 370 371 - **Type**: Bearer authentication (JWT) 372 373 <a id="cookie_auth"></a> 374 ### cookie_auth 375 376 - **Type**: API key 377 - **API key parameter name**: internal_auth_session 378 - **Location**: 379 380 <a id="oidc_auth"></a> 381 ### oidc_auth 382 383 - **Type**: API key 384 - **API key parameter name**: oidc_auth_session 385 - **Location**: 386 387 <a id="saml_auth"></a> 388 ### saml_auth 389 390 - **Type**: API key 391 - **API key parameter name**: saml_auth_session 392 - **Location**: 393 394 395 ## Author 396 397 services@treeverse.io 398 399