Skip to content

Latest commit

 

History

History
256 lines (177 loc) · 11.3 KB

BandwidthApi.md

File metadata and controls

256 lines (177 loc) · 11.3 KB

clientapi_cpanel.BandwidthApi

All URIs are relative to https://cpanel-server.tld:2083/execute

Method HTTP request Description
get_enabled_protocols GET /Bandwidth/get_enabled_protocols Return services monitored in bandwidth data
get_retention_periods GET /Bandwidth/get_retention_periods Return bandwidth retention period
query GET /Bandwidth/query Return cPanel account's bandwidth usage report

get_enabled_protocols

InlineResponse20011 get_enabled_protocols()

Return services monitored in bandwidth data

This function returns a list of the server's enabled protocols.

Example

  • Basic Authentication (BasicAuth):
import clientapi_cpanel
from clientapi_cpanel.models.inline_response20011 import InlineResponse20011
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# 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 HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.BandwidthApi(api_client)

    try:
        # Return services monitored in bandwidth data
        api_response = api_instance.get_enabled_protocols()
        print("The response of BandwidthApi->get_enabled_protocols:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BandwidthApi->get_enabled_protocols: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse20011

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 HTTP Request was successful. -

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

get_retention_periods

InlineResponse20012 get_retention_periods()

Return bandwidth retention period

This function retrieves the retention periods for bandwidth data.

Example

  • Basic Authentication (BasicAuth):
import clientapi_cpanel
from clientapi_cpanel.models.inline_response20012 import InlineResponse20012
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# 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 HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.BandwidthApi(api_client)

    try:
        # Return bandwidth retention period
        api_response = api_instance.get_retention_periods()
        print("The response of BandwidthApi->get_retention_periods:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BandwidthApi->get_retention_periods: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse20012

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 HTTP Request was successful. -

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

query

InlineResponse20013 query(grouping, domains=domains, end=end, interval=interval, protocols=protocols, start=start, timezone=timezone)

Return cPanel account's bandwidth usage report

This function queries an account's bandwidth data and returns a report.

Note:

This function also returns the bandwidth use of a distributed cPanel account.

Example

  • Basic Authentication (BasicAuth):
import clientapi_cpanel
from clientapi_cpanel.models.inline_response20013 import InlineResponse20013
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# 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 HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.BandwidthApi(api_client)
    grouping = clientapi_cpanel.Grouping() # Grouping | How to group the data in the report, in pipe-separated format. This list **must** contain one or both of the following parameters:  A pipe-separated list that contains one or both of the following parameters: * `domain` * `protocol`  This parameter can also include only **one** of the following start time interval types: * `year` * `year_month` * `year_month_day` * `year_month_day_hour` * `year_month_day_mour_minute`  **Note:**  * This parameter accepts a maximum of three values. * The function nests the return objects in the order that you declare the values in this parameter.
    domains = 'domains=example.com|subdomain.example.com|subdomain2.example.com|parkedexample.com|UNKNOWN' # str | A pipe-separated list of domains for which to provided data.  **Note:**  * If you do not include this parameter, the function will return data for all domains on the cPanel account. * The `UNKNOWN` \"pseudo-domain\" refers to data recorded without a specific domain. All traffic except HTTP traffic is recorded without a specific domain. (optional)
    end = 1446664809 # int | The end date of the report window. (optional)
    interval = daily # str | Length of time between bandwidth data samples.  * `daily` * `hourly` * `5min`  **Note:**  The interval's retention period determines availability of the interval's data. Use the `Bandwidth::get_retention_periods` API to determine an interval's retention period. (optional) (default to daily)
    protocols = 'protocols=http|imap|smtp|pop3|ftp' # str | A pipe-separated list of the protocols for which to provide data. * `http` * `imap` * `smtp` * `pop3` * `ftp` (optional)
    start = 1445664609 # int | The start date of the report window. (optional)
    timezone = 'America/Chicago' # str | The timezone in which to report the data. (optional)

    try:
        # Return cPanel account's bandwidth usage report
        api_response = api_instance.query(grouping, domains=domains, end=end, interval=interval, protocols=protocols, start=start, timezone=timezone)
        print("The response of BandwidthApi->query:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BandwidthApi->query: %s\n" % e)

Parameters

Name Type Description Notes
grouping Grouping How to group the data in the report, in pipe-separated format. This list must contain one or both of the following parameters: A pipe-separated list that contains one or both of the following parameters: * `domain` * `protocol` This parameter can also include only one of the following start time interval types: * `year` * `year_month` * `year_month_day` * `year_month_day_hour` * `year_month_day_mour_minute` Note: * This parameter accepts a maximum of three values. * The function nests the return objects in the order that you declare the values in this parameter.
domains str A pipe-separated list of domains for which to provided data. Note: * If you do not include this parameter, the function will return data for all domains on the cPanel account. * The `UNKNOWN` "pseudo-domain" refers to data recorded without a specific domain. All traffic except HTTP traffic is recorded without a specific domain. [optional]
end int The end date of the report window. [optional]
interval str Length of time between bandwidth data samples. * `daily` * `hourly` * `5min` Note: The interval's retention period determines availability of the interval's data. Use the `Bandwidth::get_retention_periods` API to determine an interval's retention period. [optional] [default to daily]
protocols str A pipe-separated list of the protocols for which to provide data. * `http` * `imap` * `smtp` * `pop3` * `ftp` [optional]
start int The start date of the report window. [optional]
timezone str The timezone in which to report the data. [optional]

Return type

InlineResponse20013

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 HTTP Request was successful. -

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