Metadata-Version: 2.2
Name: vrt_lss_registry
Version: 7.36.3317
Summary: VRt.Registry [RG]
Home-page: 
Author: Veeroute Support Team
Author-email: Veeroute Support Team <support@veeroute.com>
License: Proprietary
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,VRt.Registry [RG]
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# vrt_lss_registry
Programming interface for Veeroute Registry.

# Description

The service is designed to manage configuration files.

## Entity diagram

![erd](../uml/registry.svg)


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

- API version: 7.36.3317
- Package version: 7.36.3317
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

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

Then import the package:
```python
import vrt_lss_registry
```

### Setuptools

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

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

Then import the package:
```python
import vrt_lss_registry
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import vrt_lss_registry
from vrt_lss_registry.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_registry.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# 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 Bearer authorization (JWT): ApiKeyAuth
configuration = vrt_lss_registry.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_registry.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_registry.BackupsApi(api_client)
    target_folder_key = 'target_folder_key_example' # str | Folder key, unique identifier.

    try:
        # Folder export
        api_response = api_instance.create_backup(target_folder_key)
        print("The response of BackupsApi->create_backup:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->create_backup: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.edge7.veeroute.cloud*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BackupsApi* | [**create_backup**](docs/BackupsApi.md#create_backup) | **POST** /registry/backups/{target_folder_key} | Folder export
*BackupsApi* | [**restore_backup**](docs/BackupsApi.md#restore_backup) | **PUT** /registry/backups/{target_folder_key} | Folder import
*ConfigurationsApi* | [**create_configuration**](docs/ConfigurationsApi.md#create_configuration) | **POST** /registry/configurations | Create configuration
*ConfigurationsApi* | [**delete_configuration**](docs/ConfigurationsApi.md#delete_configuration) | **DELETE** /registry/configurations/{file_key} | Configuration removal
*ConfigurationsApi* | [**duplicate_configuration**](docs/ConfigurationsApi.md#duplicate_configuration) | **POST** /registry/configurations/{file_key}/actions/duplicate | Configuration duplicate
*ConfigurationsApi* | [**read_configuration**](docs/ConfigurationsApi.md#read_configuration) | **GET** /registry/configurations/{file_key} | Reading configuration
*ConfigurationsApi* | [**read_configuration_content**](docs/ConfigurationsApi.md#read_configuration_content) | **GET** /registry/configurations/{file_key}/content | Content read
*ConfigurationsApi* | [**read_configuration_schema**](docs/ConfigurationsApi.md#read_configuration_schema) | **GET** /registry/configurations/{file_key}/schema | Schema read
*ConfigurationsApi* | [**read_configurations_table**](docs/ConfigurationsApi.md#read_configurations_table) | **GET** /registry/configurations/batch/table | Configurations list (table)
*ConfigurationsApi* | [**search_configurations**](docs/ConfigurationsApi.md#search_configurations) | **GET** /registry/configurations/batch/search | Configuration search
*ConfigurationsApi* | [**update_configuration_content**](docs/ConfigurationsApi.md#update_configuration_content) | **PUT** /registry/configurations/{file_key}/content | Content update
*ConfigurationsApi* | [**update_configuration_schema**](docs/ConfigurationsApi.md#update_configuration_schema) | **PUT** /registry/configurations/{file_key}/schema | Schema update
*ConfigurationsApi* | [**update_configuration_specification**](docs/ConfigurationsApi.md#update_configuration_specification) | **PUT** /registry/configurations/{file_key} | Specification update
*ExplorerApi* | [**create_folder**](docs/ExplorerApi.md#create_folder) | **POST** /registry/explorer | Create folder
*ExplorerApi* | [**create_folders_batch**](docs/ExplorerApi.md#create_folders_batch) | **POST** /registry/explorer/batch/folders | Create folders (batch)
*ExplorerApi* | [**delete_files_batch**](docs/ExplorerApi.md#delete_files_batch) | **DELETE** /registry/explorer/batch/files | Files removal (batch)
*ExplorerApi* | [**delete_folder**](docs/ExplorerApi.md#delete_folder) | **DELETE** /registry/explorer/{target_folder_key} | Folder removal
*ExplorerApi* | [**delete_folders_batch**](docs/ExplorerApi.md#delete_folders_batch) | **DELETE** /registry/explorer/batch/folders | Folders removal (batch)
*ExplorerApi* | [**read_file_key**](docs/ExplorerApi.md#read_file_key) | **GET** /registry/explorer/batch/files | File key
*ExplorerApi* | [**read_filesystem**](docs/ExplorerApi.md#read_filesystem) | **GET** /registry/explorer | Getting a filesystem
*ExplorerApi* | [**read_filesystem_counters**](docs/ExplorerApi.md#read_filesystem_counters) | **GET** /registry/explorer/batch/counters | Filesystem counters
*ExplorerApi* | [**read_folder_key**](docs/ExplorerApi.md#read_folder_key) | **POST** /registry/explorer/batch/folder-key | Folder key
*ExplorerApi* | [**read_folder_path**](docs/ExplorerApi.md#read_folder_path) | **GET** /registry/explorer/{target_folder_key}/path | Folder path
*ExplorerApi* | [**read_folder_specification**](docs/ExplorerApi.md#read_folder_specification) | **GET** /registry/explorer/{target_folder_key}/specification | Folder specification
*ExplorerApi* | [**update_folder**](docs/ExplorerApi.md#update_folder) | **PUT** /registry/explorer/{target_folder_key} | Update folder
*SystemApi* | [**check**](docs/SystemApi.md#check) | **GET** /registry/system/check | Checking the availability
*SystemApi* | [**file**](docs/SystemApi.md#file) | **GET** /registry/file/{filename} | Getting the documentation
*SystemApi* | [**version**](docs/SystemApi.md#version) | **GET** /registry/system/version | Getting the service version


## Documentation For Models

 - [Attribute](docs/Attribute.md)
 - [CheckResult](docs/CheckResult.md)
 - [Configuration](docs/Configuration.md)
 - [FileNamePath](docs/FileNamePath.md)
 - [FileSpecification](docs/FileSpecification.md)
 - [Filesystem](docs/Filesystem.md)
 - [FilesystemColumnType](docs/FilesystemColumnType.md)
 - [FilesystemCounters](docs/FilesystemCounters.md)
 - [FilesystemPath](docs/FilesystemPath.md)
 - [Folder](docs/Folder.md)
 - [FolderCounters](docs/FolderCounters.md)
 - [FolderSpecification](docs/FolderSpecification.md)
 - [FolderType](docs/FolderType.md)
 - [General400](docs/General400.md)
 - [General402](docs/General402.md)
 - [General403](docs/General403.md)
 - [General404](docs/General404.md)
 - [General404Detail](docs/General404Detail.md)
 - [General429](docs/General429.md)
 - [General500](docs/General500.md)
 - [SchemaError](docs/SchemaError.md)
 - [Service](docs/Service.md)
 - [TableConfiguration](docs/TableConfiguration.md)
 - [TableConfigurationColumnType](docs/TableConfigurationColumnType.md)
 - [TableConfigurationList](docs/TableConfigurationList.md)
 - [TableListCounters](docs/TableListCounters.md)
 - [TableListCountersDetail](docs/TableListCountersDetail.md)
 - [Tracedata](docs/Tracedata.md)
 - [VersionResult](docs/VersionResult.md)


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


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

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


## Author

support@veeroute.com


