ct-python

ConfigTree API definitions

This Python package is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.3
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

It's recommended to install the SDK from PyPI useing:

pip install ct-python

You can also install it directly from Github

pip install git+https://github.com/configtree/ct-python-sdk

(you may need to run pip with root permission: sudo pip install git+https://github.com/configtree/ct-python-sdk)

Then import the package:

import ct_python 

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 ct_python

Getting Started

Please follow the installation procedure and then you can use the SDK. A sample usage:

from __future__ import print_function
import time
import ct_python
from ct_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Application() # Application | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.create_application(body, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->create_application: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Configuration() # Configuration | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.create_configuration(body, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->create_configuration: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Environment() # Environment | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.create_environment(body, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->create_environment: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Version() # Version | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.create_version(body, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->create_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_instance.delete_application(id, organization_slug)
except ApiException as e:
    print("Exception when calling CTApi->delete_application: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_instance.delete_configuration(id, organization_slug)
except ApiException as e:
    print("Exception when calling CTApi->delete_configuration: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_instance.delete_environment(id, organization_slug)
except ApiException as e:
    print("Exception when calling CTApi->delete_environment: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_instance.delete_version(id, organization_slug)
except ApiException as e:
    print("Exception when calling CTApi->delete_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Version() # Version | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.duplicate_version(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->duplicate_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_all_applications(organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_all_applications: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_application_by_id(id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_application_by_id: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_configuration_by_id(id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_configuration_by_id: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_environment_by_id(id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_environment_by_id: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_environment_live_version(id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_environment_live_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
organization_slug = 'organization_slug_example' # str | The name in all lowercase, suitable for URL identification

try:
    api_response = api_instance.get_organization_by_slug(organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_organization_by_slug: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
organization_slug = 'organization_slug_example' # str | 
application_name = 'application_name_example' # str | Application Name (optional)
environment_name = 'environment_name_example' # str | Environment Name (optional)
version_name = 'version_name_example' # str | Version Name (optional)

try:
    api_response = api_instance.get_version(organization_slug, application_name=application_name, environment_name=environment_name, version_name=version_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.get_version_by_id(id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->get_version_by_id: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.CustomTokenObtainPair() # CustomTokenObtainPair | 

try:
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->login: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Application() # Application | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.partial_update_application(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->partial_update_application: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Configuration() # Configuration | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.partial_update_configuration(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->partial_update_configuration: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Environment() # Environment | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.partial_update_environment(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->partial_update_environment: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Version() # Version | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.partial_update_version(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->partial_update_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.TokenRefresh() # TokenRefresh | 

try:
    api_response = api_instance.refresh_token(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->refresh_token: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Application() # Application | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.update_application(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->update_application: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Configuration() # Configuration | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.update_configuration(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->update_configuration: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Environment() # Environment | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.update_environment(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->update_environment: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
body = ct_python.Version() # Version | 
id = 'id_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.update_version(body, id, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->update_version: %s\n" % e)

# Configure API key authorization: Bearer
configuration = ct_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'

configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ct_python.CTApi(ct_python.ApiClient(configuration))
file = 'file_example' # file | 
ext = 'ext_example' # str | 
organization_slug = 'organization_slug_example' # str | 

try:
    api_response = api_instance.upload_configuration_file(file, ext, organization_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CTApi->upload_configuration_file: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.configtree.co/

Documentation For Models

• Application
• Configuration
• ConfigurationFile
• CustomTokenObtainPair
• CustomTokenObtainPairResponse
• Environment
• Organization
• OrganizationGroup
• TokenRefresh
• TokenUserResponse
• Version

Documentation For Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author