quantcdn.DomainsApi

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

Method	HTTP request	Description
domains_create	POST /api/v2/organizations/{organization}/projects/{project}/domains	Add a new domain
domains_delete	DELETE /api/v2/organizations/{organization}/projects/{project}/domains/{domain}	Delete a domain
domains_list	GET /api/v2/organizations/{organization}/projects/{project}/domains	List all domains for a project
domains_read	GET /api/v2/organizations/{organization}/projects/{project}/domains/{domain}	Get details of a single domain
domains_renew	POST /api/v2/organizations/{organization}/projects/{project}/domains/{domain}/renew	Renew the SSL certificate for a domain

domains_create

V2Domain domains_create(organization, project, v2_domain_request)

Add a new domain

Example

Bearer (JWT) Authentication (BearerAuth):

import quantcdn
from quantcdn.models.v2_domain import V2Domain
from quantcdn.models.v2_domain_request import V2DomainRequest
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.DomainsApi(api_client)
    organization = 'test-org' # str | Organization identifier
    project = 'test-project' # str | Project identifier
    v2_domain_request = quantcdn.V2DomainRequest() # V2DomainRequest | 

    try:
        # Add a new domain
        api_response = api_instance.domains_create(organization, project, v2_domain_request)
        print("The response of DomainsApi->domains_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->domains_create: %s\n" % e)

Parameters

Name	Type	Description
organization	str	Organization identifier
project	str	Project identifier
v2_domain_request	V2DomainRequest

Return type

V2Domain

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The request has succeeded.	-
400	The server could not understand the request due to invalid syntax.	-
403	Access is forbidden.	-

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

domains_delete

domains_delete(organization, project, domain)

Delete a domain

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.DomainsApi(api_client)
    organization = 'test-org' # str | Organization identifier
    project = 'test-project' # str | Project identifier
    domain = '0000' # str | Domain id

    try:
        # Delete a domain
        api_instance.domains_delete(organization, project, domain)
    except Exception as e:
        print("Exception when calling DomainsApi->domains_delete: %s\n" % e)

Parameters

Name	Type	Description
organization	str	Organization identifier
project	str	Project identifier
domain	str	Domain id

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The domain has been deleted.	-
400	The server could not understand the request due to invalid syntax.	-
403	Access is forbidden.	-

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

domains_list

List[V2Domain] domains_list(organization, project)

List all domains for a project

Example

Bearer (JWT) Authentication (BearerAuth):

import quantcdn
from quantcdn.models.v2_domain import V2Domain
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.DomainsApi(api_client)
    organization = 'test-org' # str | Organization identifier
    project = 'test-project' # str | Project identifier

    try:
        # List all domains for a project
        api_response = api_instance.domains_list(organization, project)
        print("The response of DomainsApi->domains_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->domains_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization	str	Organization identifier
project	str	Project identifier

Return type

List[V2Domain]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The request has succeeded.	-
400	The server could not understand the request due to invalid syntax.	-
403	Access is forbidden.	-

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

domains_read

V2Domain domains_read(organization, project, domain)

Get details of a single domain

Example

Bearer (JWT) Authentication (BearerAuth):

import quantcdn
from quantcdn.models.v2_domain import V2Domain
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.DomainsApi(api_client)
    organization = 'test-org' # str | Organization identifier
    project = 'test-project' # str | Project identifier
    domain = '0000' # str | Domain id

    try:
        # Get details of a single domain
        api_response = api_instance.domains_read(organization, project, domain)
        print("The response of DomainsApi->domains_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsApi->domains_read: %s\n" % e)

Parameters

Name	Type	Description
organization	str	Organization identifier
project	str	Project identifier
domain	str	Domain id

Return type

V2Domain

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The request has succeeded.	-
400	The server could not understand the request due to invalid syntax.	-
403	Access is forbidden.	-

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

domains_renew

domains_renew(organization, project, domain)

Renew the SSL certificate for a domain

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.DomainsApi(api_client)
    organization = 'test-org' # str | Organization identifier
    project = 'test-project' # str | Project identifier
    domain = '0000' # str | Domain id

    try:
        # Renew the SSL certificate for a domain
        api_instance.domains_renew(organization, project, domain)
    except Exception as e:
        print("Exception when calling DomainsApi->domains_renew: %s\n" % e)

Parameters

Name	Type	Description
organization	str	Organization identifier
project	str	Project identifier
domain	str	Domain id

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	The SSL certificate renewal has been initiated.	-
400	The server could not understand the request due to invalid syntax.	-
403	Access is forbidden.	-

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

quantcdn.DomainsApi

domains_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_read

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_renew

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

DomainsApi.md

Latest commit

History

DomainsApi.md

File metadata and controls

quantcdn.DomainsApi

domains_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_read

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

domains_renew

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details