Skip to content

lakefs_enterprise_sdk.BranchesApi

All URIs are relative to /api/v1

Method HTTP request Description
cherry_pick POST /repositories/{repository}/branches/{branch}/cherry-pick Replay the changes from the given commit on the branch
create_branch POST /repositories/{repository}/branches create branch
delete_branch DELETE /repositories/{repository}/branches/{branch} delete branch
diff_branch GET /repositories/{repository}/branches/{branch}/diff diff branch
get_branch GET /repositories/{repository}/branches/{branch} get branch
list_branches GET /repositories/{repository}/branches list branches
reset_branch PUT /repositories/{repository}/branches/{branch} reset branch
revert_branch POST /repositories/{repository}/branches/{branch}/revert revert

cherry_pick

Commit cherry_pick(repository, branch, cherry_pick_creation)

Replay the changes from the given commit on the branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.cherry_pick_creation import CherryPickCreation
    from lakefs_enterprise_sdk.models.commit import Commit
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
        cherry_pick_creation = lakefs_enterprise_sdk.CherryPickCreation() # CherryPickCreation | 
    
        try:
            # Replay the changes from the given commit on the branch
            api_response = api_instance.cherry_pick(repository, branch, cherry_pick_creation)
            print("The response of BranchesApi->cherry_pick:\n")
            pprint(api_response)
        except Exception as e:
            print("Exception when calling BranchesApi->cherry_pick: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str
cherry_pick_creation CherryPickCreation

Return type

Commit

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 the cherry-pick commit -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
409 Conflict Found -
429 too many requests -
0 Internal Server Error -

create_branch

str create_branch(repository, branch_creation)

create branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.branch_creation import BranchCreation
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch_creation = lakefs_enterprise_sdk.BranchCreation() # BranchCreation | 
    
        try:
            # create branch
            api_response = api_instance.create_branch(repository, branch_creation)
            print("The response of BranchesApi->create_branch:\n")
            pprint(api_response)
        except Exception as e:
            print("Exception when calling BranchesApi->create_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch_creation BranchCreation

Return type

str

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: application/json
  • Accept: text/html, application/json

HTTP response details

Status code Description Response headers
201 reference -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
409 Resource Conflicts With Target -
429 too many requests -
0 Internal Server Error -

delete_branch

delete_branch(repository, branch, force=force)

delete branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
        force = False # bool |  (optional) (default to False)
    
        try:
            # delete branch
            api_instance.delete_branch(repository, branch, force=force)
        except Exception as e:
            print("Exception when calling BranchesApi->delete_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str
force bool [optional] [default to False]

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 branch deleted successfully -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
429 too many requests -
0 Internal Server Error -

diff_branch

DiffList diff_branch(repository, branch, after=after, amount=amount, prefix=prefix, delimiter=delimiter)

diff branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.diff_list import DiffList
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
        after = 'after_example' # str | return items after this value (optional)
        amount = 100 # int | how many items to return (optional) (default to 100)
        prefix = 'prefix_example' # str | return items prefixed with this value (optional)
        delimiter = 'delimiter_example' # str | delimiter used to group common prefixes by (optional)
    
        try:
            # diff branch
            api_response = api_instance.diff_branch(repository, branch, after=after, amount=amount, prefix=prefix, delimiter=delimiter)
            print("The response of BranchesApi->diff_branch:\n")
            pprint(api_response)
        except Exception as e:
            print("Exception when calling BranchesApi->diff_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str
after str return items after this value [optional]
amount int how many items to return [optional] [default to 100]
prefix str return items prefixed with this value [optional]
delimiter str delimiter used to group common prefixes by [optional]

Return type

DiffList

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 diff of branch uncommitted changes -
400 Bad Request -
401 Unauthorized -
404 Resource Not Found -
429 too many requests -
0 Internal Server Error -

get_branch

Ref get_branch(repository, branch)

get branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.ref import Ref
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
    
        try:
            # get branch
            api_response = api_instance.get_branch(repository, branch)
            print("The response of BranchesApi->get_branch:\n")
            pprint(api_response)
        except Exception as e:
            print("Exception when calling BranchesApi->get_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str

Return type

Ref

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 branch -
400 Bad Request -
401 Unauthorized -
404 Resource Not Found -
429 too many requests -
0 Internal Server Error -

list_branches

RefList list_branches(repository, prefix=prefix, after=after, amount=amount, show_hidden=show_hidden)

list branches

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.ref_list import RefList
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        prefix = 'prefix_example' # str | return items prefixed with this value (optional)
        after = 'after_example' # str | return items after this value (optional)
        amount = 100 # int | how many items to return (optional) (default to 100)
        show_hidden = False # bool |  (optional) (default to False)
    
        try:
            # list branches
            api_response = api_instance.list_branches(repository, prefix=prefix, after=after, amount=amount, show_hidden=show_hidden)
            print("The response of BranchesApi->list_branches:\n")
            pprint(api_response)
        except Exception as e:
            print("Exception when calling BranchesApi->list_branches: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
prefix str return items prefixed with this value [optional]
after str return items after this value [optional]
amount int how many items to return [optional] [default to 100]
show_hidden bool [optional] [default to False]

Return type

RefList

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 branch list -
400 Bad Request -
401 Unauthorized -
404 Resource Not Found -
429 too many requests -
0 Internal Server Error -

reset_branch

reset_branch(repository, branch, reset_creation)

reset branch

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.reset_creation import ResetCreation
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
        reset_creation = lakefs_enterprise_sdk.ResetCreation() # ResetCreation | 
    
        try:
            # reset branch
            api_instance.reset_branch(repository, branch, reset_creation)
        except Exception as e:
            print("Exception when calling BranchesApi->reset_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str
reset_creation ResetCreation

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 reset successful -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
429 too many requests -
0 Internal Server Error -

revert_branch

revert_branch(repository, branch, revert_creation)

revert

Example

  • Basic Authentication (basic_auth):
  • Api Key Authentication (cookie_auth):
  • Api Key Authentication (oidc_auth):
  • Api Key Authentication (saml_auth):
  • Bearer (JWT) Authentication (jwt_token):
    import time
    import os
    import lakefs_enterprise_sdk
    from lakefs_enterprise_sdk.models.revert_creation import RevertCreation
    from lakefs_enterprise_sdk.rest import ApiException
    from pprint import pprint
    
    # Defining the host is optional and defaults to /api/v1
    # See configuration.py for a list of all supported configuration parameters.
    configuration = lakefs_enterprise_sdk.Configuration(
        host = "/api/v1"
    )
    
    # The client must configure the authentication and authorization parameters
    # in accordance with the API server security policy.
    # Examples for each auth method are provided below, use the example that
    # satisfies your auth use case.
    
    # Configure HTTP basic authorization: basic_auth
    configuration = lakefs_enterprise_sdk.Configuration(
        username = os.environ["USERNAME"],
        password = os.environ["PASSWORD"]
    )
    
    # Configure API key authorization: cookie_auth
    configuration.api_key['cookie_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['cookie_auth'] = 'Bearer'
    
    # Configure API key authorization: oidc_auth
    configuration.api_key['oidc_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['oidc_auth'] = 'Bearer'
    
    # Configure API key authorization: saml_auth
    configuration.api_key['saml_auth'] = os.environ["API_KEY"]
    
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # configuration.api_key_prefix['saml_auth'] = 'Bearer'
    
    # Configure Bearer authorization (JWT): jwt_token
    configuration = lakefs_enterprise_sdk.Configuration(
        access_token = os.environ["BEARER_TOKEN"]
    )
    
    # Enter a context with an instance of the API client
    with lakefs_enterprise_sdk.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        api_instance = lakefs_enterprise_sdk.BranchesApi(api_client)
        repository = 'repository_example' # str | 
        branch = 'branch_example' # str | 
        revert_creation = lakefs_enterprise_sdk.RevertCreation() # RevertCreation | 
    
        try:
            # revert
            api_instance.revert_branch(repository, branch, revert_creation)
        except Exception as e:
            print("Exception when calling BranchesApi->revert_branch: %s\n" % e)
    

Parameters

Name Type Description Notes
repository str
branch str
revert_creation RevertCreation

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 revert successful -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
409 Conflict Found -
429 too many requests -
0 Internal Server Error -