Skip to content

VolumeApi.md

Latest commit

 

History

History
350 lines (243 loc) · 11.4 KB

VolumeApi.md

File metadata and controls

350 lines (243 loc) · 11.4 KB

kowabunga.VolumeApi

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

Method HTTP request Description
delete_volume DELETE /volume/{volumeId}
list_volumes GET /volume
read_volume GET /volume/{volumeId}
update_volume PUT /volume/{volumeId}

delete_volume

delete_volume(volume_id)

Deletes an existing storage volume.

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.VolumeApi(api_client)
    volume_id = 'volume_id_example' # str | The ID of the storage volume.

    try:
        api_instance.delete_volume(volume_id)
    except Exception as e:
        print("Exception when calling VolumeApi->delete_volume: %s\n" % e)

Parameters

Name Type Description Notes
volume_id str The ID of the storage volume.

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 storage volume 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_volumes

List[str] list_volumes()

Returns the IDs of storage volume 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.VolumeApi(api_client)

    try:
        api_response = api_instance.list_volumes()
        print("The response of VolumeApi->list_volumes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VolumeApi->list_volumes: %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 storage volume 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_volume

Volume read_volume(volume_id)

Returns a storage volume.

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (BearerAuth):
import kowabunga
from kowabunga.models.volume import Volume
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.VolumeApi(api_client)
    volume_id = 'volume_id_example' # str | The ID of the storage volume.

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

Parameters

Name Type Description Notes
volume_id str The ID of the storage volume.

Return type

Volume

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the storage volume 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]

update_volume

Volume update_volume(volume_id, volume)

Updates a storage volume configuration.

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (BearerAuth):
import kowabunga
from kowabunga.models.volume import Volume
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.VolumeApi(api_client)
    volume_id = 'volume_id_example' # str | The ID of the storage volume.
    volume = kowabunga.Volume() # Volume | Volume payload.

    try:
        api_response = api_instance.update_volume(volume_id, volume)
        print("The response of VolumeApi->update_volume:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VolumeApi->update_volume: %s\n" % e)

Parameters

Name Type Description Notes
volume_id str The ID of the storage volume.
volume Volume Volume payload.

Return type

Volume

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Returns the storage volume 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]