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/
| Method | HTTP request | Description |
|---|---|---|
| create_application | POST /v1/{organizationSlug}/applications/ | |
| create_configuration | POST /v1/{organizationSlug}/configurations/ | |
| create_environment | POST /v1/{organizationSlug}/environments/ | |
| create_version | POST /v1/{organizationSlug}/versions/ | |
| delete_application | DELETE /v1/{organizationSlug}/applications/{id}/ | |
| delete_configuration | DELETE /v1/{organizationSlug}/configurations/{id}/ | |
| delete_environment | DELETE /v1/{organizationSlug}/environments/{id}/ | |
| delete_version | DELETE /v1/{organizationSlug}/versions/{id}/ | |
| duplicate_version | POST /v1/{organizationSlug}/versions/{id}/duplicate/ | |
| get_all_applications | GET /v1/{organizationSlug}/applications/ | |
| get_application_by_id | GET /v1/{organizationSlug}/applications/{id}/ | |
| get_configuration_by_id | GET /v1/{organizationSlug}/configurations/{id}/ | |
| get_environment_by_id | GET /v1/{organizationSlug}/environments/{id}/ | |
| get_environment_live_version | GET /v1/{organizationSlug}/environments/{id}/liveVersion/ | |
| get_organization_by_slug | GET /v1/{organizationSlug}/ | |
| get_version | GET /v1/{organizationSlug}/versions/ | |
| get_version_by_id | GET /v1/{organizationSlug}/versions/{id}/ | |
| login | POST /v1/login/ | |
| partial_update_application | PATCH /v1/{organizationSlug}/applications/{id}/ | |
| partial_update_configuration | PATCH /v1/{organizationSlug}/configurations/{id}/ | |
| partial_update_environment | PATCH /v1/{organizationSlug}/environments/{id}/ | |
| partial_update_version | PATCH /v1/{organizationSlug}/versions/{id}/ | |
| refresh_token | POST /v1/login/refresh/ | |
| update_application | PUT /v1/{organizationSlug}/applications/{id}/ | |
| update_configuration | PUT /v1/{organizationSlug}/configurations/{id}/ | |
| update_environment | PUT /v1/{organizationSlug}/environments/{id}/ | |
| update_version | PUT /v1/{organizationSlug}/versions/{id}/ | |
| upload_configuration_file | POST /v1/{organizationSlug}/configurations/upload_config/ |
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
Metadata
Release files for ct-python 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ct-python-1.0.3.tar.gz | 26.6 kB | Without provenance | Details for ct-python-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ct_python-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for ct_python-1.0.3-py3-none-any.whl |
Total release size: 69.2 kB
Release files / ct-python-1.0.3.tar.gz
| Download URL | ct-python-1.0.3.tar.gz |
|---|---|
| Size | 26.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ba6e7e1ef4a96acb5a003555ab46d7ec28f11c4ee27af11e6d42fc27e4535c42
|
|
BLAKE2b-256 checksum How to use checksums |
9afedf30b7df611932f3e0b9fcb4890cadfe990f81125abfd006272cc19e0e17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.2
|
Release files / ct_python-1.0.3-py3-none-any.whl
| Download URL | ct_python-1.0.3-py3-none-any.whl |
|---|---|
| Size | 42.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c4bf34fc49c4cf41cde76ebf0352fabe588563ff60a07e48f2d96ceec73d3f1a
|
|
BLAKE2b-256 checksum How to use checksums |
1dfe85e936f2c0c3569e38157a7ef824d5e08fe0ea3d0a81c25f67c701c470c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.2
|
Security for ct-python 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.