github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python/docs/InternalApi.md (about) 1 # lakefs_sdk.InternalApi 2 3 All URIs are relative to */api/v1* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**create_branch_protection_rule_preflight**](InternalApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | 8 [**create_commit_record**](InternalApi.md#create_commit_record) | **POST** /repositories/{repository}/commits | create commit record 9 [**create_symlink_file**](InternalApi.md#create_symlink_file) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory 10 [**delete_repository_metadata**](InternalApi.md#delete_repository_metadata) | **DELETE** /repositories/{repository}/metadata | delete repository metadata 11 [**dump_refs**](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 12 [**get_auth_capabilities**](InternalApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported 13 [**get_garbage_collection_config**](InternalApi.md#get_garbage_collection_config) | **GET** /config/garbage-collection | 14 [**get_lake_fs_version**](InternalApi.md#get_lake_fs_version) | **GET** /config/version | 15 [**get_setup_state**](InternalApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up 16 [**get_storage_config**](InternalApi.md#get_storage_config) | **GET** /config/storage | 17 [**get_usage_report_summary**](InternalApi.md#get_usage_report_summary) | **GET** /usage-report/summary | get usage report summary 18 [**internal_create_branch_protection_rule**](InternalApi.md#internal_create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | 19 [**internal_delete_branch_protection_rule**](InternalApi.md#internal_delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | 20 [**internal_delete_garbage_collection_rules**](InternalApi.md#internal_delete_garbage_collection_rules) | **DELETE** /repositories/{repository}/gc/rules | 21 [**internal_get_branch_protection_rules**](InternalApi.md#internal_get_branch_protection_rules) | **GET** /repositories/{repository}/branch_protection | get branch protection rules 22 [**internal_get_garbage_collection_rules**](InternalApi.md#internal_get_garbage_collection_rules) | **GET** /repositories/{repository}/gc/rules | 23 [**internal_set_garbage_collection_rules**](InternalApi.md#internal_set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | 24 [**post_stats_events**](InternalApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only 25 [**prepare_garbage_collection_commits**](InternalApi.md#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active commits for garbage collection 26 [**prepare_garbage_collection_uncommitted**](InternalApi.md#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection 27 [**restore_refs**](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 28 [**set_garbage_collection_rules_preflight**](InternalApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | 29 [**set_repository_metadata**](InternalApi.md#set_repository_metadata) | **POST** /repositories/{repository}/metadata | set repository metadata 30 [**setup**](InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user 31 [**setup_comm_prefs**](InternalApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences 32 [**stage_object**](InternalApi.md#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch 33 [**upload_object_preflight**](InternalApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | 34 35 36 # **create_branch_protection_rule_preflight** 37 > create_branch_protection_rule_preflight(repository) 38 39 40 41 ### Example 42 43 * Basic Authentication (basic_auth): 44 * Api Key Authentication (cookie_auth): 45 * Api Key Authentication (oidc_auth): 46 * Api Key Authentication (saml_auth): 47 * Bearer (JWT) Authentication (jwt_token): 48 49 ```python 50 import time 51 import os 52 import lakefs_sdk 53 from lakefs_sdk.rest import ApiException 54 from pprint import pprint 55 56 # Defining the host is optional and defaults to /api/v1 57 # See configuration.py for a list of all supported configuration parameters. 58 configuration = lakefs_sdk.Configuration( 59 host = "/api/v1" 60 ) 61 62 # The client must configure the authentication and authorization parameters 63 # in accordance with the API server security policy. 64 # Examples for each auth method are provided below, use the example that 65 # satisfies your auth use case. 66 67 # Configure HTTP basic authorization: basic_auth 68 configuration = lakefs_sdk.Configuration( 69 username = os.environ["USERNAME"], 70 password = os.environ["PASSWORD"] 71 ) 72 73 # Configure API key authorization: cookie_auth 74 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 75 76 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 77 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 78 79 # Configure API key authorization: oidc_auth 80 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 81 82 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 83 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 84 85 # Configure API key authorization: saml_auth 86 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 87 88 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 89 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 90 91 # Configure Bearer authorization (JWT): jwt_token 92 configuration = lakefs_sdk.Configuration( 93 access_token = os.environ["BEARER_TOKEN"] 94 ) 95 96 # Enter a context with an instance of the API client 97 with lakefs_sdk.ApiClient(configuration) as api_client: 98 # Create an instance of the API class 99 api_instance = lakefs_sdk.InternalApi(api_client) 100 repository = 'repository_example' # str | 101 102 try: 103 api_instance.create_branch_protection_rule_preflight(repository) 104 except Exception as e: 105 print("Exception when calling InternalApi->create_branch_protection_rule_preflight: %s\n" % e) 106 ``` 107 108 109 110 ### Parameters 111 112 113 Name | Type | Description | Notes 114 ------------- | ------------- | ------------- | ------------- 115 **repository** | **str**| | 116 117 ### Return type 118 119 void (empty response body) 120 121 ### Authorization 122 123 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 124 125 ### HTTP request headers 126 127 - **Content-Type**: Not defined 128 - **Accept**: application/json 129 130 ### HTTP response details 131 132 | Status code | Description | Response headers | 133 |-------------|-------------|------------------| 134 **204** | User has permissions to create a branch protection rule in this repository | - | 135 **401** | Unauthorized | - | 136 **404** | Resource Not Found | - | 137 **409** | Resource Conflicts With Target | - | 138 **420** | too many requests | - | 139 **0** | Internal Server Error | - | 140 141 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 142 143 # **create_commit_record** 144 > create_commit_record(repository, commit_record_creation) 145 146 create commit record 147 148 ### Example 149 150 * Basic Authentication (basic_auth): 151 * Api Key Authentication (cookie_auth): 152 * Api Key Authentication (oidc_auth): 153 * Api Key Authentication (saml_auth): 154 * Bearer (JWT) Authentication (jwt_token): 155 156 ```python 157 import time 158 import os 159 import lakefs_sdk 160 from lakefs_sdk.models.commit_record_creation import CommitRecordCreation 161 from lakefs_sdk.rest import ApiException 162 from pprint import pprint 163 164 # Defining the host is optional and defaults to /api/v1 165 # See configuration.py for a list of all supported configuration parameters. 166 configuration = lakefs_sdk.Configuration( 167 host = "/api/v1" 168 ) 169 170 # The client must configure the authentication and authorization parameters 171 # in accordance with the API server security policy. 172 # Examples for each auth method are provided below, use the example that 173 # satisfies your auth use case. 174 175 # Configure HTTP basic authorization: basic_auth 176 configuration = lakefs_sdk.Configuration( 177 username = os.environ["USERNAME"], 178 password = os.environ["PASSWORD"] 179 ) 180 181 # Configure API key authorization: cookie_auth 182 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 183 184 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 185 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 186 187 # Configure API key authorization: oidc_auth 188 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 189 190 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 191 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 192 193 # Configure API key authorization: saml_auth 194 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 195 196 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 197 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 198 199 # Configure Bearer authorization (JWT): jwt_token 200 configuration = lakefs_sdk.Configuration( 201 access_token = os.environ["BEARER_TOKEN"] 202 ) 203 204 # Enter a context with an instance of the API client 205 with lakefs_sdk.ApiClient(configuration) as api_client: 206 # Create an instance of the API class 207 api_instance = lakefs_sdk.InternalApi(api_client) 208 repository = 'repository_example' # str | 209 commit_record_creation = lakefs_sdk.CommitRecordCreation() # CommitRecordCreation | 210 211 try: 212 # create commit record 213 api_instance.create_commit_record(repository, commit_record_creation) 214 except Exception as e: 215 print("Exception when calling InternalApi->create_commit_record: %s\n" % e) 216 ``` 217 218 219 220 ### Parameters 221 222 223 Name | Type | Description | Notes 224 ------------- | ------------- | ------------- | ------------- 225 **repository** | **str**| | 226 **commit_record_creation** | [**CommitRecordCreation**](CommitRecordCreation.md)| | 227 228 ### Return type 229 230 void (empty response body) 231 232 ### Authorization 233 234 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 235 236 ### HTTP request headers 237 238 - **Content-Type**: application/json 239 - **Accept**: application/json 240 241 ### HTTP response details 242 243 | Status code | Description | Response headers | 244 |-------------|-------------|------------------| 245 **204** | commit record created | - | 246 **400** | Validation Error | - | 247 **401** | Unauthorized | - | 248 **403** | Forbidden | - | 249 **404** | Resource Not Found | - | 250 **420** | too many requests | - | 251 **0** | Internal Server Error | - | 252 253 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 254 255 # **create_symlink_file** 256 > StorageURI create_symlink_file(repository, branch, location=location) 257 258 creates symlink files corresponding to the given directory 259 260 ### Example 261 262 * Basic Authentication (basic_auth): 263 * Api Key Authentication (cookie_auth): 264 * Api Key Authentication (oidc_auth): 265 * Api Key Authentication (saml_auth): 266 * Bearer (JWT) Authentication (jwt_token): 267 268 ```python 269 import time 270 import os 271 import lakefs_sdk 272 from lakefs_sdk.models.storage_uri import StorageURI 273 from lakefs_sdk.rest import ApiException 274 from pprint import pprint 275 276 # Defining the host is optional and defaults to /api/v1 277 # See configuration.py for a list of all supported configuration parameters. 278 configuration = lakefs_sdk.Configuration( 279 host = "/api/v1" 280 ) 281 282 # The client must configure the authentication and authorization parameters 283 # in accordance with the API server security policy. 284 # Examples for each auth method are provided below, use the example that 285 # satisfies your auth use case. 286 287 # Configure HTTP basic authorization: basic_auth 288 configuration = lakefs_sdk.Configuration( 289 username = os.environ["USERNAME"], 290 password = os.environ["PASSWORD"] 291 ) 292 293 # Configure API key authorization: cookie_auth 294 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 295 296 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 297 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 298 299 # Configure API key authorization: oidc_auth 300 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 301 302 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 303 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 304 305 # Configure API key authorization: saml_auth 306 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 307 308 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 309 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 310 311 # Configure Bearer authorization (JWT): jwt_token 312 configuration = lakefs_sdk.Configuration( 313 access_token = os.environ["BEARER_TOKEN"] 314 ) 315 316 # Enter a context with an instance of the API client 317 with lakefs_sdk.ApiClient(configuration) as api_client: 318 # Create an instance of the API class 319 api_instance = lakefs_sdk.InternalApi(api_client) 320 repository = 'repository_example' # str | 321 branch = 'branch_example' # str | 322 location = 'location_example' # str | path to the table data (optional) 323 324 try: 325 # creates symlink files corresponding to the given directory 326 api_response = api_instance.create_symlink_file(repository, branch, location=location) 327 print("The response of InternalApi->create_symlink_file:\n") 328 pprint(api_response) 329 except Exception as e: 330 print("Exception when calling InternalApi->create_symlink_file: %s\n" % e) 331 ``` 332 333 334 335 ### Parameters 336 337 338 Name | Type | Description | Notes 339 ------------- | ------------- | ------------- | ------------- 340 **repository** | **str**| | 341 **branch** | **str**| | 342 **location** | **str**| path to the table data | [optional] 343 344 ### Return type 345 346 [**StorageURI**](StorageURI.md) 347 348 ### Authorization 349 350 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 351 352 ### HTTP request headers 353 354 - **Content-Type**: Not defined 355 - **Accept**: application/json 356 357 ### HTTP response details 358 359 | Status code | Description | Response headers | 360 |-------------|-------------|------------------| 361 **201** | location created | - | 362 **401** | Unauthorized | - | 363 **404** | Resource Not Found | - | 364 **420** | too many requests | - | 365 **0** | Internal Server Error | - | 366 367 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 368 369 # **delete_repository_metadata** 370 > delete_repository_metadata(repository, repository_metadata_keys) 371 372 delete repository metadata 373 374 Delete specified keys from the repository's metadata. 375 376 ### Example 377 378 * Basic Authentication (basic_auth): 379 * Api Key Authentication (cookie_auth): 380 * Api Key Authentication (oidc_auth): 381 * Api Key Authentication (saml_auth): 382 * Bearer (JWT) Authentication (jwt_token): 383 384 ```python 385 import time 386 import os 387 import lakefs_sdk 388 from lakefs_sdk.models.repository_metadata_keys import RepositoryMetadataKeys 389 from lakefs_sdk.rest import ApiException 390 from pprint import pprint 391 392 # Defining the host is optional and defaults to /api/v1 393 # See configuration.py for a list of all supported configuration parameters. 394 configuration = lakefs_sdk.Configuration( 395 host = "/api/v1" 396 ) 397 398 # The client must configure the authentication and authorization parameters 399 # in accordance with the API server security policy. 400 # Examples for each auth method are provided below, use the example that 401 # satisfies your auth use case. 402 403 # Configure HTTP basic authorization: basic_auth 404 configuration = lakefs_sdk.Configuration( 405 username = os.environ["USERNAME"], 406 password = os.environ["PASSWORD"] 407 ) 408 409 # Configure API key authorization: cookie_auth 410 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 411 412 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 413 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 414 415 # Configure API key authorization: oidc_auth 416 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 417 418 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 419 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 420 421 # Configure API key authorization: saml_auth 422 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 423 424 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 425 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 426 427 # Configure Bearer authorization (JWT): jwt_token 428 configuration = lakefs_sdk.Configuration( 429 access_token = os.environ["BEARER_TOKEN"] 430 ) 431 432 # Enter a context with an instance of the API client 433 with lakefs_sdk.ApiClient(configuration) as api_client: 434 # Create an instance of the API class 435 api_instance = lakefs_sdk.InternalApi(api_client) 436 repository = 'repository_example' # str | 437 repository_metadata_keys = lakefs_sdk.RepositoryMetadataKeys() # RepositoryMetadataKeys | 438 439 try: 440 # delete repository metadata 441 api_instance.delete_repository_metadata(repository, repository_metadata_keys) 442 except Exception as e: 443 print("Exception when calling InternalApi->delete_repository_metadata: %s\n" % e) 444 ``` 445 446 447 448 ### Parameters 449 450 451 Name | Type | Description | Notes 452 ------------- | ------------- | ------------- | ------------- 453 **repository** | **str**| | 454 **repository_metadata_keys** | [**RepositoryMetadataKeys**](RepositoryMetadataKeys.md)| | 455 456 ### Return type 457 458 void (empty response body) 459 460 ### Authorization 461 462 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 463 464 ### HTTP request headers 465 466 - **Content-Type**: application/json 467 - **Accept**: application/json 468 469 ### HTTP response details 470 471 | Status code | Description | Response headers | 472 |-------------|-------------|------------------| 473 **204** | repository metadata keys deleted successfully | - | 474 **401** | Unauthorized | - | 475 **420** | too many requests | - | 476 **0** | Internal Server Error | - | 477 478 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 479 480 # **dump_refs** 481 > RefsDump dump_refs(repository) 482 483 Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations 484 485 ### Example 486 487 * Basic Authentication (basic_auth): 488 * Api Key Authentication (cookie_auth): 489 * Api Key Authentication (oidc_auth): 490 * Api Key Authentication (saml_auth): 491 * Bearer (JWT) Authentication (jwt_token): 492 493 ```python 494 import time 495 import os 496 import lakefs_sdk 497 from lakefs_sdk.models.refs_dump import RefsDump 498 from lakefs_sdk.rest import ApiException 499 from pprint import pprint 500 501 # Defining the host is optional and defaults to /api/v1 502 # See configuration.py for a list of all supported configuration parameters. 503 configuration = lakefs_sdk.Configuration( 504 host = "/api/v1" 505 ) 506 507 # The client must configure the authentication and authorization parameters 508 # in accordance with the API server security policy. 509 # Examples for each auth method are provided below, use the example that 510 # satisfies your auth use case. 511 512 # Configure HTTP basic authorization: basic_auth 513 configuration = lakefs_sdk.Configuration( 514 username = os.environ["USERNAME"], 515 password = os.environ["PASSWORD"] 516 ) 517 518 # Configure API key authorization: cookie_auth 519 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 520 521 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 522 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 523 524 # Configure API key authorization: oidc_auth 525 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 526 527 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 528 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 529 530 # Configure API key authorization: saml_auth 531 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 532 533 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 534 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 535 536 # Configure Bearer authorization (JWT): jwt_token 537 configuration = lakefs_sdk.Configuration( 538 access_token = os.environ["BEARER_TOKEN"] 539 ) 540 541 # Enter a context with an instance of the API client 542 with lakefs_sdk.ApiClient(configuration) as api_client: 543 # Create an instance of the API class 544 api_instance = lakefs_sdk.InternalApi(api_client) 545 repository = 'repository_example' # str | 546 547 try: 548 # Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations 549 api_response = api_instance.dump_refs(repository) 550 print("The response of InternalApi->dump_refs:\n") 551 pprint(api_response) 552 except Exception as e: 553 print("Exception when calling InternalApi->dump_refs: %s\n" % e) 554 ``` 555 556 557 558 ### Parameters 559 560 561 Name | Type | Description | Notes 562 ------------- | ------------- | ------------- | ------------- 563 **repository** | **str**| | 564 565 ### Return type 566 567 [**RefsDump**](RefsDump.md) 568 569 ### Authorization 570 571 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 572 573 ### HTTP request headers 574 575 - **Content-Type**: Not defined 576 - **Accept**: application/json 577 578 ### HTTP response details 579 580 | Status code | Description | Response headers | 581 |-------------|-------------|------------------| 582 **201** | refs dump | - | 583 **400** | Validation Error | - | 584 **401** | Unauthorized | - | 585 **404** | Resource Not Found | - | 586 **420** | too many requests | - | 587 **0** | Internal Server Error | - | 588 589 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 590 591 # **get_auth_capabilities** 592 > AuthCapabilities get_auth_capabilities() 593 594 list authentication capabilities supported 595 596 ### Example 597 598 599 ```python 600 import time 601 import os 602 import lakefs_sdk 603 from lakefs_sdk.models.auth_capabilities import AuthCapabilities 604 from lakefs_sdk.rest import ApiException 605 from pprint import pprint 606 607 # Defining the host is optional and defaults to /api/v1 608 # See configuration.py for a list of all supported configuration parameters. 609 configuration = lakefs_sdk.Configuration( 610 host = "/api/v1" 611 ) 612 613 614 # Enter a context with an instance of the API client 615 with lakefs_sdk.ApiClient(configuration) as api_client: 616 # Create an instance of the API class 617 api_instance = lakefs_sdk.InternalApi(api_client) 618 619 try: 620 # list authentication capabilities supported 621 api_response = api_instance.get_auth_capabilities() 622 print("The response of InternalApi->get_auth_capabilities:\n") 623 pprint(api_response) 624 except Exception as e: 625 print("Exception when calling InternalApi->get_auth_capabilities: %s\n" % e) 626 ``` 627 628 629 630 ### Parameters 631 632 This endpoint does not need any parameter. 633 634 ### Return type 635 636 [**AuthCapabilities**](AuthCapabilities.md) 637 638 ### Authorization 639 640 No authorization required 641 642 ### HTTP request headers 643 644 - **Content-Type**: Not defined 645 - **Accept**: application/json 646 647 ### HTTP response details 648 649 | Status code | Description | Response headers | 650 |-------------|-------------|------------------| 651 **200** | auth capabilities | - | 652 **420** | too many requests | - | 653 **0** | Internal Server Error | - | 654 655 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 656 657 # **get_garbage_collection_config** 658 > GarbageCollectionConfig get_garbage_collection_config() 659 660 661 662 get information of gc settings 663 664 ### Example 665 666 * Basic Authentication (basic_auth): 667 * Api Key Authentication (cookie_auth): 668 * Api Key Authentication (oidc_auth): 669 * Api Key Authentication (saml_auth): 670 * Bearer (JWT) Authentication (jwt_token): 671 672 ```python 673 import time 674 import os 675 import lakefs_sdk 676 from lakefs_sdk.models.garbage_collection_config import GarbageCollectionConfig 677 from lakefs_sdk.rest import ApiException 678 from pprint import pprint 679 680 # Defining the host is optional and defaults to /api/v1 681 # See configuration.py for a list of all supported configuration parameters. 682 configuration = lakefs_sdk.Configuration( 683 host = "/api/v1" 684 ) 685 686 # The client must configure the authentication and authorization parameters 687 # in accordance with the API server security policy. 688 # Examples for each auth method are provided below, use the example that 689 # satisfies your auth use case. 690 691 # Configure HTTP basic authorization: basic_auth 692 configuration = lakefs_sdk.Configuration( 693 username = os.environ["USERNAME"], 694 password = os.environ["PASSWORD"] 695 ) 696 697 # Configure API key authorization: cookie_auth 698 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 699 700 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 701 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 702 703 # Configure API key authorization: oidc_auth 704 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 705 706 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 707 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 708 709 # Configure API key authorization: saml_auth 710 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 711 712 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 713 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 714 715 # Configure Bearer authorization (JWT): jwt_token 716 configuration = lakefs_sdk.Configuration( 717 access_token = os.environ["BEARER_TOKEN"] 718 ) 719 720 # Enter a context with an instance of the API client 721 with lakefs_sdk.ApiClient(configuration) as api_client: 722 # Create an instance of the API class 723 api_instance = lakefs_sdk.InternalApi(api_client) 724 725 try: 726 api_response = api_instance.get_garbage_collection_config() 727 print("The response of InternalApi->get_garbage_collection_config:\n") 728 pprint(api_response) 729 except Exception as e: 730 print("Exception when calling InternalApi->get_garbage_collection_config: %s\n" % e) 731 ``` 732 733 734 735 ### Parameters 736 737 This endpoint does not need any parameter. 738 739 ### Return type 740 741 [**GarbageCollectionConfig**](GarbageCollectionConfig.md) 742 743 ### Authorization 744 745 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 746 747 ### HTTP request headers 748 749 - **Content-Type**: Not defined 750 - **Accept**: application/json 751 752 ### HTTP response details 753 754 | Status code | Description | Response headers | 755 |-------------|-------------|------------------| 756 **200** | lakeFS garbage collection config | - | 757 **401** | Unauthorized | - | 758 759 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 760 761 # **get_lake_fs_version** 762 > VersionConfig get_lake_fs_version() 763 764 765 766 get version of lakeFS server 767 768 ### Example 769 770 * Basic Authentication (basic_auth): 771 * Api Key Authentication (cookie_auth): 772 * Api Key Authentication (oidc_auth): 773 * Api Key Authentication (saml_auth): 774 * Bearer (JWT) Authentication (jwt_token): 775 776 ```python 777 import time 778 import os 779 import lakefs_sdk 780 from lakefs_sdk.models.version_config import VersionConfig 781 from lakefs_sdk.rest import ApiException 782 from pprint import pprint 783 784 # Defining the host is optional and defaults to /api/v1 785 # See configuration.py for a list of all supported configuration parameters. 786 configuration = lakefs_sdk.Configuration( 787 host = "/api/v1" 788 ) 789 790 # The client must configure the authentication and authorization parameters 791 # in accordance with the API server security policy. 792 # Examples for each auth method are provided below, use the example that 793 # satisfies your auth use case. 794 795 # Configure HTTP basic authorization: basic_auth 796 configuration = lakefs_sdk.Configuration( 797 username = os.environ["USERNAME"], 798 password = os.environ["PASSWORD"] 799 ) 800 801 # Configure API key authorization: cookie_auth 802 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 803 804 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 805 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 806 807 # Configure API key authorization: oidc_auth 808 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 809 810 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 811 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 812 813 # Configure API key authorization: saml_auth 814 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 815 816 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 817 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 818 819 # Configure Bearer authorization (JWT): jwt_token 820 configuration = lakefs_sdk.Configuration( 821 access_token = os.environ["BEARER_TOKEN"] 822 ) 823 824 # Enter a context with an instance of the API client 825 with lakefs_sdk.ApiClient(configuration) as api_client: 826 # Create an instance of the API class 827 api_instance = lakefs_sdk.InternalApi(api_client) 828 829 try: 830 api_response = api_instance.get_lake_fs_version() 831 print("The response of InternalApi->get_lake_fs_version:\n") 832 pprint(api_response) 833 except Exception as e: 834 print("Exception when calling InternalApi->get_lake_fs_version: %s\n" % e) 835 ``` 836 837 838 839 ### Parameters 840 841 This endpoint does not need any parameter. 842 843 ### Return type 844 845 [**VersionConfig**](VersionConfig.md) 846 847 ### Authorization 848 849 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 850 851 ### HTTP request headers 852 853 - **Content-Type**: Not defined 854 - **Accept**: application/json 855 856 ### HTTP response details 857 858 | Status code | Description | Response headers | 859 |-------------|-------------|------------------| 860 **200** | lakeFS version | - | 861 **401** | Unauthorized | - | 862 863 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 864 865 # **get_setup_state** 866 > SetupState get_setup_state() 867 868 check if the lakeFS installation is already set up 869 870 ### Example 871 872 873 ```python 874 import time 875 import os 876 import lakefs_sdk 877 from lakefs_sdk.models.setup_state import SetupState 878 from lakefs_sdk.rest import ApiException 879 from pprint import pprint 880 881 # Defining the host is optional and defaults to /api/v1 882 # See configuration.py for a list of all supported configuration parameters. 883 configuration = lakefs_sdk.Configuration( 884 host = "/api/v1" 885 ) 886 887 888 # Enter a context with an instance of the API client 889 with lakefs_sdk.ApiClient(configuration) as api_client: 890 # Create an instance of the API class 891 api_instance = lakefs_sdk.InternalApi(api_client) 892 893 try: 894 # check if the lakeFS installation is already set up 895 api_response = api_instance.get_setup_state() 896 print("The response of InternalApi->get_setup_state:\n") 897 pprint(api_response) 898 except Exception as e: 899 print("Exception when calling InternalApi->get_setup_state: %s\n" % e) 900 ``` 901 902 903 904 ### Parameters 905 906 This endpoint does not need any parameter. 907 908 ### Return type 909 910 [**SetupState**](SetupState.md) 911 912 ### Authorization 913 914 No authorization required 915 916 ### HTTP request headers 917 918 - **Content-Type**: Not defined 919 - **Accept**: application/json 920 921 ### HTTP response details 922 923 | Status code | Description | Response headers | 924 |-------------|-------------|------------------| 925 **200** | lakeFS setup state | - | 926 **420** | too many requests | - | 927 **0** | Internal Server Error | - | 928 929 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 930 931 # **get_storage_config** 932 > StorageConfig get_storage_config() 933 934 935 936 retrieve lakeFS storage configuration 937 938 ### Example 939 940 * Basic Authentication (basic_auth): 941 * Api Key Authentication (cookie_auth): 942 * Api Key Authentication (oidc_auth): 943 * Api Key Authentication (saml_auth): 944 * Bearer (JWT) Authentication (jwt_token): 945 946 ```python 947 import time 948 import os 949 import lakefs_sdk 950 from lakefs_sdk.models.storage_config import StorageConfig 951 from lakefs_sdk.rest import ApiException 952 from pprint import pprint 953 954 # Defining the host is optional and defaults to /api/v1 955 # See configuration.py for a list of all supported configuration parameters. 956 configuration = lakefs_sdk.Configuration( 957 host = "/api/v1" 958 ) 959 960 # The client must configure the authentication and authorization parameters 961 # in accordance with the API server security policy. 962 # Examples for each auth method are provided below, use the example that 963 # satisfies your auth use case. 964 965 # Configure HTTP basic authorization: basic_auth 966 configuration = lakefs_sdk.Configuration( 967 username = os.environ["USERNAME"], 968 password = os.environ["PASSWORD"] 969 ) 970 971 # Configure API key authorization: cookie_auth 972 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 973 974 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 975 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 976 977 # Configure API key authorization: oidc_auth 978 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 979 980 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 981 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 982 983 # Configure API key authorization: saml_auth 984 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 985 986 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 987 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 988 989 # Configure Bearer authorization (JWT): jwt_token 990 configuration = lakefs_sdk.Configuration( 991 access_token = os.environ["BEARER_TOKEN"] 992 ) 993 994 # Enter a context with an instance of the API client 995 with lakefs_sdk.ApiClient(configuration) as api_client: 996 # Create an instance of the API class 997 api_instance = lakefs_sdk.InternalApi(api_client) 998 999 try: 1000 api_response = api_instance.get_storage_config() 1001 print("The response of InternalApi->get_storage_config:\n") 1002 pprint(api_response) 1003 except Exception as e: 1004 print("Exception when calling InternalApi->get_storage_config: %s\n" % e) 1005 ``` 1006 1007 1008 1009 ### Parameters 1010 1011 This endpoint does not need any parameter. 1012 1013 ### Return type 1014 1015 [**StorageConfig**](StorageConfig.md) 1016 1017 ### Authorization 1018 1019 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1020 1021 ### HTTP request headers 1022 1023 - **Content-Type**: Not defined 1024 - **Accept**: application/json 1025 1026 ### HTTP response details 1027 1028 | Status code | Description | Response headers | 1029 |-------------|-------------|------------------| 1030 **200** | lakeFS storage configuration | - | 1031 **401** | Unauthorized | - | 1032 1033 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1034 1035 # **get_usage_report_summary** 1036 > InstallationUsageReport get_usage_report_summary() 1037 1038 get usage report summary 1039 1040 ### Example 1041 1042 * Basic Authentication (basic_auth): 1043 * Api Key Authentication (cookie_auth): 1044 * Api Key Authentication (oidc_auth): 1045 * Api Key Authentication (saml_auth): 1046 * Bearer (JWT) Authentication (jwt_token): 1047 1048 ```python 1049 import time 1050 import os 1051 import lakefs_sdk 1052 from lakefs_sdk.models.installation_usage_report import InstallationUsageReport 1053 from lakefs_sdk.rest import ApiException 1054 from pprint import pprint 1055 1056 # Defining the host is optional and defaults to /api/v1 1057 # See configuration.py for a list of all supported configuration parameters. 1058 configuration = lakefs_sdk.Configuration( 1059 host = "/api/v1" 1060 ) 1061 1062 # The client must configure the authentication and authorization parameters 1063 # in accordance with the API server security policy. 1064 # Examples for each auth method are provided below, use the example that 1065 # satisfies your auth use case. 1066 1067 # Configure HTTP basic authorization: basic_auth 1068 configuration = lakefs_sdk.Configuration( 1069 username = os.environ["USERNAME"], 1070 password = os.environ["PASSWORD"] 1071 ) 1072 1073 # Configure API key authorization: cookie_auth 1074 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1075 1076 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1077 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1078 1079 # Configure API key authorization: oidc_auth 1080 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1081 1082 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1083 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1084 1085 # Configure API key authorization: saml_auth 1086 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1087 1088 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1089 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1090 1091 # Configure Bearer authorization (JWT): jwt_token 1092 configuration = lakefs_sdk.Configuration( 1093 access_token = os.environ["BEARER_TOKEN"] 1094 ) 1095 1096 # Enter a context with an instance of the API client 1097 with lakefs_sdk.ApiClient(configuration) as api_client: 1098 # Create an instance of the API class 1099 api_instance = lakefs_sdk.InternalApi(api_client) 1100 1101 try: 1102 # get usage report summary 1103 api_response = api_instance.get_usage_report_summary() 1104 print("The response of InternalApi->get_usage_report_summary:\n") 1105 pprint(api_response) 1106 except Exception as e: 1107 print("Exception when calling InternalApi->get_usage_report_summary: %s\n" % e) 1108 ``` 1109 1110 1111 1112 ### Parameters 1113 1114 This endpoint does not need any parameter. 1115 1116 ### Return type 1117 1118 [**InstallationUsageReport**](InstallationUsageReport.md) 1119 1120 ### Authorization 1121 1122 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1123 1124 ### HTTP request headers 1125 1126 - **Content-Type**: Not defined 1127 - **Accept**: application/json, application/text 1128 1129 ### HTTP response details 1130 1131 | Status code | Description | Response headers | 1132 |-------------|-------------|------------------| 1133 **200** | Usage report | - | 1134 **400** | Bad Request | - | 1135 **401** | Unauthorized | - | 1136 **404** | Resource Not Found | - | 1137 **420** | too many requests | - | 1138 **0** | Internal Server Error | - | 1139 1140 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1141 1142 # **internal_create_branch_protection_rule** 1143 > internal_create_branch_protection_rule(repository, branch_protection_rule) 1144 1145 1146 1147 ### Example 1148 1149 * Basic Authentication (basic_auth): 1150 * Api Key Authentication (cookie_auth): 1151 * Api Key Authentication (oidc_auth): 1152 * Api Key Authentication (saml_auth): 1153 * Bearer (JWT) Authentication (jwt_token): 1154 1155 ```python 1156 import time 1157 import os 1158 import lakefs_sdk 1159 from lakefs_sdk.models.branch_protection_rule import BranchProtectionRule 1160 from lakefs_sdk.rest import ApiException 1161 from pprint import pprint 1162 1163 # Defining the host is optional and defaults to /api/v1 1164 # See configuration.py for a list of all supported configuration parameters. 1165 configuration = lakefs_sdk.Configuration( 1166 host = "/api/v1" 1167 ) 1168 1169 # The client must configure the authentication and authorization parameters 1170 # in accordance with the API server security policy. 1171 # Examples for each auth method are provided below, use the example that 1172 # satisfies your auth use case. 1173 1174 # Configure HTTP basic authorization: basic_auth 1175 configuration = lakefs_sdk.Configuration( 1176 username = os.environ["USERNAME"], 1177 password = os.environ["PASSWORD"] 1178 ) 1179 1180 # Configure API key authorization: cookie_auth 1181 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1182 1183 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1184 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1185 1186 # Configure API key authorization: oidc_auth 1187 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1188 1189 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1190 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1191 1192 # Configure API key authorization: saml_auth 1193 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1194 1195 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1196 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1197 1198 # Configure Bearer authorization (JWT): jwt_token 1199 configuration = lakefs_sdk.Configuration( 1200 access_token = os.environ["BEARER_TOKEN"] 1201 ) 1202 1203 # Enter a context with an instance of the API client 1204 with lakefs_sdk.ApiClient(configuration) as api_client: 1205 # Create an instance of the API class 1206 api_instance = lakefs_sdk.InternalApi(api_client) 1207 repository = 'repository_example' # str | 1208 branch_protection_rule = lakefs_sdk.BranchProtectionRule() # BranchProtectionRule | 1209 1210 try: 1211 api_instance.internal_create_branch_protection_rule(repository, branch_protection_rule) 1212 except Exception as e: 1213 print("Exception when calling InternalApi->internal_create_branch_protection_rule: %s\n" % e) 1214 ``` 1215 1216 1217 1218 ### Parameters 1219 1220 1221 Name | Type | Description | Notes 1222 ------------- | ------------- | ------------- | ------------- 1223 **repository** | **str**| | 1224 **branch_protection_rule** | [**BranchProtectionRule**](BranchProtectionRule.md)| | 1225 1226 ### Return type 1227 1228 void (empty response body) 1229 1230 ### Authorization 1231 1232 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1233 1234 ### HTTP request headers 1235 1236 - **Content-Type**: application/json 1237 - **Accept**: application/json 1238 1239 ### HTTP response details 1240 1241 | Status code | Description | Response headers | 1242 |-------------|-------------|------------------| 1243 **204** | branch protection rule created successfully | - | 1244 **401** | Unauthorized | - | 1245 **404** | Resource Not Found | - | 1246 **420** | too many requests | - | 1247 **0** | Internal Server Error | - | 1248 1249 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1250 1251 # **internal_delete_branch_protection_rule** 1252 > internal_delete_branch_protection_rule(repository, internal_delete_branch_protection_rule_request) 1253 1254 1255 1256 ### Example 1257 1258 * Basic Authentication (basic_auth): 1259 * Api Key Authentication (cookie_auth): 1260 * Api Key Authentication (oidc_auth): 1261 * Api Key Authentication (saml_auth): 1262 * Bearer (JWT) Authentication (jwt_token): 1263 1264 ```python 1265 import time 1266 import os 1267 import lakefs_sdk 1268 from lakefs_sdk.models.internal_delete_branch_protection_rule_request import InternalDeleteBranchProtectionRuleRequest 1269 from lakefs_sdk.rest import ApiException 1270 from pprint import pprint 1271 1272 # Defining the host is optional and defaults to /api/v1 1273 # See configuration.py for a list of all supported configuration parameters. 1274 configuration = lakefs_sdk.Configuration( 1275 host = "/api/v1" 1276 ) 1277 1278 # The client must configure the authentication and authorization parameters 1279 # in accordance with the API server security policy. 1280 # Examples for each auth method are provided below, use the example that 1281 # satisfies your auth use case. 1282 1283 # Configure HTTP basic authorization: basic_auth 1284 configuration = lakefs_sdk.Configuration( 1285 username = os.environ["USERNAME"], 1286 password = os.environ["PASSWORD"] 1287 ) 1288 1289 # Configure API key authorization: cookie_auth 1290 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1291 1292 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1293 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1294 1295 # Configure API key authorization: oidc_auth 1296 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1297 1298 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1299 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1300 1301 # Configure API key authorization: saml_auth 1302 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1303 1304 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1305 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1306 1307 # Configure Bearer authorization (JWT): jwt_token 1308 configuration = lakefs_sdk.Configuration( 1309 access_token = os.environ["BEARER_TOKEN"] 1310 ) 1311 1312 # Enter a context with an instance of the API client 1313 with lakefs_sdk.ApiClient(configuration) as api_client: 1314 # Create an instance of the API class 1315 api_instance = lakefs_sdk.InternalApi(api_client) 1316 repository = 'repository_example' # str | 1317 internal_delete_branch_protection_rule_request = lakefs_sdk.InternalDeleteBranchProtectionRuleRequest() # InternalDeleteBranchProtectionRuleRequest | 1318 1319 try: 1320 api_instance.internal_delete_branch_protection_rule(repository, internal_delete_branch_protection_rule_request) 1321 except Exception as e: 1322 print("Exception when calling InternalApi->internal_delete_branch_protection_rule: %s\n" % e) 1323 ``` 1324 1325 1326 1327 ### Parameters 1328 1329 1330 Name | Type | Description | Notes 1331 ------------- | ------------- | ------------- | ------------- 1332 **repository** | **str**| | 1333 **internal_delete_branch_protection_rule_request** | [**InternalDeleteBranchProtectionRuleRequest**](InternalDeleteBranchProtectionRuleRequest.md)| | 1334 1335 ### Return type 1336 1337 void (empty response body) 1338 1339 ### Authorization 1340 1341 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1342 1343 ### HTTP request headers 1344 1345 - **Content-Type**: application/json 1346 - **Accept**: application/json 1347 1348 ### HTTP response details 1349 1350 | Status code | Description | Response headers | 1351 |-------------|-------------|------------------| 1352 **204** | branch protection rule deleted successfully | - | 1353 **401** | Unauthorized | - | 1354 **404** | Resource Not Found | - | 1355 **420** | too many requests | - | 1356 **0** | Internal Server Error | - | 1357 1358 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1359 1360 # **internal_delete_garbage_collection_rules** 1361 > internal_delete_garbage_collection_rules(repository) 1362 1363 1364 1365 ### Example 1366 1367 * Basic Authentication (basic_auth): 1368 * Api Key Authentication (cookie_auth): 1369 * Api Key Authentication (oidc_auth): 1370 * Api Key Authentication (saml_auth): 1371 * Bearer (JWT) Authentication (jwt_token): 1372 1373 ```python 1374 import time 1375 import os 1376 import lakefs_sdk 1377 from lakefs_sdk.rest import ApiException 1378 from pprint import pprint 1379 1380 # Defining the host is optional and defaults to /api/v1 1381 # See configuration.py for a list of all supported configuration parameters. 1382 configuration = lakefs_sdk.Configuration( 1383 host = "/api/v1" 1384 ) 1385 1386 # The client must configure the authentication and authorization parameters 1387 # in accordance with the API server security policy. 1388 # Examples for each auth method are provided below, use the example that 1389 # satisfies your auth use case. 1390 1391 # Configure HTTP basic authorization: basic_auth 1392 configuration = lakefs_sdk.Configuration( 1393 username = os.environ["USERNAME"], 1394 password = os.environ["PASSWORD"] 1395 ) 1396 1397 # Configure API key authorization: cookie_auth 1398 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1399 1400 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1401 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1402 1403 # Configure API key authorization: oidc_auth 1404 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1405 1406 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1407 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1408 1409 # Configure API key authorization: saml_auth 1410 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1411 1412 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1413 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1414 1415 # Configure Bearer authorization (JWT): jwt_token 1416 configuration = lakefs_sdk.Configuration( 1417 access_token = os.environ["BEARER_TOKEN"] 1418 ) 1419 1420 # Enter a context with an instance of the API client 1421 with lakefs_sdk.ApiClient(configuration) as api_client: 1422 # Create an instance of the API class 1423 api_instance = lakefs_sdk.InternalApi(api_client) 1424 repository = 'repository_example' # str | 1425 1426 try: 1427 api_instance.internal_delete_garbage_collection_rules(repository) 1428 except Exception as e: 1429 print("Exception when calling InternalApi->internal_delete_garbage_collection_rules: %s\n" % e) 1430 ``` 1431 1432 1433 1434 ### Parameters 1435 1436 1437 Name | Type | Description | Notes 1438 ------------- | ------------- | ------------- | ------------- 1439 **repository** | **str**| | 1440 1441 ### Return type 1442 1443 void (empty response body) 1444 1445 ### Authorization 1446 1447 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1448 1449 ### HTTP request headers 1450 1451 - **Content-Type**: Not defined 1452 - **Accept**: application/json 1453 1454 ### HTTP response details 1455 1456 | Status code | Description | Response headers | 1457 |-------------|-------------|------------------| 1458 **204** | deleted garbage collection rules successfully | - | 1459 **401** | Unauthorized | - | 1460 **404** | Resource Not Found | - | 1461 **420** | too many requests | - | 1462 **0** | Internal Server Error | - | 1463 1464 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1465 1466 # **internal_get_branch_protection_rules** 1467 > List[BranchProtectionRule] internal_get_branch_protection_rules(repository) 1468 1469 get branch protection rules 1470 1471 ### Example 1472 1473 * Basic Authentication (basic_auth): 1474 * Api Key Authentication (cookie_auth): 1475 * Api Key Authentication (oidc_auth): 1476 * Api Key Authentication (saml_auth): 1477 * Bearer (JWT) Authentication (jwt_token): 1478 1479 ```python 1480 import time 1481 import os 1482 import lakefs_sdk 1483 from lakefs_sdk.models.branch_protection_rule import BranchProtectionRule 1484 from lakefs_sdk.rest import ApiException 1485 from pprint import pprint 1486 1487 # Defining the host is optional and defaults to /api/v1 1488 # See configuration.py for a list of all supported configuration parameters. 1489 configuration = lakefs_sdk.Configuration( 1490 host = "/api/v1" 1491 ) 1492 1493 # The client must configure the authentication and authorization parameters 1494 # in accordance with the API server security policy. 1495 # Examples for each auth method are provided below, use the example that 1496 # satisfies your auth use case. 1497 1498 # Configure HTTP basic authorization: basic_auth 1499 configuration = lakefs_sdk.Configuration( 1500 username = os.environ["USERNAME"], 1501 password = os.environ["PASSWORD"] 1502 ) 1503 1504 # Configure API key authorization: cookie_auth 1505 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1506 1507 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1508 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1509 1510 # Configure API key authorization: oidc_auth 1511 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1512 1513 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1514 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1515 1516 # Configure API key authorization: saml_auth 1517 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1518 1519 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1520 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1521 1522 # Configure Bearer authorization (JWT): jwt_token 1523 configuration = lakefs_sdk.Configuration( 1524 access_token = os.environ["BEARER_TOKEN"] 1525 ) 1526 1527 # Enter a context with an instance of the API client 1528 with lakefs_sdk.ApiClient(configuration) as api_client: 1529 # Create an instance of the API class 1530 api_instance = lakefs_sdk.InternalApi(api_client) 1531 repository = 'repository_example' # str | 1532 1533 try: 1534 # get branch protection rules 1535 api_response = api_instance.internal_get_branch_protection_rules(repository) 1536 print("The response of InternalApi->internal_get_branch_protection_rules:\n") 1537 pprint(api_response) 1538 except Exception as e: 1539 print("Exception when calling InternalApi->internal_get_branch_protection_rules: %s\n" % e) 1540 ``` 1541 1542 1543 1544 ### Parameters 1545 1546 1547 Name | Type | Description | Notes 1548 ------------- | ------------- | ------------- | ------------- 1549 **repository** | **str**| | 1550 1551 ### Return type 1552 1553 [**List[BranchProtectionRule]**](BranchProtectionRule.md) 1554 1555 ### Authorization 1556 1557 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1558 1559 ### HTTP request headers 1560 1561 - **Content-Type**: Not defined 1562 - **Accept**: application/json 1563 1564 ### HTTP response details 1565 1566 | Status code | Description | Response headers | 1567 |-------------|-------------|------------------| 1568 **200** | branch protection rules | - | 1569 **401** | Unauthorized | - | 1570 **404** | Resource Not Found | - | 1571 **420** | too many requests | - | 1572 **0** | Internal Server Error | - | 1573 1574 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1575 1576 # **internal_get_garbage_collection_rules** 1577 > GarbageCollectionRules internal_get_garbage_collection_rules(repository) 1578 1579 1580 1581 ### Example 1582 1583 * Basic Authentication (basic_auth): 1584 * Api Key Authentication (cookie_auth): 1585 * Api Key Authentication (oidc_auth): 1586 * Api Key Authentication (saml_auth): 1587 * Bearer (JWT) Authentication (jwt_token): 1588 1589 ```python 1590 import time 1591 import os 1592 import lakefs_sdk 1593 from lakefs_sdk.models.garbage_collection_rules import GarbageCollectionRules 1594 from lakefs_sdk.rest import ApiException 1595 from pprint import pprint 1596 1597 # Defining the host is optional and defaults to /api/v1 1598 # See configuration.py for a list of all supported configuration parameters. 1599 configuration = lakefs_sdk.Configuration( 1600 host = "/api/v1" 1601 ) 1602 1603 # The client must configure the authentication and authorization parameters 1604 # in accordance with the API server security policy. 1605 # Examples for each auth method are provided below, use the example that 1606 # satisfies your auth use case. 1607 1608 # Configure HTTP basic authorization: basic_auth 1609 configuration = lakefs_sdk.Configuration( 1610 username = os.environ["USERNAME"], 1611 password = os.environ["PASSWORD"] 1612 ) 1613 1614 # Configure API key authorization: cookie_auth 1615 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1616 1617 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1618 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1619 1620 # Configure API key authorization: oidc_auth 1621 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1622 1623 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1624 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1625 1626 # Configure API key authorization: saml_auth 1627 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1628 1629 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1630 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1631 1632 # Configure Bearer authorization (JWT): jwt_token 1633 configuration = lakefs_sdk.Configuration( 1634 access_token = os.environ["BEARER_TOKEN"] 1635 ) 1636 1637 # Enter a context with an instance of the API client 1638 with lakefs_sdk.ApiClient(configuration) as api_client: 1639 # Create an instance of the API class 1640 api_instance = lakefs_sdk.InternalApi(api_client) 1641 repository = 'repository_example' # str | 1642 1643 try: 1644 api_response = api_instance.internal_get_garbage_collection_rules(repository) 1645 print("The response of InternalApi->internal_get_garbage_collection_rules:\n") 1646 pprint(api_response) 1647 except Exception as e: 1648 print("Exception when calling InternalApi->internal_get_garbage_collection_rules: %s\n" % e) 1649 ``` 1650 1651 1652 1653 ### Parameters 1654 1655 1656 Name | Type | Description | Notes 1657 ------------- | ------------- | ------------- | ------------- 1658 **repository** | **str**| | 1659 1660 ### Return type 1661 1662 [**GarbageCollectionRules**](GarbageCollectionRules.md) 1663 1664 ### Authorization 1665 1666 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1667 1668 ### HTTP request headers 1669 1670 - **Content-Type**: Not defined 1671 - **Accept**: application/json 1672 1673 ### HTTP response details 1674 1675 | Status code | Description | Response headers | 1676 |-------------|-------------|------------------| 1677 **200** | gc rule list | - | 1678 **401** | Unauthorized | - | 1679 **404** | Resource Not Found | - | 1680 **420** | too many requests | - | 1681 **0** | Internal Server Error | - | 1682 1683 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1684 1685 # **internal_set_garbage_collection_rules** 1686 > internal_set_garbage_collection_rules(repository, garbage_collection_rules) 1687 1688 1689 1690 ### Example 1691 1692 * Basic Authentication (basic_auth): 1693 * Api Key Authentication (cookie_auth): 1694 * Api Key Authentication (oidc_auth): 1695 * Api Key Authentication (saml_auth): 1696 * Bearer (JWT) Authentication (jwt_token): 1697 1698 ```python 1699 import time 1700 import os 1701 import lakefs_sdk 1702 from lakefs_sdk.models.garbage_collection_rules import GarbageCollectionRules 1703 from lakefs_sdk.rest import ApiException 1704 from pprint import pprint 1705 1706 # Defining the host is optional and defaults to /api/v1 1707 # See configuration.py for a list of all supported configuration parameters. 1708 configuration = lakefs_sdk.Configuration( 1709 host = "/api/v1" 1710 ) 1711 1712 # The client must configure the authentication and authorization parameters 1713 # in accordance with the API server security policy. 1714 # Examples for each auth method are provided below, use the example that 1715 # satisfies your auth use case. 1716 1717 # Configure HTTP basic authorization: basic_auth 1718 configuration = lakefs_sdk.Configuration( 1719 username = os.environ["USERNAME"], 1720 password = os.environ["PASSWORD"] 1721 ) 1722 1723 # Configure API key authorization: cookie_auth 1724 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1725 1726 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1727 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1728 1729 # Configure API key authorization: oidc_auth 1730 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1731 1732 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1733 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1734 1735 # Configure API key authorization: saml_auth 1736 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1737 1738 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1739 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1740 1741 # Configure Bearer authorization (JWT): jwt_token 1742 configuration = lakefs_sdk.Configuration( 1743 access_token = os.environ["BEARER_TOKEN"] 1744 ) 1745 1746 # Enter a context with an instance of the API client 1747 with lakefs_sdk.ApiClient(configuration) as api_client: 1748 # Create an instance of the API class 1749 api_instance = lakefs_sdk.InternalApi(api_client) 1750 repository = 'repository_example' # str | 1751 garbage_collection_rules = lakefs_sdk.GarbageCollectionRules() # GarbageCollectionRules | 1752 1753 try: 1754 api_instance.internal_set_garbage_collection_rules(repository, garbage_collection_rules) 1755 except Exception as e: 1756 print("Exception when calling InternalApi->internal_set_garbage_collection_rules: %s\n" % e) 1757 ``` 1758 1759 1760 1761 ### Parameters 1762 1763 1764 Name | Type | Description | Notes 1765 ------------- | ------------- | ------------- | ------------- 1766 **repository** | **str**| | 1767 **garbage_collection_rules** | [**GarbageCollectionRules**](GarbageCollectionRules.md)| | 1768 1769 ### Return type 1770 1771 void (empty response body) 1772 1773 ### Authorization 1774 1775 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1776 1777 ### HTTP request headers 1778 1779 - **Content-Type**: application/json 1780 - **Accept**: application/json 1781 1782 ### HTTP response details 1783 1784 | Status code | Description | Response headers | 1785 |-------------|-------------|------------------| 1786 **204** | set garbage collection rules successfully | - | 1787 **401** | Unauthorized | - | 1788 **404** | Resource Not Found | - | 1789 **420** | too many requests | - | 1790 **0** | Internal Server Error | - | 1791 1792 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1793 1794 # **post_stats_events** 1795 > post_stats_events(stats_events_list) 1796 1797 post stats events, this endpoint is meant for internal use only 1798 1799 ### Example 1800 1801 * Basic Authentication (basic_auth): 1802 * Api Key Authentication (cookie_auth): 1803 * Api Key Authentication (oidc_auth): 1804 * Api Key Authentication (saml_auth): 1805 * Bearer (JWT) Authentication (jwt_token): 1806 1807 ```python 1808 import time 1809 import os 1810 import lakefs_sdk 1811 from lakefs_sdk.models.stats_events_list import StatsEventsList 1812 from lakefs_sdk.rest import ApiException 1813 from pprint import pprint 1814 1815 # Defining the host is optional and defaults to /api/v1 1816 # See configuration.py for a list of all supported configuration parameters. 1817 configuration = lakefs_sdk.Configuration( 1818 host = "/api/v1" 1819 ) 1820 1821 # The client must configure the authentication and authorization parameters 1822 # in accordance with the API server security policy. 1823 # Examples for each auth method are provided below, use the example that 1824 # satisfies your auth use case. 1825 1826 # Configure HTTP basic authorization: basic_auth 1827 configuration = lakefs_sdk.Configuration( 1828 username = os.environ["USERNAME"], 1829 password = os.environ["PASSWORD"] 1830 ) 1831 1832 # Configure API key authorization: cookie_auth 1833 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1834 1835 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1836 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1837 1838 # Configure API key authorization: oidc_auth 1839 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1840 1841 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1842 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1843 1844 # Configure API key authorization: saml_auth 1845 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1846 1847 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1848 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1849 1850 # Configure Bearer authorization (JWT): jwt_token 1851 configuration = lakefs_sdk.Configuration( 1852 access_token = os.environ["BEARER_TOKEN"] 1853 ) 1854 1855 # Enter a context with an instance of the API client 1856 with lakefs_sdk.ApiClient(configuration) as api_client: 1857 # Create an instance of the API class 1858 api_instance = lakefs_sdk.InternalApi(api_client) 1859 stats_events_list = lakefs_sdk.StatsEventsList() # StatsEventsList | 1860 1861 try: 1862 # post stats events, this endpoint is meant for internal use only 1863 api_instance.post_stats_events(stats_events_list) 1864 except Exception as e: 1865 print("Exception when calling InternalApi->post_stats_events: %s\n" % e) 1866 ``` 1867 1868 1869 1870 ### Parameters 1871 1872 1873 Name | Type | Description | Notes 1874 ------------- | ------------- | ------------- | ------------- 1875 **stats_events_list** | [**StatsEventsList**](StatsEventsList.md)| | 1876 1877 ### Return type 1878 1879 void (empty response body) 1880 1881 ### Authorization 1882 1883 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1884 1885 ### HTTP request headers 1886 1887 - **Content-Type**: application/json 1888 - **Accept**: application/json 1889 1890 ### HTTP response details 1891 1892 | Status code | Description | Response headers | 1893 |-------------|-------------|------------------| 1894 **204** | reported successfully | - | 1895 **400** | Bad Request | - | 1896 **401** | Unauthorized | - | 1897 **420** | too many requests | - | 1898 **0** | Internal Server Error | - | 1899 1900 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 1901 1902 # **prepare_garbage_collection_commits** 1903 > GarbageCollectionPrepareResponse prepare_garbage_collection_commits(repository) 1904 1905 save lists of active commits for garbage collection 1906 1907 ### Example 1908 1909 * Basic Authentication (basic_auth): 1910 * Api Key Authentication (cookie_auth): 1911 * Api Key Authentication (oidc_auth): 1912 * Api Key Authentication (saml_auth): 1913 * Bearer (JWT) Authentication (jwt_token): 1914 1915 ```python 1916 import time 1917 import os 1918 import lakefs_sdk 1919 from lakefs_sdk.models.garbage_collection_prepare_response import GarbageCollectionPrepareResponse 1920 from lakefs_sdk.rest import ApiException 1921 from pprint import pprint 1922 1923 # Defining the host is optional and defaults to /api/v1 1924 # See configuration.py for a list of all supported configuration parameters. 1925 configuration = lakefs_sdk.Configuration( 1926 host = "/api/v1" 1927 ) 1928 1929 # The client must configure the authentication and authorization parameters 1930 # in accordance with the API server security policy. 1931 # Examples for each auth method are provided below, use the example that 1932 # satisfies your auth use case. 1933 1934 # Configure HTTP basic authorization: basic_auth 1935 configuration = lakefs_sdk.Configuration( 1936 username = os.environ["USERNAME"], 1937 password = os.environ["PASSWORD"] 1938 ) 1939 1940 # Configure API key authorization: cookie_auth 1941 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 1942 1943 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1944 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 1945 1946 # Configure API key authorization: oidc_auth 1947 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 1948 1949 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1950 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 1951 1952 # Configure API key authorization: saml_auth 1953 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 1954 1955 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 1956 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 1957 1958 # Configure Bearer authorization (JWT): jwt_token 1959 configuration = lakefs_sdk.Configuration( 1960 access_token = os.environ["BEARER_TOKEN"] 1961 ) 1962 1963 # Enter a context with an instance of the API client 1964 with lakefs_sdk.ApiClient(configuration) as api_client: 1965 # Create an instance of the API class 1966 api_instance = lakefs_sdk.InternalApi(api_client) 1967 repository = 'repository_example' # str | 1968 1969 try: 1970 # save lists of active commits for garbage collection 1971 api_response = api_instance.prepare_garbage_collection_commits(repository) 1972 print("The response of InternalApi->prepare_garbage_collection_commits:\n") 1973 pprint(api_response) 1974 except Exception as e: 1975 print("Exception when calling InternalApi->prepare_garbage_collection_commits: %s\n" % e) 1976 ``` 1977 1978 1979 1980 ### Parameters 1981 1982 1983 Name | Type | Description | Notes 1984 ------------- | ------------- | ------------- | ------------- 1985 **repository** | **str**| | 1986 1987 ### Return type 1988 1989 [**GarbageCollectionPrepareResponse**](GarbageCollectionPrepareResponse.md) 1990 1991 ### Authorization 1992 1993 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 1994 1995 ### HTTP request headers 1996 1997 - **Content-Type**: Not defined 1998 - **Accept**: application/json 1999 2000 ### HTTP response details 2001 2002 | Status code | Description | Response headers | 2003 |-------------|-------------|------------------| 2004 **201** | paths to commit dataset | - | 2005 **401** | Unauthorized | - | 2006 **403** | Forbidden | - | 2007 **404** | Resource Not Found | - | 2008 **420** | too many requests | - | 2009 **0** | Internal Server Error | - | 2010 2011 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2012 2013 # **prepare_garbage_collection_uncommitted** 2014 > PrepareGCUncommittedResponse prepare_garbage_collection_uncommitted(repository, prepare_gc_uncommitted_request=prepare_gc_uncommitted_request) 2015 2016 save repository uncommitted metadata for garbage collection 2017 2018 ### Example 2019 2020 * Basic Authentication (basic_auth): 2021 * Api Key Authentication (cookie_auth): 2022 * Api Key Authentication (oidc_auth): 2023 * Api Key Authentication (saml_auth): 2024 * Bearer (JWT) Authentication (jwt_token): 2025 2026 ```python 2027 import time 2028 import os 2029 import lakefs_sdk 2030 from lakefs_sdk.models.prepare_gc_uncommitted_request import PrepareGCUncommittedRequest 2031 from lakefs_sdk.models.prepare_gc_uncommitted_response import PrepareGCUncommittedResponse 2032 from lakefs_sdk.rest import ApiException 2033 from pprint import pprint 2034 2035 # Defining the host is optional and defaults to /api/v1 2036 # See configuration.py for a list of all supported configuration parameters. 2037 configuration = lakefs_sdk.Configuration( 2038 host = "/api/v1" 2039 ) 2040 2041 # The client must configure the authentication and authorization parameters 2042 # in accordance with the API server security policy. 2043 # Examples for each auth method are provided below, use the example that 2044 # satisfies your auth use case. 2045 2046 # Configure HTTP basic authorization: basic_auth 2047 configuration = lakefs_sdk.Configuration( 2048 username = os.environ["USERNAME"], 2049 password = os.environ["PASSWORD"] 2050 ) 2051 2052 # Configure API key authorization: cookie_auth 2053 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2054 2055 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2056 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2057 2058 # Configure API key authorization: oidc_auth 2059 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2060 2061 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2062 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2063 2064 # Configure API key authorization: saml_auth 2065 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2066 2067 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2068 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2069 2070 # Configure Bearer authorization (JWT): jwt_token 2071 configuration = lakefs_sdk.Configuration( 2072 access_token = os.environ["BEARER_TOKEN"] 2073 ) 2074 2075 # Enter a context with an instance of the API client 2076 with lakefs_sdk.ApiClient(configuration) as api_client: 2077 # Create an instance of the API class 2078 api_instance = lakefs_sdk.InternalApi(api_client) 2079 repository = 'repository_example' # str | 2080 prepare_gc_uncommitted_request = lakefs_sdk.PrepareGCUncommittedRequest() # PrepareGCUncommittedRequest | (optional) 2081 2082 try: 2083 # save repository uncommitted metadata for garbage collection 2084 api_response = api_instance.prepare_garbage_collection_uncommitted(repository, prepare_gc_uncommitted_request=prepare_gc_uncommitted_request) 2085 print("The response of InternalApi->prepare_garbage_collection_uncommitted:\n") 2086 pprint(api_response) 2087 except Exception as e: 2088 print("Exception when calling InternalApi->prepare_garbage_collection_uncommitted: %s\n" % e) 2089 ``` 2090 2091 2092 2093 ### Parameters 2094 2095 2096 Name | Type | Description | Notes 2097 ------------- | ------------- | ------------- | ------------- 2098 **repository** | **str**| | 2099 **prepare_gc_uncommitted_request** | [**PrepareGCUncommittedRequest**](PrepareGCUncommittedRequest.md)| | [optional] 2100 2101 ### Return type 2102 2103 [**PrepareGCUncommittedResponse**](PrepareGCUncommittedResponse.md) 2104 2105 ### Authorization 2106 2107 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2108 2109 ### HTTP request headers 2110 2111 - **Content-Type**: application/json 2112 - **Accept**: application/json 2113 2114 ### HTTP response details 2115 2116 | Status code | Description | Response headers | 2117 |-------------|-------------|------------------| 2118 **201** | paths to commit dataset | - | 2119 **400** | Validation Error | - | 2120 **401** | Unauthorized | - | 2121 **403** | Forbidden | - | 2122 **404** | Resource Not Found | - | 2123 **420** | too many requests | - | 2124 **0** | Internal Server Error | - | 2125 2126 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2127 2128 # **restore_refs** 2129 > restore_refs(repository, refs_restore) 2130 2131 Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations 2132 2133 ### Example 2134 2135 * Basic Authentication (basic_auth): 2136 * Api Key Authentication (cookie_auth): 2137 * Api Key Authentication (oidc_auth): 2138 * Api Key Authentication (saml_auth): 2139 * Bearer (JWT) Authentication (jwt_token): 2140 2141 ```python 2142 import time 2143 import os 2144 import lakefs_sdk 2145 from lakefs_sdk.models.refs_restore import RefsRestore 2146 from lakefs_sdk.rest import ApiException 2147 from pprint import pprint 2148 2149 # Defining the host is optional and defaults to /api/v1 2150 # See configuration.py for a list of all supported configuration parameters. 2151 configuration = lakefs_sdk.Configuration( 2152 host = "/api/v1" 2153 ) 2154 2155 # The client must configure the authentication and authorization parameters 2156 # in accordance with the API server security policy. 2157 # Examples for each auth method are provided below, use the example that 2158 # satisfies your auth use case. 2159 2160 # Configure HTTP basic authorization: basic_auth 2161 configuration = lakefs_sdk.Configuration( 2162 username = os.environ["USERNAME"], 2163 password = os.environ["PASSWORD"] 2164 ) 2165 2166 # Configure API key authorization: cookie_auth 2167 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2168 2169 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2170 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2171 2172 # Configure API key authorization: oidc_auth 2173 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2174 2175 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2176 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2177 2178 # Configure API key authorization: saml_auth 2179 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2180 2181 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2182 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2183 2184 # Configure Bearer authorization (JWT): jwt_token 2185 configuration = lakefs_sdk.Configuration( 2186 access_token = os.environ["BEARER_TOKEN"] 2187 ) 2188 2189 # Enter a context with an instance of the API client 2190 with lakefs_sdk.ApiClient(configuration) as api_client: 2191 # Create an instance of the API class 2192 api_instance = lakefs_sdk.InternalApi(api_client) 2193 repository = 'repository_example' # str | 2194 refs_restore = lakefs_sdk.RefsRestore() # RefsRestore | 2195 2196 try: 2197 # Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations 2198 api_instance.restore_refs(repository, refs_restore) 2199 except Exception as e: 2200 print("Exception when calling InternalApi->restore_refs: %s\n" % e) 2201 ``` 2202 2203 2204 2205 ### Parameters 2206 2207 2208 Name | Type | Description | Notes 2209 ------------- | ------------- | ------------- | ------------- 2210 **repository** | **str**| | 2211 **refs_restore** | [**RefsRestore**](RefsRestore.md)| | 2212 2213 ### Return type 2214 2215 void (empty response body) 2216 2217 ### Authorization 2218 2219 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2220 2221 ### HTTP request headers 2222 2223 - **Content-Type**: application/json 2224 - **Accept**: application/json 2225 2226 ### HTTP response details 2227 2228 | Status code | Description | Response headers | 2229 |-------------|-------------|------------------| 2230 **200** | refs successfully loaded | - | 2231 **400** | Validation Error | - | 2232 **401** | Unauthorized | - | 2233 **404** | Resource Not Found | - | 2234 **420** | too many requests | - | 2235 **0** | Internal Server Error | - | 2236 2237 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2238 2239 # **set_garbage_collection_rules_preflight** 2240 > set_garbage_collection_rules_preflight(repository) 2241 2242 2243 2244 ### Example 2245 2246 * Basic Authentication (basic_auth): 2247 * Api Key Authentication (cookie_auth): 2248 * Api Key Authentication (oidc_auth): 2249 * Api Key Authentication (saml_auth): 2250 * Bearer (JWT) Authentication (jwt_token): 2251 2252 ```python 2253 import time 2254 import os 2255 import lakefs_sdk 2256 from lakefs_sdk.rest import ApiException 2257 from pprint import pprint 2258 2259 # Defining the host is optional and defaults to /api/v1 2260 # See configuration.py for a list of all supported configuration parameters. 2261 configuration = lakefs_sdk.Configuration( 2262 host = "/api/v1" 2263 ) 2264 2265 # The client must configure the authentication and authorization parameters 2266 # in accordance with the API server security policy. 2267 # Examples for each auth method are provided below, use the example that 2268 # satisfies your auth use case. 2269 2270 # Configure HTTP basic authorization: basic_auth 2271 configuration = lakefs_sdk.Configuration( 2272 username = os.environ["USERNAME"], 2273 password = os.environ["PASSWORD"] 2274 ) 2275 2276 # Configure API key authorization: cookie_auth 2277 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2278 2279 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2280 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2281 2282 # Configure API key authorization: oidc_auth 2283 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2284 2285 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2286 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2287 2288 # Configure API key authorization: saml_auth 2289 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2290 2291 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2292 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2293 2294 # Configure Bearer authorization (JWT): jwt_token 2295 configuration = lakefs_sdk.Configuration( 2296 access_token = os.environ["BEARER_TOKEN"] 2297 ) 2298 2299 # Enter a context with an instance of the API client 2300 with lakefs_sdk.ApiClient(configuration) as api_client: 2301 # Create an instance of the API class 2302 api_instance = lakefs_sdk.InternalApi(api_client) 2303 repository = 'repository_example' # str | 2304 2305 try: 2306 api_instance.set_garbage_collection_rules_preflight(repository) 2307 except Exception as e: 2308 print("Exception when calling InternalApi->set_garbage_collection_rules_preflight: %s\n" % e) 2309 ``` 2310 2311 2312 2313 ### Parameters 2314 2315 2316 Name | Type | Description | Notes 2317 ------------- | ------------- | ------------- | ------------- 2318 **repository** | **str**| | 2319 2320 ### Return type 2321 2322 void (empty response body) 2323 2324 ### Authorization 2325 2326 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2327 2328 ### HTTP request headers 2329 2330 - **Content-Type**: Not defined 2331 - **Accept**: application/json 2332 2333 ### HTTP response details 2334 2335 | Status code | Description | Response headers | 2336 |-------------|-------------|------------------| 2337 **204** | User has permissions to set garbage collection rules on this repository | - | 2338 **401** | Unauthorized | - | 2339 **404** | Resource Not Found | - | 2340 **420** | too many requests | - | 2341 **0** | Internal Server Error | - | 2342 2343 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2344 2345 # **set_repository_metadata** 2346 > set_repository_metadata(repository, repository_metadata_set) 2347 2348 set repository metadata 2349 2350 Set repository metadata. This will only add or update the provided keys, and will not remove any existing keys. 2351 2352 ### Example 2353 2354 * Basic Authentication (basic_auth): 2355 * Api Key Authentication (cookie_auth): 2356 * Api Key Authentication (oidc_auth): 2357 * Api Key Authentication (saml_auth): 2358 * Bearer (JWT) Authentication (jwt_token): 2359 2360 ```python 2361 import time 2362 import os 2363 import lakefs_sdk 2364 from lakefs_sdk.models.repository_metadata_set import RepositoryMetadataSet 2365 from lakefs_sdk.rest import ApiException 2366 from pprint import pprint 2367 2368 # Defining the host is optional and defaults to /api/v1 2369 # See configuration.py for a list of all supported configuration parameters. 2370 configuration = lakefs_sdk.Configuration( 2371 host = "/api/v1" 2372 ) 2373 2374 # The client must configure the authentication and authorization parameters 2375 # in accordance with the API server security policy. 2376 # Examples for each auth method are provided below, use the example that 2377 # satisfies your auth use case. 2378 2379 # Configure HTTP basic authorization: basic_auth 2380 configuration = lakefs_sdk.Configuration( 2381 username = os.environ["USERNAME"], 2382 password = os.environ["PASSWORD"] 2383 ) 2384 2385 # Configure API key authorization: cookie_auth 2386 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2387 2388 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2389 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2390 2391 # Configure API key authorization: oidc_auth 2392 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2393 2394 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2395 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2396 2397 # Configure API key authorization: saml_auth 2398 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2399 2400 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2401 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2402 2403 # Configure Bearer authorization (JWT): jwt_token 2404 configuration = lakefs_sdk.Configuration( 2405 access_token = os.environ["BEARER_TOKEN"] 2406 ) 2407 2408 # Enter a context with an instance of the API client 2409 with lakefs_sdk.ApiClient(configuration) as api_client: 2410 # Create an instance of the API class 2411 api_instance = lakefs_sdk.InternalApi(api_client) 2412 repository = 'repository_example' # str | 2413 repository_metadata_set = lakefs_sdk.RepositoryMetadataSet() # RepositoryMetadataSet | 2414 2415 try: 2416 # set repository metadata 2417 api_instance.set_repository_metadata(repository, repository_metadata_set) 2418 except Exception as e: 2419 print("Exception when calling InternalApi->set_repository_metadata: %s\n" % e) 2420 ``` 2421 2422 2423 2424 ### Parameters 2425 2426 2427 Name | Type | Description | Notes 2428 ------------- | ------------- | ------------- | ------------- 2429 **repository** | **str**| | 2430 **repository_metadata_set** | [**RepositoryMetadataSet**](RepositoryMetadataSet.md)| | 2431 2432 ### Return type 2433 2434 void (empty response body) 2435 2436 ### Authorization 2437 2438 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2439 2440 ### HTTP request headers 2441 2442 - **Content-Type**: application/json 2443 - **Accept**: application/json 2444 2445 ### HTTP response details 2446 2447 | Status code | Description | Response headers | 2448 |-------------|-------------|------------------| 2449 **204** | repository metadata set successfully | - | 2450 **401** | Unauthorized | - | 2451 **404** | Resource Not Found | - | 2452 **420** | too many requests | - | 2453 **0** | Internal Server Error | - | 2454 2455 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2456 2457 # **setup** 2458 > CredentialsWithSecret setup(setup) 2459 2460 setup lakeFS and create a first user 2461 2462 ### Example 2463 2464 2465 ```python 2466 import time 2467 import os 2468 import lakefs_sdk 2469 from lakefs_sdk.models.credentials_with_secret import CredentialsWithSecret 2470 from lakefs_sdk.models.setup import Setup 2471 from lakefs_sdk.rest import ApiException 2472 from pprint import pprint 2473 2474 # Defining the host is optional and defaults to /api/v1 2475 # See configuration.py for a list of all supported configuration parameters. 2476 configuration = lakefs_sdk.Configuration( 2477 host = "/api/v1" 2478 ) 2479 2480 2481 # Enter a context with an instance of the API client 2482 with lakefs_sdk.ApiClient(configuration) as api_client: 2483 # Create an instance of the API class 2484 api_instance = lakefs_sdk.InternalApi(api_client) 2485 setup = lakefs_sdk.Setup() # Setup | 2486 2487 try: 2488 # setup lakeFS and create a first user 2489 api_response = api_instance.setup(setup) 2490 print("The response of InternalApi->setup:\n") 2491 pprint(api_response) 2492 except Exception as e: 2493 print("Exception when calling InternalApi->setup: %s\n" % e) 2494 ``` 2495 2496 2497 2498 ### Parameters 2499 2500 2501 Name | Type | Description | Notes 2502 ------------- | ------------- | ------------- | ------------- 2503 **setup** | [**Setup**](Setup.md)| | 2504 2505 ### Return type 2506 2507 [**CredentialsWithSecret**](CredentialsWithSecret.md) 2508 2509 ### Authorization 2510 2511 No authorization required 2512 2513 ### HTTP request headers 2514 2515 - **Content-Type**: application/json 2516 - **Accept**: application/json 2517 2518 ### HTTP response details 2519 2520 | Status code | Description | Response headers | 2521 |-------------|-------------|------------------| 2522 **200** | user created successfully | - | 2523 **400** | Bad Request | - | 2524 **409** | setup was already called | - | 2525 **420** | too many requests | - | 2526 **0** | Internal Server Error | - | 2527 2528 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2529 2530 # **setup_comm_prefs** 2531 > setup_comm_prefs(comm_prefs_input) 2532 2533 setup communications preferences 2534 2535 ### Example 2536 2537 2538 ```python 2539 import time 2540 import os 2541 import lakefs_sdk 2542 from lakefs_sdk.models.comm_prefs_input import CommPrefsInput 2543 from lakefs_sdk.rest import ApiException 2544 from pprint import pprint 2545 2546 # Defining the host is optional and defaults to /api/v1 2547 # See configuration.py for a list of all supported configuration parameters. 2548 configuration = lakefs_sdk.Configuration( 2549 host = "/api/v1" 2550 ) 2551 2552 2553 # Enter a context with an instance of the API client 2554 with lakefs_sdk.ApiClient(configuration) as api_client: 2555 # Create an instance of the API class 2556 api_instance = lakefs_sdk.InternalApi(api_client) 2557 comm_prefs_input = lakefs_sdk.CommPrefsInput() # CommPrefsInput | 2558 2559 try: 2560 # setup communications preferences 2561 api_instance.setup_comm_prefs(comm_prefs_input) 2562 except Exception as e: 2563 print("Exception when calling InternalApi->setup_comm_prefs: %s\n" % e) 2564 ``` 2565 2566 2567 2568 ### Parameters 2569 2570 2571 Name | Type | Description | Notes 2572 ------------- | ------------- | ------------- | ------------- 2573 **comm_prefs_input** | [**CommPrefsInput**](CommPrefsInput.md)| | 2574 2575 ### Return type 2576 2577 void (empty response body) 2578 2579 ### Authorization 2580 2581 No authorization required 2582 2583 ### HTTP request headers 2584 2585 - **Content-Type**: application/json 2586 - **Accept**: application/json 2587 2588 ### HTTP response details 2589 2590 | Status code | Description | Response headers | 2591 |-------------|-------------|------------------| 2592 **200** | communication preferences saved successfully | - | 2593 **409** | setup was already completed | - | 2594 **412** | wrong setup state for this operation | - | 2595 **420** | too many requests | - | 2596 **0** | Internal Server Error | - | 2597 2598 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2599 2600 # **stage_object** 2601 > ObjectStats stage_object(repository, branch, path, object_stage_creation) 2602 2603 stage an object's metadata for the given branch 2604 2605 ### Example 2606 2607 * Basic Authentication (basic_auth): 2608 * Api Key Authentication (cookie_auth): 2609 * Api Key Authentication (oidc_auth): 2610 * Api Key Authentication (saml_auth): 2611 * Bearer (JWT) Authentication (jwt_token): 2612 2613 ```python 2614 import time 2615 import os 2616 import lakefs_sdk 2617 from lakefs_sdk.models.object_stage_creation import ObjectStageCreation 2618 from lakefs_sdk.models.object_stats import ObjectStats 2619 from lakefs_sdk.rest import ApiException 2620 from pprint import pprint 2621 2622 # Defining the host is optional and defaults to /api/v1 2623 # See configuration.py for a list of all supported configuration parameters. 2624 configuration = lakefs_sdk.Configuration( 2625 host = "/api/v1" 2626 ) 2627 2628 # The client must configure the authentication and authorization parameters 2629 # in accordance with the API server security policy. 2630 # Examples for each auth method are provided below, use the example that 2631 # satisfies your auth use case. 2632 2633 # Configure HTTP basic authorization: basic_auth 2634 configuration = lakefs_sdk.Configuration( 2635 username = os.environ["USERNAME"], 2636 password = os.environ["PASSWORD"] 2637 ) 2638 2639 # Configure API key authorization: cookie_auth 2640 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2641 2642 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2643 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2644 2645 # Configure API key authorization: oidc_auth 2646 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2647 2648 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2649 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2650 2651 # Configure API key authorization: saml_auth 2652 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2653 2654 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2655 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2656 2657 # Configure Bearer authorization (JWT): jwt_token 2658 configuration = lakefs_sdk.Configuration( 2659 access_token = os.environ["BEARER_TOKEN"] 2660 ) 2661 2662 # Enter a context with an instance of the API client 2663 with lakefs_sdk.ApiClient(configuration) as api_client: 2664 # Create an instance of the API class 2665 api_instance = lakefs_sdk.InternalApi(api_client) 2666 repository = 'repository_example' # str | 2667 branch = 'branch_example' # str | 2668 path = 'path_example' # str | relative to the branch 2669 object_stage_creation = lakefs_sdk.ObjectStageCreation() # ObjectStageCreation | 2670 2671 try: 2672 # stage an object's metadata for the given branch 2673 api_response = api_instance.stage_object(repository, branch, path, object_stage_creation) 2674 print("The response of InternalApi->stage_object:\n") 2675 pprint(api_response) 2676 except Exception as e: 2677 print("Exception when calling InternalApi->stage_object: %s\n" % e) 2678 ``` 2679 2680 2681 2682 ### Parameters 2683 2684 2685 Name | Type | Description | Notes 2686 ------------- | ------------- | ------------- | ------------- 2687 **repository** | **str**| | 2688 **branch** | **str**| | 2689 **path** | **str**| relative to the branch | 2690 **object_stage_creation** | [**ObjectStageCreation**](ObjectStageCreation.md)| | 2691 2692 ### Return type 2693 2694 [**ObjectStats**](ObjectStats.md) 2695 2696 ### Authorization 2697 2698 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2699 2700 ### HTTP request headers 2701 2702 - **Content-Type**: application/json 2703 - **Accept**: application/json 2704 2705 ### HTTP response details 2706 2707 | Status code | Description | Response headers | 2708 |-------------|-------------|------------------| 2709 **201** | object metadata | - | 2710 **400** | Validation Error | - | 2711 **401** | Unauthorized | - | 2712 **403** | Forbidden | - | 2713 **404** | Resource Not Found | - | 2714 **420** | too many requests | - | 2715 **0** | Internal Server Error | - | 2716 2717 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2718 2719 # **upload_object_preflight** 2720 > upload_object_preflight(repository, branch, path) 2721 2722 2723 2724 ### Example 2725 2726 * Basic Authentication (basic_auth): 2727 * Api Key Authentication (cookie_auth): 2728 * Api Key Authentication (oidc_auth): 2729 * Api Key Authentication (saml_auth): 2730 * Bearer (JWT) Authentication (jwt_token): 2731 2732 ```python 2733 import time 2734 import os 2735 import lakefs_sdk 2736 from lakefs_sdk.rest import ApiException 2737 from pprint import pprint 2738 2739 # Defining the host is optional and defaults to /api/v1 2740 # See configuration.py for a list of all supported configuration parameters. 2741 configuration = lakefs_sdk.Configuration( 2742 host = "/api/v1" 2743 ) 2744 2745 # The client must configure the authentication and authorization parameters 2746 # in accordance with the API server security policy. 2747 # Examples for each auth method are provided below, use the example that 2748 # satisfies your auth use case. 2749 2750 # Configure HTTP basic authorization: basic_auth 2751 configuration = lakefs_sdk.Configuration( 2752 username = os.environ["USERNAME"], 2753 password = os.environ["PASSWORD"] 2754 ) 2755 2756 # Configure API key authorization: cookie_auth 2757 configuration.api_key['cookie_auth'] = os.environ["API_KEY"] 2758 2759 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2760 # configuration.api_key_prefix['cookie_auth'] = 'Bearer' 2761 2762 # Configure API key authorization: oidc_auth 2763 configuration.api_key['oidc_auth'] = os.environ["API_KEY"] 2764 2765 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2766 # configuration.api_key_prefix['oidc_auth'] = 'Bearer' 2767 2768 # Configure API key authorization: saml_auth 2769 configuration.api_key['saml_auth'] = os.environ["API_KEY"] 2770 2771 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed 2772 # configuration.api_key_prefix['saml_auth'] = 'Bearer' 2773 2774 # Configure Bearer authorization (JWT): jwt_token 2775 configuration = lakefs_sdk.Configuration( 2776 access_token = os.environ["BEARER_TOKEN"] 2777 ) 2778 2779 # Enter a context with an instance of the API client 2780 with lakefs_sdk.ApiClient(configuration) as api_client: 2781 # Create an instance of the API class 2782 api_instance = lakefs_sdk.InternalApi(api_client) 2783 repository = 'repository_example' # str | 2784 branch = 'branch_example' # str | 2785 path = 'path_example' # str | relative to the branch 2786 2787 try: 2788 api_instance.upload_object_preflight(repository, branch, path) 2789 except Exception as e: 2790 print("Exception when calling InternalApi->upload_object_preflight: %s\n" % e) 2791 ``` 2792 2793 2794 2795 ### Parameters 2796 2797 2798 Name | Type | Description | Notes 2799 ------------- | ------------- | ------------- | ------------- 2800 **repository** | **str**| | 2801 **branch** | **str**| | 2802 **path** | **str**| relative to the branch | 2803 2804 ### Return type 2805 2806 void (empty response body) 2807 2808 ### Authorization 2809 2810 [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token) 2811 2812 ### HTTP request headers 2813 2814 - **Content-Type**: Not defined 2815 - **Accept**: application/json 2816 2817 ### HTTP response details 2818 2819 | Status code | Description | Response headers | 2820 |-------------|-------------|------------------| 2821 **204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | 2822 **401** | Unauthorized | - | 2823 **403** | Forbidden | - | 2824 **404** | Resource Not Found | - | 2825 **420** | too many requests | - | 2826 **0** | Internal Server Error | - | 2827 2828 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 2829