kowabunga.KomputeApi

All URIs are relative to https://raw.githubusercontent.com/api/v1

Method	HTTP request	Description
delete_kompute	DELETE /kompute/{komputeId}
list_komputes	GET /kompute
read_kompute	GET /kompute/{komputeId}
read_kompute_state	GET /kompute/{komputeId}/state
reboot_kompute	PATCH /kompute/{komputeId}/reboot
reset_kompute	PATCH /kompute/{komputeId}/reset
resume_kompute	PATCH /kompute/{komputeId}/resume
shutdown_kompute	PATCH /kompute/{komputeId}/shutdown
start_kompute	PATCH /kompute/{komputeId}/start
stop_kompute	PATCH /kompute/{komputeId}/stop
suspend_kompute	PATCH /kompute/{komputeId}/suspend
update_kompute	PUT /kompute/{komputeId}

delete_kompute

delete_kompute(kompute_id)

Deletes an existing Kompute.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.delete_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->delete_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute has been successfully removed.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
409	Conflict error: A similar resource already exists or resource is still being referenced somewhere.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_komputes

List[str] list_komputes()

Returns the IDs of Kompute objects.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)

    try:
        api_response = api_instance.list_komputes()
        print("The response of KomputeApi->list_komputes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KomputeApi->list_komputes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns an array of Kompute IDs.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_kompute

Kompute read_kompute(kompute_id)

Returns a Kompute.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.models.kompute import Kompute
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_response = api_instance.read_kompute(kompute_id)
        print("The response of KomputeApi->read_kompute:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KomputeApi->read_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

Kompute

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Kompute object.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_kompute_state

InstanceState read_kompute_state(kompute_id)

Returns a virtual machine instance state.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.models.instance_state import InstanceState
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_response = api_instance.read_kompute_state(kompute_id)
        print("The response of KomputeApi->read_kompute_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KomputeApi->read_kompute_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

InstanceState

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the virtual machine instance state object.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reboot_kompute

reboot_kompute(kompute_id)

Performs a Kompute software reboot.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.reboot_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->reboot_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute software reboot is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_kompute

reset_kompute(kompute_id)

Performs a Kompute hardware reset.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.reset_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->reset_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute hardware reset is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resume_kompute

resume_kompute(kompute_id)

Performs a Kompute software PM resume.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.resume_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->resume_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute software PM resume is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shutdown_kompute

shutdown_kompute(kompute_id)

Performs a Kompute software shutdown.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.shutdown_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->shutdown_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute software shutdown is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_kompute

start_kompute(kompute_id)

Performs a Kompute hardware boot-up.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.start_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->start_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute hardware boot-up is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stop_kompute

stop_kompute(kompute_id)

Performs a Kompute hardware stop.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.stop_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->stop_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute hardware stop is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

suspend_kompute

suspend_kompute(kompute_id)

Performs a Kompute software PM suspend.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

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

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.

    try:
        api_instance.suspend_kompute(kompute_id)
    except Exception as e:
        print("Exception when calling KomputeApi->suspend_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kompute software PM suspend is successful.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_kompute

Kompute update_kompute(kompute_id, kompute)

Updates a Kompute configuration.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.models.kompute import Kompute
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/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.KomputeApi(api_client)
    kompute_id = 'kompute_id_example' # str | The ID of the Kompute.
    kompute = kowabunga.Kompute() # Kompute | Kompute payload.

    try:
        api_response = api_instance.update_kompute(kompute_id, kompute)
        print("The response of KomputeApi->update_kompute:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling KomputeApi->update_kompute: %s\n" % e)

Parameters

Name	Type	Description	Notes
kompute_id	str	The ID of the Kompute.
kompute	Kompute	Kompute payload.

Return type

Kompute

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Kompute object.	-
400	BadRequest error: Bad request (wrong input parameters).	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-
507	InsufficientResource error: Server can't allocate resources (logical quotas or physical limits hit).	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

KomputeApi.md

Latest commit

History

KomputeApi.md

File metadata and controls

kowabunga.KomputeApi

delete_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_komputes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_kompute_state

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reboot_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reset_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

resume_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shutdown_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

stop_kompute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

suspend_kompute

Example

Parameters