Skip to content

Latest commit

 

History

History
349 lines (304 loc) · 22.9 KB

API.md

File metadata and controls

349 lines (304 loc) · 22.9 KB

kowabunga

Kvm Orchestrator With A BUNch of Goods Added

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

  • API version: 0.53.2
  • Package version: 0.53.2
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.kowabunga.cloud/

Requirements.

Python 3.8+

Installation & Usage

pip install

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

pip install git+https://github.com/kowabunga-cloud/kowabunga-python.git

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

Then import the package:

import kowabunga

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 kowabunga

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AdapterApi(api_client)
    adapter_id = 'adapter_id_example' # str | The ID of the network adapter.

    try:
        api_instance.delete_adapter(adapter_id)
    except ApiException as e:
        print("Exception when calling AdapterApi->delete_adapter: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://your_kowabunga_kahuna_server/api/v1

Class Method HTTP request Description
AdapterApi delete_adapter DELETE /adapter/{adapterId}
AdapterApi list_adapters GET /adapter
AdapterApi read_adapter GET /adapter/{adapterId}
AdapterApi update_adapter PUT /adapter/{adapterId}
AgentApi create_agent POST /agent
AgentApi delete_agent DELETE /agent/{agentId}
AgentApi list_agents GET /agent
AgentApi read_agent GET /agent/{agentId}
AgentApi set_agent_api_token PATCH /agent/{agentId}/token
AgentApi update_agent PUT /agent/{agentId}
InstanceApi delete_instance DELETE /instance/{instanceId}
InstanceApi list_instances GET /instance
InstanceApi read_instance GET /instance/{instanceId}
InstanceApi read_instance_remote_connection GET /instance/{instanceId}/connect
InstanceApi read_instance_state GET /instance/{instanceId}/state
InstanceApi reboot_instance PATCH /instance/{instanceId}/reboot
InstanceApi reset_instance PATCH /instance/{instanceId}/reset
InstanceApi resume_instance PATCH /instance/{instanceId}/resume
InstanceApi shutdown_instance PATCH /instance/{instanceId}/shutdown
InstanceApi start_instance PATCH /instance/{instanceId}/start
InstanceApi stop_instance PATCH /instance/{instanceId}/stop
InstanceApi suspend_instance PATCH /instance/{instanceId}/suspend
InstanceApi update_instance PUT /instance/{instanceId}
KaktusApi delete_kaktus DELETE /kaktus/{kaktusId}
KaktusApi list_kaktus_instances GET /kaktus/{kaktusId}/instances
KaktusApi list_kaktuss GET /kaktus
KaktusApi read_kaktus GET /kaktus/{kaktusId}
KaktusApi read_kaktus_caps GET /kaktus/{kaktusId}/caps
KaktusApi update_kaktus PUT /kaktus/{kaktusId}
KawaiiApi create_kawaii_ip_sec POST /kawaii/{kawaiiId}/ipsec
KawaiiApi delete_kawaii DELETE /kawaii/{kawaiiId}
KawaiiApi delete_kawaii_ip_sec DELETE /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KawaiiApi list_kawaii_ip_secs GET /kawaii/{kawaiiId}/ipsec
KawaiiApi list_kawaiis GET /kawaii
KawaiiApi read_kawaii GET /kawaii/{kawaiiId}
KawaiiApi read_kawaii_ip_sec GET /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KawaiiApi update_kawaii PUT /kawaii/{kawaiiId}
KawaiiApi update_kawaii_ip_sec PUT /kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}
KiwiApi delete_kiwi DELETE /kiwi/{kiwiId}
KiwiApi list_kiwis GET /kiwi
KiwiApi read_kiwi GET /kiwi/{kiwiId}
KiwiApi update_kiwi PUT /kiwi/{kiwiId}
KomputeApi delete_kompute DELETE /kompute/{komputeId}
KomputeApi list_komputes GET /kompute
KomputeApi read_kompute GET /kompute/{komputeId}
KomputeApi read_kompute_state GET /kompute/{komputeId}/state
KomputeApi reboot_kompute PATCH /kompute/{komputeId}/reboot
KomputeApi reset_kompute PATCH /kompute/{komputeId}/reset
KomputeApi resume_kompute PATCH /kompute/{komputeId}/resume
KomputeApi shutdown_kompute PATCH /kompute/{komputeId}/shutdown
KomputeApi start_kompute PATCH /kompute/{komputeId}/start
KomputeApi stop_kompute PATCH /kompute/{komputeId}/stop
KomputeApi suspend_kompute PATCH /kompute/{komputeId}/suspend
KomputeApi update_kompute PUT /kompute/{komputeId}
KonveyApi delete_konvey DELETE /konvey/{konveyId}
KonveyApi list_konveys GET /konvey
KonveyApi read_konvey GET /konvey/{konveyId}
KonveyApi update_konvey PUT /konvey/{konveyId}
KyloApi delete_kylo DELETE /kylo/{kyloId}
KyloApi list_kylos GET /kylo
KyloApi read_kylo GET /kylo/{kyloId}
KyloApi update_kylo PUT /kylo/{kyloId}
NfsApi delete_storage_nfs DELETE /nfs/{nfsId}
NfsApi list_storage_nfs_kylos GET /nfs/{nfsId}/kylo
NfsApi list_storage_nfss GET /nfs
NfsApi read_storage_nfs GET /nfs/{nfsId}
NfsApi update_storage_nfs PUT /nfs/{nfsId}
PoolApi create_template POST /pool/{poolId}/template
PoolApi delete_storage_pool DELETE /pool/{poolId}
PoolApi list_storage_pool_templates GET /pool/{poolId}/templates
PoolApi list_storage_pool_volumes GET /pool/{poolId}/volumes
PoolApi list_storage_pools GET /pool
PoolApi read_storage_pool GET /pool/{poolId}
PoolApi set_storage_pool_default_template PATCH /pool/{poolId}/template/{templateId}/default
PoolApi update_storage_pool PUT /pool/{poolId}
ProjectApi create_project POST /project
ProjectApi create_project_dns_record POST /project/{projectId}/record
ProjectApi create_project_region_kawaii POST /project/{projectId}/region/{regionId}/kawaii
ProjectApi create_project_region_konvey POST /project/{projectId}/region/{regionId}/konvey
ProjectApi create_project_region_kylo POST /project/{projectId}/region/{regionId}/kylo
ProjectApi create_project_region_volume POST /project/{projectId}/region/{regionId}/volume
ProjectApi create_project_zone_instance POST /project/{projectId}/zone/{zoneId}/instance
ProjectApi create_project_zone_kompute POST /project/{projectId}/zone/{zoneId}/kompute
ProjectApi create_project_zone_konvey POST /project/{projectId}/zone/{zoneId}/konvey
ProjectApi delete_project DELETE /project/{projectId}
ProjectApi list_project_dns_records GET /project/{projectId}/records
ProjectApi list_project_region_kawaiis GET /project/{projectId}/region/{regionId}/kawaiis
ProjectApi list_project_region_konveys GET /project/{projectId}/region/{regionId}/konveys
ProjectApi list_project_region_kylos GET /project/{projectId}/region/{regionId}/kylo
ProjectApi list_project_region_volumes GET /project/{projectId}/region/{regionId}/volumes
ProjectApi list_project_zone_instances GET /project/{projectId}/zone/{zoneId}/instances
ProjectApi list_project_zone_komputes GET /project/{projectId}/zone/{zoneId}/komputes
ProjectApi list_project_zone_konveys GET /project/{projectId}/zone/{zoneId}/konveys
ProjectApi list_projects GET /project
ProjectApi read_project GET /project/{projectId}
ProjectApi read_project_cost GET /project/{projectId}/cost
ProjectApi read_project_usage GET /project/{projectId}/usage
ProjectApi update_project PUT /project/{projectId}
RecordApi delete_dns_record DELETE /record/{recordId}
RecordApi read_dns_record GET /record/{recordId}
RecordApi update_dns_record PUT /record/{recordId}
RegionApi create_kiwi POST /region/{regionId}/kiwi
RegionApi create_region POST /region
RegionApi create_region_dns_record POST /region/{regionId}/record
RegionApi create_storage_nfs POST /region/{regionId}/nfs
RegionApi create_storage_pool POST /region/{regionId}/pool
RegionApi create_v_net POST /region/{regionId}/vnet
RegionApi create_zone POST /region/{regionId}/zone
RegionApi delete_region DELETE /region/{regionId}
RegionApi list_region_dns_records GET /region/{regionId}/records
RegionApi list_region_kiwis GET /region/{regionId}/kiwis
RegionApi list_region_storage_nfss GET /region/{regionId}/nfs
RegionApi list_region_storage_pools GET /region/{regionId}/pools
RegionApi list_region_v_nets GET /region/{regionId}/vnets
RegionApi list_region_zones GET /region/{regionId}/zones
RegionApi list_regions GET /region
RegionApi read_region GET /region/{regionId}
RegionApi set_region_default_storage_nfs PATCH /region/{regionId}/nfs/{nfsId}/default
RegionApi set_region_default_storage_pool PATCH /region/{regionId}/pool/{poolId}/default
RegionApi update_region PUT /region/{regionId}
SubnetApi create_adapter POST /subnet/{subnetId}/adapter
SubnetApi delete_subnet DELETE /subnet/{subnetId}
SubnetApi list_subnet_adapters GET /subnet/{subnetId}/adapters
SubnetApi list_subnets GET /subnet
SubnetApi read_subnet GET /subnet/{subnetId}
SubnetApi update_subnet PUT /subnet/{subnetId}
TeamApi create_team POST /team
TeamApi delete_team DELETE /team/{teamId}
TeamApi list_teams GET /team
TeamApi read_team GET /team/{teamId}
TeamApi update_team PUT /team/{teamId}
TemplateApi delete_template DELETE /template/{templateId}
TemplateApi list_templates GET /template
TemplateApi read_template GET /template/{templateId}
TemplateApi update_template PUT /template/{templateId}
TokenApi delete_api_token DELETE /token/{tokenId}
TokenApi list_api_tokens GET /token
TokenApi read_api_token GET /token/{tokenId}
TokenApi update_api_token PUT /token/{tokenId}
UserApi create_user POST /user
UserApi delete_user DELETE /user/{userId}
UserApi list_users GET /user
UserApi login POST /login
UserApi logout POST /logout
UserApi read_user GET /user/{userId}
UserApi reset_password PUT /resetPassword
UserApi reset_user_password PATCH /user/{userId}/resetPassword
UserApi set_user_api_token PATCH /user/{userId}/token
UserApi set_user_password PUT /user/{userId}/password
UserApi update_user PUT /user/{userId}
VnetApi create_subnet POST /vnet/{vnetId}/subnet
VnetApi delete_v_net DELETE /vnet/{vnetId}
VnetApi list_v_net_subnets GET /vnet/{vnetId}/subnets
VnetApi list_v_nets GET /vnet
VnetApi read_v_net GET /vnet/{vnetId}
VnetApi set_v_net_default_subnet PATCH /vnet/{vnetId}/subnet/{subnetId}/default
VnetApi update_v_net PUT /vnet/{vnetId}
VolumeApi delete_volume DELETE /volume/{volumeId}
VolumeApi list_volumes GET /volume
VolumeApi read_volume GET /volume/{volumeId}
VolumeApi update_volume PUT /volume/{volumeId}
ZoneApi create_kaktus POST /zone/{zoneId}/kaktus
ZoneApi delete_zone DELETE /zone/{zoneId}
ZoneApi list_zone_kaktuses GET /zone/{zoneId}/kaktuses
ZoneApi list_zones GET /zone
ZoneApi read_zone GET /zone/{zoneId}
ZoneApi update_zone PUT /zone/{zoneId}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BearerAuth

  • Type: Bearer authentication (JWT)

Author

maintainers@kowabunga.cloud