vrt-lss-registry 7.29.3120

VRt.Registry [RG]

vrt_lss_registry

Program interface for Veeroute Registry.

Description

The service is designed to store settings.

Entity diagram

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.29.3120
• Package version: 7.29.3120
• 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:

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:

import vrt_lss_registry

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vrt_lss_registry

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

• Attribute
• CheckResult
• Configuration
• FileNamePath
• FileSpecification
• Filesystem
• FilesystemColumnType
• FilesystemCounters
• FilesystemPath
• Folder
• FolderCounters
• FolderSpecification
• FolderType
• General400
• General402
• General403
• General404
• General404Detail
• General429
• General500
• SchemaError
• Service
• TableConfiguration
• TableConfigurationColumnType
• TableConfigurationList
• TableListCounters
• TableListCountersDetail
• Tracedata
• VersionResult

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: Bearer authentication (JWT)

Author

[e-mail]