Skip to content

Latest commit

 

History

History
171 lines (119 loc) · 5.5 KB

ContainersApi.md

File metadata and controls

171 lines (119 loc) · 5.5 KB

quantcdn.ContainersApi

All URIs are relative to https://dashboard.quantcdn.io

Method HTTP request Description
list_containers GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers Get the containers in an environment
update_container PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers/{container} Update a container in an environment

list_containers

list_containers(organisation, application, environment)

Get the containers in an environment

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.ContainersApi(api_client)
    organisation = 'test-org' # str | The organisation ID
    application = 'test-app' # str | The application ID
    environment = 'test-env' # str | The environment ID

    try:
        # Get the containers in an environment
        api_instance.list_containers(organisation, application, environment)
    except Exception as e:
        print("Exception when calling ContainersApi->list_containers: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID
application str The application ID
environment str The environment ID

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 The containers in the environment -
404 The environment not found -

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

update_container

update_container(organisation, application, environment, container, container2)

Update a container in an environment

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.container import Container
from quantcdn.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.ContainersApi(api_client)
    organisation = 'test-org' # str | The organisation ID
    application = 'test-app' # str | The application ID
    environment = 'test-env' # str | The environment ID
    container = 'test-container' # str | The container ID
    container2 = quantcdn.Container() # Container | 

    try:
        # Update a container in an environment
        api_instance.update_container(organisation, application, environment, container, container2)
    except Exception as e:
        print("Exception when calling ContainersApi->update_container: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID
application str The application ID
environment str The environment ID
container str The container ID
container2 Container

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The updated container -
404 The container not found -

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