432 lines
23 KiB
Python
432 lines
23 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
Vultr API
|
|
|
|
# Introduction The Vultr API v2 is a set of HTTP endpoints that adhere to RESTful design principles and CRUD actions with predictable URIs. It uses standard HTTP response codes, authentication, and verbs. The API has consistent and well-formed JSON requests and responses with cursor-based pagination to simplify list handling. Error messages are descriptive and easy to understand. All functions of the Vultr customer portal are accessible via the API, enabling you to script complex unattended scenarios with any tool fluent in HTTP. ## Requests Communicate with the API by making an HTTP request at the correct endpoint. The chosen method determines the action taken. | Method | Usage | | ------ | ------------- | | DELETE | Use the DELETE method to destroy a resource in your account. If it is not found, the operation will return a 4xx error and an appropriate message. | | GET | To retrieve information about a resource, use the GET method. The data is returned as a JSON object. GET methods are read-only and do not affect any resources. | | PATCH | Some resources support partial modification with PATCH, which modifies specific attributes without updating the entire object representation. | | POST | Issue a POST method to create a new object. Include all needed attributes in the request body encoded as JSON. | | PUT | Use the PUT method to update information about a resource. PUT will set new values on the item without regard to their current values. | **Rate Limit:** Vultr safeguards the API against bursts of incoming traffic based on the request's IP address to ensure stability for all users. If your application sends more than 30 requests per second, the API may return HTTP status code 429. ## Response Codes We use standard HTTP response codes to show the success or failure of requests. Response codes in the 2xx range indicate success, while codes in the 4xx range indicate an error, such as an authorization failure or a malformed request. All 4xx errors will return a JSON response object with an `error` attribute explaining the error. Codes in the 5xx range indicate a server-side problem preventing Vultr from fulfilling your request. | Response | Description | | ------ | ------------- | | 200 OK | The response contains your requested information. | | 201 Created | Your request was accepted. The resource was created. | | 202 Accepted | Your request was accepted. The resource was created or updated. | | 204 No Content | Your request succeeded, there is no additional information returned. | | 400 Bad Request | Your request was malformed. | | 401 Unauthorized | You did not supply valid authentication credentials. | | 403 Forbidden | You are not allowed to perform that action. | | 404 Not Found | No results were found for your request. | | 429 Too Many Requests | Your request exceeded the API rate limit. | | 500 Internal Server Error | We were unable to perform the request due to server-side problems. | ## Meta and Pagination Many API calls will return a `meta` object with paging information. ### Definitions | Term | Description | | ------ | ------------- | | **List** | The items returned from the database for your request (not necessarily shown in a single response depending on the **cursor** size). | | **Page** | A subset of the full **list** of items. Choose the size of a **page** with the `per_page` parameter. | | **Total** | The `total` attribute indicates the number of items in the full **list**.| | **Cursor** | Use the `cursor` query parameter to select a next or previous **page**. | | **Next** & **Prev** | Use the `next` and `prev` attributes of the `links` meta object as `cursor` values. | ### How to use Paging If your result **list** total exceeds the default **cursor** size (the default depends on the route, but is usually 100 records) or the value defined by the `per_page` query param (when present) the response will be returned to you paginated. ### Paging Example > These examples have abbreviated attributes and sample values. Your actual `cursor` values will be encoded alphanumeric strings. To return a **page** with the first two plans in the List: curl \"https://api.vultr.com/v2/plans?per_page=2\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" The API returns an object similar to this: { \"plans\": [ { \"id\": \"vc2-1c-2gb\", \"vcpu_count\": 1, \"ram\": 2048, \"locations\": [] }, { \"id\": \"vc2-24c-97gb\", \"vcpu_count\": 24, \"ram\": 98304, \"locations\": [] } ], \"meta\": { \"total\": 19, \"links\": { \"next\": \"WxYzExampleNext\", \"prev\": \"WxYzExamplePrev\" } } } The object contains two plans. The `total` attribute indicates that 19 plans are available in the List. To navigate forward in the **list**, use the `next` value (`WxYzExampleNext` in this example) as your `cursor` query parameter. curl \"https://api.vultr.com/v2/plans?per_page=2&cursor=WxYzExampleNext\" \\ -X GET -H \"Authorization: Bearer ${VULTR_API_KEY}\" Likewise, you can use the example `prev` value `WxYzExamplePrev` to navigate backward. ## Parameters You can pass information to the API with three different types of parameters. ### Path parameters Some API calls require variable parameters as part of the endpoint path. For example, to retrieve information about a user, supply the `user-id` in the endpoint. curl \"https://api.vultr.com/v2/users/{user-id}\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" ### Query parameters Some API calls allow filtering with query parameters. For example, the `/v2/plans` endpoint supports a `type` query parameter. Setting `type=vhf` instructs the API only to return High Frequency Compute plans in the list. You'll find more specifics about valid filters in the endpoint documentation below. curl \"https://api.vultr.com/v2/plans?type=vhf\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" You can also combine filtering with paging. Use the `per_page` parameter to retreive a subset of vhf plans. curl \"https://api.vultr.com/v2/plans?type=vhf&per_page=2\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" ### Request Body PUT, POST, and PATCH methods may include an object in the request body with a content type of **application/json**. The documentation for each endpoint below has more information about the expected object. ## API Example Conventions The examples in this documentation use `curl`, a command-line HTTP client, to demonstrate useage. Linux and macOS computers usually have curl installed by default, and it's [available for download](https://curl.se/download.html) on all popular platforms including Windows. Each example is split across multiple lines with the `\\` character, which is compatible with a `bash` terminal. A typical example looks like this: curl \"https://api.vultr.com/v2/domains\" \\ -X POST \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" \\ -H \"Content-Type: application/json\" \\ --data '{ \"domain\" : \"example.com\", \"ip\" : \"192.0.2.123\" }' * The `-X` parameter sets the request method. For consistency, we show the method on all examples, even though it's not explicitly required for GET methods. * The `-H` lines set required HTTP headers. These examples are formatted to expand the VULTR\\_API\\_KEY environment variable for your convenience. * Examples that require a JSON object in the request body pass the required data via the `--data` parameter. All values in this guide are examples. Do not rely on the OS or Plan IDs listed in this guide; use the appropriate endpoint to retreive values before creating resources. # Authentication <!-- ReDoc-Inject: <security-definitions> --> # noqa: E501
|
|
|
|
The version of the OpenAPI document: 2.0
|
|
Contact: opensource@vultr.com
|
|
Generated by: https://openapi-generator.tech
|
|
"""
|
|
|
|
import copy
|
|
import logging
|
|
import multiprocessing
|
|
import sys
|
|
import urllib3
|
|
|
|
from http import client as http_client
|
|
from vultr_python_client.exceptions import ApiValueError
|
|
|
|
|
|
JSON_SCHEMA_VALIDATION_KEYWORDS = {
|
|
'multipleOf', 'maximum', 'exclusiveMaximum',
|
|
'minimum', 'exclusiveMinimum', 'maxLength',
|
|
'minLength', 'pattern', 'maxItems', 'minItems',
|
|
'uniqueItems', 'maxProperties', 'minProperties',
|
|
}
|
|
|
|
class Configuration(object):
|
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
|
|
Ref: https://openapi-generator.tech
|
|
Do not edit the class manually.
|
|
|
|
:param host: Base url
|
|
:param api_key: Dict to store API key(s).
|
|
Each entry in the dict specifies an API key.
|
|
The dict key is the name of the security scheme in the OAS specification.
|
|
The dict value is the API key secret.
|
|
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
|
|
The dict key is the name of the security scheme in the OAS specification.
|
|
The dict value is an API key prefix when generating the auth data.
|
|
:param username: Username for HTTP basic authentication
|
|
:param password: Password for HTTP basic authentication
|
|
:param discard_unknown_keys: Boolean value indicating whether to discard
|
|
unknown properties. A server may send a response that includes additional
|
|
properties that are not known by the client in the following scenarios:
|
|
1. The OpenAPI document is incomplete, i.e. it does not match the server
|
|
implementation.
|
|
2. The client was generated using an older version of the OpenAPI document
|
|
and the server has been upgraded since then.
|
|
If a schema in the OpenAPI document defines the additionalProperties attribute,
|
|
then all undeclared properties received by the server are injected into the
|
|
additional properties map. In that case, there are undeclared properties, and
|
|
nothing to discard.
|
|
:param disabled_client_side_validations (string): Comma-separated list of
|
|
JSON schema validation keywords to disable JSON schema structural validation
|
|
rules. The following keywords may be specified: multipleOf, maximum,
|
|
exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
|
|
maxItems, minItems.
|
|
By default, the validation is performed for data generated locally by the client
|
|
and data received from the server, independent of any validation performed by
|
|
the server side. If the input data does not satisfy the JSON schema validation
|
|
rules specified in the OpenAPI document, an exception is raised.
|
|
If disabled_client_side_validations is set, structural validation is
|
|
disabled. This can be useful to troubleshoot data validation problem, such as
|
|
when the OpenAPI document validation rules do not match the actual API data
|
|
received by the server.
|
|
:param server_index: Index to servers configuration.
|
|
:param server_variables: Mapping with string values to replace variables in
|
|
templated server configuration. The validation of enums is performed for
|
|
variables with defined enum values before.
|
|
:param server_operation_index: Mapping from operation ID to an index to server
|
|
configuration.
|
|
:param server_operation_variables: Mapping from operation ID to a mapping with
|
|
string values to replace variables in templated server configuration.
|
|
The validation of enums is performed for variables with defined enum values before.
|
|
|
|
:Example:
|
|
"""
|
|
|
|
_default = None
|
|
|
|
def __init__(
|
|
self,
|
|
host=None,
|
|
discard_unknown_keys=False,
|
|
disabled_client_side_validations="",
|
|
server_index=None,
|
|
server_variables=None,
|
|
server_operation_index=None,
|
|
server_operation_variables=None,
|
|
):
|
|
"""Constructor
|
|
"""
|
|
self._base_path = "https://api.vultr.com/v2" if host is None else host
|
|
"""Default Base url
|
|
"""
|
|
self.server_index = 0 if server_index is None and host is None else server_index
|
|
self.server_operation_index = server_operation_index or {}
|
|
"""Default server index
|
|
"""
|
|
self.server_variables = server_variables or {}
|
|
self.server_operation_variables = server_operation_variables or {}
|
|
"""Default server variables
|
|
"""
|
|
self.temp_folder_path = None
|
|
"""Temp file folder for downloading files
|
|
"""
|
|
# Authentication Settings
|
|
self.disabled_client_side_validations = disabled_client_side_validations
|
|
self.logger = {}
|
|
"""Logging Settings
|
|
"""
|
|
self.logger["package_logger"] = logging.getLogger("openapi_client")
|
|
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
|
|
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
|
|
"""Log format
|
|
"""
|
|
self.logger_stream_handler = None
|
|
"""Log stream handler
|
|
"""
|
|
self.logger_file_handler = None
|
|
"""Log file handler
|
|
"""
|
|
self.logger_file = None
|
|
"""Debug file location
|
|
"""
|
|
self.debug = False
|
|
"""Debug switch
|
|
"""
|
|
|
|
self.verify_ssl = True
|
|
"""SSL/TLS verification
|
|
Set this to false to skip verifying SSL certificate when calling API
|
|
from https server.
|
|
"""
|
|
self.ssl_ca_cert = None
|
|
"""Set this to customize the certificate file to verify the peer.
|
|
"""
|
|
self.cert_file = None
|
|
"""client certificate file
|
|
"""
|
|
self.key_file = None
|
|
"""client key file
|
|
"""
|
|
self.assert_hostname = None
|
|
"""Set this to True/False to enable/disable SSL hostname verification.
|
|
"""
|
|
|
|
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
|
|
"""urllib3 connection pool's maximum number of connections saved
|
|
per pool. urllib3 uses 1 connection as default value, but this is
|
|
not the best value when you are making a lot of possibly parallel
|
|
requests to the same host, which is often the case here.
|
|
cpu_count * 5 is used as default value to increase performance.
|
|
"""
|
|
|
|
self.proxy = None
|
|
"""Proxy URL
|
|
"""
|
|
self.proxy_headers = None
|
|
"""Proxy headers
|
|
"""
|
|
self.safe_chars_for_path_param = ''
|
|
"""Safe chars for path_param
|
|
"""
|
|
self.retries = None
|
|
"""Adding retries to override urllib3 default value 3
|
|
"""
|
|
# Enable client side validation
|
|
self.client_side_validation = True
|
|
|
|
# Options to pass down to the underlying urllib3 socket
|
|
self.socket_options = None
|
|
|
|
def __deepcopy__(self, memo):
|
|
cls = self.__class__
|
|
result = cls.__new__(cls)
|
|
memo[id(self)] = result
|
|
for k, v in self.__dict__.items():
|
|
if k not in ('logger', 'logger_file_handler'):
|
|
setattr(result, k, copy.deepcopy(v, memo))
|
|
# shallow copy of loggers
|
|
result.logger = copy.copy(self.logger)
|
|
# use setters to configure loggers
|
|
result.logger_file = self.logger_file
|
|
result.debug = self.debug
|
|
return result
|
|
|
|
def __setattr__(self, name, value):
|
|
object.__setattr__(self, name, value)
|
|
if name == 'disabled_client_side_validations':
|
|
s = set(filter(None, value.split(',')))
|
|
for v in s:
|
|
if v not in JSON_SCHEMA_VALIDATION_KEYWORDS:
|
|
raise ApiValueError(
|
|
"Invalid keyword: '{0}''".format(v))
|
|
self._disabled_client_side_validations = s
|
|
|
|
@classmethod
|
|
def set_default(cls, default):
|
|
"""Set default instance of configuration.
|
|
|
|
It stores default configuration, which can be
|
|
returned by get_default_copy method.
|
|
|
|
:param default: object of Configuration
|
|
"""
|
|
cls._default = copy.deepcopy(default)
|
|
|
|
@classmethod
|
|
def get_default_copy(cls):
|
|
"""Return new instance of configuration.
|
|
|
|
This method returns newly created, based on default constructor,
|
|
object of Configuration class or returns a copy of default
|
|
configuration passed by the set_default method.
|
|
|
|
:return: The configuration object.
|
|
"""
|
|
if cls._default is not None:
|
|
return copy.deepcopy(cls._default)
|
|
return Configuration()
|
|
|
|
@property
|
|
def logger_file(self):
|
|
"""The logger file.
|
|
|
|
If the logger_file is None, then add stream handler and remove file
|
|
handler. Otherwise, add file handler and remove stream handler.
|
|
|
|
:param value: The logger_file path.
|
|
:type: str
|
|
"""
|
|
return self.__logger_file
|
|
|
|
@logger_file.setter
|
|
def logger_file(self, value):
|
|
"""The logger file.
|
|
|
|
If the logger_file is None, then add stream handler and remove file
|
|
handler. Otherwise, add file handler and remove stream handler.
|
|
|
|
:param value: The logger_file path.
|
|
:type: str
|
|
"""
|
|
self.__logger_file = value
|
|
if self.__logger_file:
|
|
# If set logging file,
|
|
# then add file handler and remove stream handler.
|
|
self.logger_file_handler = logging.FileHandler(self.__logger_file)
|
|
self.logger_file_handler.setFormatter(self.logger_formatter)
|
|
for _, logger in self.logger.items():
|
|
logger.addHandler(self.logger_file_handler)
|
|
|
|
@property
|
|
def debug(self):
|
|
"""Debug status
|
|
|
|
:param value: The debug status, True or False.
|
|
:type: bool
|
|
"""
|
|
return self.__debug
|
|
|
|
@debug.setter
|
|
def debug(self, value):
|
|
"""Debug status
|
|
|
|
:param value: The debug status, True or False.
|
|
:type: bool
|
|
"""
|
|
self.__debug = value
|
|
if self.__debug:
|
|
# if debug status is True, turn on debug logging
|
|
for _, logger in self.logger.items():
|
|
logger.setLevel(logging.DEBUG)
|
|
# turn on http_client debug
|
|
http_client.HTTPConnection.debuglevel = 1
|
|
else:
|
|
# if debug status is False, turn off debug logging,
|
|
# setting log level to default `logging.WARNING`
|
|
for _, logger in self.logger.items():
|
|
logger.setLevel(logging.WARNING)
|
|
# turn off http_client debug
|
|
http_client.HTTPConnection.debuglevel = 0
|
|
|
|
@property
|
|
def logger_format(self):
|
|
"""The logger format.
|
|
|
|
The logger_formatter will be updated when sets logger_format.
|
|
|
|
:param value: The format string.
|
|
:type: str
|
|
"""
|
|
return self.__logger_format
|
|
|
|
@logger_format.setter
|
|
def logger_format(self, value):
|
|
"""The logger format.
|
|
|
|
The logger_formatter will be updated when sets logger_format.
|
|
|
|
:param value: The format string.
|
|
:type: str
|
|
"""
|
|
self.__logger_format = value
|
|
self.logger_formatter = logging.Formatter(self.__logger_format)
|
|
|
|
def get_api_key_with_prefix(self, identifier, alias=None):
|
|
"""Gets API key (with prefix if set).
|
|
|
|
:param identifier: The identifier of apiKey.
|
|
:param alias: The alternative identifier of apiKey.
|
|
:return: The token for api key authentication.
|
|
"""
|
|
if self.refresh_api_key_hook is not None:
|
|
self.refresh_api_key_hook(self)
|
|
key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
|
|
if key:
|
|
prefix = self.api_key_prefix.get(identifier)
|
|
if prefix:
|
|
return "%s %s" % (prefix, key)
|
|
else:
|
|
return key
|
|
|
|
def get_basic_auth_token(self):
|
|
"""Gets HTTP basic authentication header (string).
|
|
|
|
:return: The token for basic HTTP authentication.
|
|
"""
|
|
username = ""
|
|
if self.username is not None:
|
|
username = self.username
|
|
password = ""
|
|
if self.password is not None:
|
|
password = self.password
|
|
return urllib3.util.make_headers(
|
|
basic_auth=username + ':' + password
|
|
).get('authorization')
|
|
|
|
def auth_settings(self):
|
|
"""Gets Auth Settings dict for api client.
|
|
|
|
:return: The Auth Settings information dict.
|
|
"""
|
|
auth = {}
|
|
if self.access_token is not None:
|
|
auth['APIKey'] = {
|
|
'type': 'bearer',
|
|
'in': 'header',
|
|
'key': 'Authorization',
|
|
'value': 'Bearer ' + self.access_token
|
|
}
|
|
return auth
|
|
|
|
def to_debug_report(self):
|
|
"""Gets the essential information for debugging.
|
|
|
|
:return: The report for debugging.
|
|
"""
|
|
return "Python SDK Debug Report:\n"\
|
|
"OS: {env}\n"\
|
|
"Python Version: {pyversion}\n"\
|
|
"Version of the API: 2.0\n"\
|
|
"SDK Package Version: 1.0.0".\
|
|
format(env=sys.platform, pyversion=sys.version)
|
|
|
|
def get_host_settings(self):
|
|
"""Gets an array of host settings
|
|
|
|
:return: An array of host settings
|
|
"""
|
|
return [
|
|
{
|
|
'url': "https://api.vultr.com/v2",
|
|
'description': "No description provided",
|
|
}
|
|
]
|
|
|
|
def get_host_from_settings(self, index, variables=None, servers=None):
|
|
"""Gets host URL based on the index and variables
|
|
:param index: array index of the host settings
|
|
:param variables: hash of variable and the corresponding value
|
|
:param servers: an array of host settings or None
|
|
:return: URL based on host settings
|
|
"""
|
|
if index is None:
|
|
return self._base_path
|
|
|
|
variables = {} if variables is None else variables
|
|
servers = self.get_host_settings() if servers is None else servers
|
|
|
|
try:
|
|
server = servers[index]
|
|
except IndexError:
|
|
raise ValueError(
|
|
"Invalid index {0} when selecting the host settings. "
|
|
"Must be less than {1}".format(index, len(servers)))
|
|
|
|
url = server['url']
|
|
|
|
# go through variables and replace placeholders
|
|
for variable_name, variable in server.get('variables', {}).items():
|
|
used_value = variables.get(
|
|
variable_name, variable['default_value'])
|
|
|
|
if 'enum_values' in variable \
|
|
and used_value not in variable['enum_values']:
|
|
raise ValueError(
|
|
"The variable `{0}` in the host URL has invalid value "
|
|
"{1}. Must be {2}.".format(
|
|
variable_name, variables[variable_name],
|
|
variable['enum_values']))
|
|
|
|
url = url.replace("{" + variable_name + "}", used_value)
|
|
|
|
return url
|
|
|
|
@property
|
|
def host(self):
|
|
"""Return generated host."""
|
|
return self.get_host_from_settings(self.server_index, variables=self.server_variables)
|
|
|
|
@host.setter
|
|
def host(self, value):
|
|
"""Fix base path."""
|
|
self._base_path = value
|
|
self.server_index = None
|