Skip to content

Latest commit

 

History

History
401 lines (277 loc) · 12.7 KB

ApplicationsApi.md

File metadata and controls

401 lines (277 loc) · 12.7 KB

quantcdn.ApplicationsApi

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

Method HTTP request Description
create_application POST /api/v3/organizations/{organisation}/applications Create a new application
delete_application DELETE /api/v3/organizations/{organisation}/applications/{application} Delete an application
get_application GET /api/v3/organizations/{organisation}/applications/{application} Get a single application
get_ecr_login_credentials GET /api/v3/organizations/{organisation}/applications/ecr-login Get ECR login credentials
list_applications GET /api/v3/organizations/{organisation}/applications Get all applications for an organisation

create_application

Application create_application(organisation, create_application_request)

Create a new application

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.application import Application
from quantcdn.models.create_application_request import CreateApplicationRequest
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.ApplicationsApi(api_client)
    organisation = 'organisation_example' # str | The organisation ID
    create_application_request = quantcdn.CreateApplicationRequest() # CreateApplicationRequest | 

    try:
        # Create a new application
        api_response = api_instance.create_application(organisation, create_application_request)
        print("The response of ApplicationsApi->create_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationsApi->create_application: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID
create_application_request CreateApplicationRequest

Return type

Application

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 The created application -
400 The request is invalid -
403 Application limit reached - organisation has reached the maximum number of allowed applications -

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

delete_application

delete_application(organisation, application)

Delete an application

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.ApplicationsApi(api_client)
    organisation = 'organisation_example' # str | The organisation ID
    application = 'application_example' # str | The application ID

    try:
        # Delete an application
        api_instance.delete_application(organisation, application)
    except Exception as e:
        print("Exception when calling ApplicationsApi->delete_application: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID
application str The application 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
204 The application deleted -
404 The application not found -

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

get_application

Application get_application(organisation, application)

Get a single application

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.application import Application
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.ApplicationsApi(api_client)
    organisation = 'organisation_example' # str | The organisation ID
    application = 'application_example' # str | The application ID

    try:
        # Get a single application
        api_response = api_instance.get_application(organisation, application)
        print("The response of ApplicationsApi->get_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationsApi->get_application: %s\n" % e)

Parameters

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

Return type

Application

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The application -
404 The application not found -

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

get_ecr_login_credentials

GetEcrLoginCredentials200Response get_ecr_login_credentials(organisation)

Get ECR login credentials

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.get_ecr_login_credentials200_response import GetEcrLoginCredentials200Response
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.ApplicationsApi(api_client)
    organisation = 'organisation_example' # str | The organisation ID

    try:
        # Get ECR login credentials
        api_response = api_instance.get_ecr_login_credentials(organisation)
        print("The response of ApplicationsApi->get_ecr_login_credentials:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationsApi->get_ecr_login_credentials: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID

Return type

GetEcrLoginCredentials200Response

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The ECR login credentials -

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

list_applications

List[Application] list_applications(organisation)

Get all applications for an organisation

Example

  • Bearer (JWT) Authentication (BearerAuth):
import quantcdn
from quantcdn.models.application import Application
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.ApplicationsApi(api_client)
    organisation = 'organisation_example' # str | The organisation ID

    try:
        # Get all applications for an organisation
        api_response = api_instance.list_applications(organisation)
        print("The response of ApplicationsApi->list_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApplicationsApi->list_applications: %s\n" % e)

Parameters

Name Type Description Notes
organisation str The organisation ID

Return type

List[Application]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of applications -

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