Proton / Client / get_template_sync_config

get_template_sync_config#

Proton.Client.get_template_sync_config(**kwargs)#

Get detail data for a template sync configuration.

Request Syntax

response = client.get_template_sync_config(
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)

Parameters:

templateName (string) –
[REQUIRED]

The template name.
templateType (string) –
[REQUIRED]

The template type.

Return type:

dict

Returns:

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

(dict) –
- templateSyncConfig (dict) –
  
  The template sync configuration detail data that’s returned by Proton.
  - branch (string) –
    
    The repository branch.
  - repositoryName (string) –
    
    The repository name (for example, myrepos/myrepo).
  - repositoryProvider (string) –
    
    The repository provider.
  - subdirectory (string) –
    
    A subdirectory path to your template bundle version.
  - templateName (string) –
    
    The template name.
  - templateType (string) –
    
    The template type.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException