This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new df4a26e Update the Python TO client to API 3.0 (#5570)
df4a26e is described below
commit df4a26ef0adc4bfb4b7be7ad6058cb867271ba69
Author: Rawlin Peters <[email protected]>
AuthorDate: Wed Feb 24 11:30:43 2021 -0700
Update the Python TO client to API 3.0 (#5570)
* Update the Python TO client to API 3.0
Also, fix up the topologies methods.
* Fix ORT.py requesting version 2.0
---
CHANGELOG.md | 1 +
.../cdn-in-a-box/ort/traffic_ops_ort/to_api.py | 4 +-
.../clients/python/to_access/__init__.py | 2 +-
.../clients/python/trafficops/__version__.py | 4 +-
.../clients/python/trafficops/tosession.py | 346 +++++++++++----------
5 files changed, 180 insertions(+), 177 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c42ab2f..f9ebe35 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -64,6 +64,7 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
### Changed
- Refactored the Traffic Ops Go client internals so that all public methods
have a consistent behavior/implementation
- Pinned external actions used by Documentation Build and TR Unit Tests
workflows to commit SHA-1 and the Docker image used by the Weasel workflow to a
SHA-256 digest
+- Updated the Traffic Ops Python client to 3.0
- Updated Flot libraries to supported versions
- [apache/trafficcontrol](https://github.com/apache/trafficcontrol) is now a
Go module
- Set Traffic Router to only accept TLSv1.1, TLSv1.2, and TLSv1.3 protocols by
default in server.xml
diff --git a/infrastructure/cdn-in-a-box/ort/traffic_ops_ort/to_api.py
b/infrastructure/cdn-in-a-box/ort/traffic_ops_ort/to_api.py
index 8b6cdb3..973d777 100644
--- a/infrastructure/cdn-in-a-box/ort/traffic_ops_ort/to_api.py
+++ b/infrastructure/cdn-in-a-box/ort/traffic_ops_ort/to_api.py
@@ -44,9 +44,9 @@ class API(TOSession):
functionality for getting things needed by :term:`ORT`.
"""
- #: This should always be the latest API version supported - note this
breaks compatability with
+ #: This should always be the latest API version supported - note this
breaks compatibility with
#: older ATC versions. Go figure.
- VERSION = "2.0"
+ VERSION = "3.0"
def __init__(self, conf:Configuration):
"""
diff --git a/traffic_control/clients/python/to_access/__init__.py
b/traffic_control/clients/python/to_access/__init__.py
index 95a44fc..1be9a15 100644
--- a/traffic_control/clients/python/to_access/__init__.py
+++ b/traffic_control/clients/python/to_access/__init__.py
@@ -271,7 +271,7 @@ def parse_arguments(program):
help="Request exactly PATH; it won't be prefaced
with '/api/{{api-version}}/")
parser.add_argument("-a", "--api-version",
type=float,
- default=2.0,
+ default=3.0,
help="Specify the API version to request against")
parser.add_argument("-p", "--pretty",
action="store_true",
diff --git a/traffic_control/clients/python/trafficops/__version__.py
b/traffic_control/clients/python/trafficops/__version__.py
index b1dfe7d..ffea76c 100644
--- a/traffic_control/clients/python/trafficops/__version__.py
+++ b/traffic_control/clients/python/trafficops/__version__.py
@@ -21,10 +21,10 @@ gives the version of this *Apache-TrafficControl package*
and **not** the versio
client to grow in a version-controlled manner without being tied to the
release cadence of Apache
Traffic Control as a whole.
-Version 2.0 is supported for use with Apache Traffic Control versions 4.1 and
5.0 (release pending
+Version 3.0 is supported for use with Apache Traffic Control versions 5.0 and
5.1 (release pending
at the time of this writing). New functionality will be added as the
:ref:`to-api` evolves, but
changes to this client will remain non-breaking for existing code using it
until the next major
version is released.
"""
-__version__ = '2.0.2'
+__version__ = '3.0.0'
diff --git a/traffic_control/clients/python/trafficops/tosession.py
b/traffic_control/clients/python/trafficops/tosession.py
index 4e2bfb2..19b2528 100644
--- a/traffic_control/clients/python/trafficops/tosession.py
+++ b/traffic_control/clients/python/trafficops/tosession.py
@@ -60,7 +60,7 @@ class TOSession(RestApiSession):
.. code-block:: python3
:caption: Endpoint with no URL parameters and no query
parameters
- @api_request('get', 'cdns', ('2.0',))
+ @api_request('get', 'cdns', ('3.0',))
def get_cdns(self):
pass
@@ -68,7 +68,7 @@ class TOSession(RestApiSession):
.. code-block:: python3
:caption: End-point with URL parameters and no query parameters
- @api_request('get', 'cdns/{cdn_id:d}', ('2.0',))
+ @api_request('get', 'cdns/{cdn_id:d}', ('3.0',))
def get_cdn_by_id(self, cdn_id=None):
pass
@@ -76,28 +76,28 @@ class TOSession(RestApiSession):
.. code-block:: python3
:caption: End-point with no URL parameters but with query
parameters
- @api_request('get', 'deliveryservices', ('2.0',))
+ @api_request('get', 'deliveryservices', ('3.0',))
def get_deliveryservices(self, query_params=None):
pass
.. code-block:: python3
:caption: End-point with URL parameters and query parameters
- @api_request('get', 'deliveryservices/xmlId/{xml_id}/sslkeys',
('2.0',))
+ @api_request('get', 'deliveryservices/xmlId/{xml_id}/sslkeys',
('3.0',))
def get_deliveryservice_ssl_keys_by_xml_id(self, xml_id=None,
query_params=None):
pass
.. code-block:: python3
:caption: End-point with request data
- @api_request('post', 'cdns', ('2.0',))
+ @api_request('post', 'cdns', ('3.0',))
def create_cdn(self, data=None):
pass
.. code-block:: python3
:caption: End-point with URL parameters and request data
- @api_request('put', 'cdns', ('2.0',))
+ @api_request('put', 'cdns', ('3.0',))
def update_cdn_by_id(self, cdn_id=None, data=None):
pass
@@ -112,7 +112,7 @@ class TOSession(RestApiSession):
.. note:: Only a small subset of the API endpoints are implemented.
More can be implemented as needed.
"""
- def __init__(self, host_ip, host_port=443, api_version='2.0', ssl=True,
headers=None,
+ def __init__(self, host_ip, host_port=443, api_version='3.0', ssl=True,
headers=None,
verify_cert=True):
"""
The class initializer.
@@ -254,7 +254,7 @@ class TOSession(RestApiSession):
#
# API Capabilities
#
- @api_request('get', 'api_capabilities', ('2.0',))
+ @api_request('get', 'api_capabilities', ('3.0',))
def get_api_capabilities(self, query_params=None):
"""
Get all API-capability mappings
@@ -266,7 +266,7 @@ class TOSession(RestApiSession):
#
# ASN
#
- @api_request('get', 'asns', ('2.0',))
+ @api_request('get', 'asns', ('3.0',))
def get_asns(self, query_params=None):
"""
Get ASNs.
@@ -275,7 +275,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'asns', ('2.0',))
+ @api_request('post', 'asns', ('3.0',))
def create_asn(self, data=None):
"""
Create ASN
@@ -286,7 +286,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'asns', ('2.0',))
+ @api_request('put', 'asns', ('3.0',))
def update_asn(self, query_params=None):
"""
Update ASN
@@ -297,7 +297,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'asns', ('2.0',))
+ @api_request('delete', 'asns', ('3.0',))
def delete_asn(self, query_params=None):
"""
Delete ASN
@@ -311,7 +311,7 @@ class TOSession(RestApiSession):
#
# Cache Statistics
#
- @api_request('get', 'cache_stats', ('2.0',))
+ @api_request('get', 'cache_stats', ('3.0',))
def get_cache_stats(self, query_params=None):
"""
Retrieves statistics about the CDN.
@@ -322,7 +322,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'caches/stats', ('2.0',))
+ @api_request('get', 'caches/stats', ('3.0',))
def get_traffic_monitor_cache_stats(self):
"""
Retrieves cache stats from Traffic Monitor. Also includes rows
for aggregates
@@ -334,7 +334,7 @@ class TOSession(RestApiSession):
#
# Cache Groups
#
- @api_request('get', 'cachegroups', ('2.0',))
+ @api_request('get', 'cachegroups', ('3.0',))
def get_cachegroups(self, query_params=None):
"""
Get Cache Groups.
@@ -343,7 +343,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'cachegroups/{cache_group_id:d}/parameters',
('2.0',))
+ @api_request('get', 'cachegroups/{cache_group_id:d}/parameters',
('3.0',))
def get_cachegroup_parameters(self, cache_group_id=None):
"""
Get a cache groups parameters
@@ -354,7 +354,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'cachegroupparameters', ('2.0',))
+ @api_request('get', 'cachegroupparameters', ('3.0',))
def get_all_cachegroup_parameters(self):
"""
A collection of all cache group parameters.
@@ -363,7 +363,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'cachegroups', ('2.0',))
+ @api_request('post', 'cachegroups', ('3.0',))
def create_cachegroups(self, data=None):
"""
Create a Cache Group
@@ -374,7 +374,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'cachegroups/{cache_group_id:d}', ('2.0',))
+ @api_request('put', 'cachegroups/{cache_group_id:d}', ('3.0',))
def update_cachegroups(self, cache_group_id=None, data=None):
"""
Update a cache group
@@ -387,7 +387,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'cachegroups/{cache_group_id:d}', ('2.0',))
+ @api_request('delete', 'cachegroups/{cache_group_id:d}', ('3.0',))
def delete_cachegroups(self, cache_group_id=None):
"""
Delete a cache group
@@ -398,7 +398,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'cachegroups/{cache_group_id:d}/queue_update',
('2.0',))
+ @api_request('post', 'cachegroups/{cache_group_id:d}/queue_update',
('3.0',))
def cachegroups_queue_update(self, cache_group_id=None, data=None):
"""
Queue Updates by Cache Group ID
@@ -411,7 +411,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'cachegroupparameters/{cache_group_id:d}/{parameter_id:d}', ('2.0',))
+ @api_request('delete',
'cachegroupparameters/{cache_group_id:d}/{parameter_id:d}', ('3.0',))
def delete_cache_group_parameters(self, cache_group_id=None,
parameter_id=None):
"""
Delete a cache group parameter association
@@ -427,7 +427,7 @@ class TOSession(RestApiSession):
#
# Capabilities
#
- @api_request('get', 'capabilities', ('2.0',))
+ @api_request('get', 'capabilities', ('3.0',))
def get_capabilities(self, query_params=None):
"""
Retrieves capabilities
@@ -441,7 +441,7 @@ class TOSession(RestApiSession):
#
# CDN
#
- @api_request('get', 'cdns', ('2.0',))
+ @api_request('get', 'cdns', ('3.0',))
def get_cdns(self, query_params=None):
"""
Get all CDNs.
@@ -452,7 +452,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'cdns', ('2.0',))
+ @api_request('post', 'cdns', ('3.0',))
def create_cdn(self, data=None):
"""
Create a new CDN.
@@ -463,7 +463,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'cdns/{cdn_id:d}', ('2.0',))
+ @api_request('put', 'cdns/{cdn_id:d}', ('3.0',))
def update_cdn_by_id(self, cdn_id=None, data=None):
"""
Update a CDN by Id.
@@ -476,7 +476,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'cdns/{cdn_id:d}', ('2.0',))
+ @api_request('delete', 'cdns/{cdn_id:d}', ('3.0',))
def delete_cdn_by_id(self, cdn_id=None):
"""
Delete a CDN by Id.
@@ -487,7 +487,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'cdns/{cdn_id:d}/queue_update', ('2.0',))
+ @api_request('post', 'cdns/{cdn_id:d}/queue_update', ('3.0',))
def cdns_queue_update(self, cdn_id=None, data=None):
"""
Queue Updates by CDN Id.
@@ -503,7 +503,7 @@ class TOSession(RestApiSession):
#
# CDN Health/Usage
#
- @api_request('get', 'cdns/health', ('2.0',))
+ @api_request('get', 'cdns/health', ('3.0',))
def get_cdns_health(self):
"""
Retrieves the health of all locations (cache groups) for all
CDNs
@@ -513,7 +513,7 @@ class TOSession(RestApiSession):
"""
- @api_request('get', 'cdns/{cdn_name:s}/health', ('2.0',))
+ @api_request('get', 'cdns/{cdn_name:s}/health', ('3.0',))
def get_cdn_health_by_name(self, cdn_name=None):
"""
Retrieves the health of all locations (cache groups) for a
given CDN
@@ -524,7 +524,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'cdns/capacity', ('2.0',))
+ @api_request('get', 'cdns/capacity', ('3.0',))
def get_cdns_capacity(self):
"""
Retrieves the aggregate capacity percentages of all locations
(cache groups) for a given CDN.
@@ -536,7 +536,7 @@ class TOSession(RestApiSession):
#
# CDN Routing
#
- @api_request('get', 'cdns/routing', ('2.0',))
+ @api_request('get', 'cdns/routing', ('3.0',))
def get_cdns_routing(self):
"""
Retrieves the aggregate routing percentages of all locations
(cache groups) for a given CDN.
@@ -548,7 +548,7 @@ class TOSession(RestApiSession):
#
# CDN Domains
#
- @api_request('get', 'cdns/domains', ('2.0',))
+ @api_request('get', 'cdns/domains', ('3.0',))
def get_cdns_domains(self):
"""
Retrieves the different CDN domains
@@ -561,7 +561,7 @@ class TOSession(RestApiSession):
# CDN Topology
#
- @api_request('get', 'cdns/{cdn_name:s}/configs/monitoring', ('2.0',))
+ @api_request('get', 'cdns/{cdn_name:s}/configs/monitoring', ('3.0',))
def get_cdn_monitoring_info(self, cdn_name=None):
"""
Retrieves CDN monitoring information
@@ -575,7 +575,7 @@ class TOSession(RestApiSession):
#
# DNSSEC Keys
#
- @api_request('get', 'cdns/name/{cdn_name:s}/dnsseckeys', ('2.0',))
+ @api_request('get', 'cdns/name/{cdn_name:s}/dnsseckeys', ('3.0',))
def get_cdn_dns_sec_keys(self, cdn_name=None):
"""
Gets a list of dnsseckeys for a CDN and all associated Delivery
Services
@@ -586,7 +586,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'cdns/name/{cdn_name:s}/dnsseckeys', ('2.0',))
+ @api_request('delete', 'cdns/name/{cdn_name:s}/dnsseckeys', ('3.0',))
def delete_cdn_dns_sec_keys(self, cdn_name=None):
"""
Delete dnssec keys for a cdn and all associated delivery
services
@@ -597,7 +597,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'cnds/dnsseckeys/generate', ('2.0',))
+ @api_request('post', 'cnds/dnsseckeys/generate', ('3.0',))
def create_cdn_dns_sec_keys(self, data=None):
"""
Generates ZSK and KSK keypairs for a CDN and all associated
Delivery Services
@@ -611,7 +611,7 @@ class TOSession(RestApiSession):
#
# CDN SSL Keys
#
- @api_request('get', 'cdns/name/{cdn_name:s}/sslkeys', ('2.0',))
+ @api_request('get', 'cdns/name/{cdn_name:s}/sslkeys', ('3.0',))
def get_cdn_ssl_keys(self, cdn_name=None):
"""
Returns ssl certificates for all Delivery Services that are a
part of the CDN.
@@ -625,7 +625,7 @@ class TOSession(RestApiSession):
#
# Change Logs
#
- @api_request('get', 'logs', ('2.0',))
+ @api_request('get', 'logs', ('3.0',))
def get_change_logs(self, query_params=None):
"""
Retrieve all change logs from traffic ops
@@ -634,7 +634,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'logs/newcount', ('2.0',))
+ @api_request('get', 'logs/newcount', ('3.0',))
def get_change_logs_newcount(self):
"""
Get amount of new logs from traffic ops
@@ -646,7 +646,7 @@ class TOSession(RestApiSession):
#
# Delivery Service
#
- @api_request('get', 'deliveryservices', ('2.0',))
+ @api_request('get', 'deliveryservices', ('3.0',))
def get_deliveryservices(self, query_params=None):
"""
Retrieves all delivery services (if admin or ops) or all
delivery services assigned to user.
@@ -655,7 +655,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'deliveryservices', ('2.0',))
+ @api_request('post', 'deliveryservices', ('3.0',))
def create_deliveryservice(self, data=None):
"""
Allows user to create a delivery service.
@@ -666,7 +666,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'deliveryservices/{delivery_service_id:d}',
('2.0',))
+ @api_request('put', 'deliveryservices/{delivery_service_id:d}',
('3.0',))
def update_deliveryservice_by_id(self, delivery_service_id=None,
data=None):
"""
Update a Delivery Service by Id.
@@ -679,7 +679,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'deliveryservices/{delivery_service_id:d}/safe',
('2.0',))
+ @api_request('put', 'deliveryservices/{delivery_service_id:d}/safe',
('3.0',))
def update_deliveryservice_safe(self, delivery_service_id=None,
data=None):
"""
Allows a user to edit limited fields of a Delivery Service.
@@ -693,7 +693,7 @@ class TOSession(RestApiSession):
"""
- @api_request('delete', 'deliveryservices/{delivery_service_id:d}',
('2.0',))
+ @api_request('delete', 'deliveryservices/{delivery_service_id:d}',
('3.0',))
def delete_deliveryservice_by_id(self, delivery_service_id=None):
"""
Allows user to delete a delivery service.
@@ -707,7 +707,7 @@ class TOSession(RestApiSession):
#
# Delivery Service Health
#
- @api_request('get', 'deliveryservices/{delivery_service_id:d}/health',
('2.0',))
+ @api_request('get', 'deliveryservices/{delivery_service_id:d}/health',
('3.0',))
def get_delivery_service_health(self, delivery_service_id=None):
"""
Retrieves the health of all locations (cache groups) for a
delivery service. Delivery
@@ -719,7 +719,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get',
'deliveryservices/{delivery_service_id:d}/capacity', ('2.0',))
+ @api_request('get',
'deliveryservices/{delivery_service_id:d}/capacity', ('3.0',))
def get_delivery_service_capacity(self, delivery_service_id=None):
"""
Retrieves the capacity percentages of a delivery service.
Delivery service must be assigned
@@ -734,7 +734,7 @@ class TOSession(RestApiSession):
#
# Delivery Service Server
#
- @api_request('get', 'deliveryserviceserver', ('2.0',))
+ @api_request('get', 'deliveryserviceserver', ('3.0',))
def get_deliveryserviceserver(self, query_params=None):
"""
Retrieves delivery service / server assignments. (Allows
pagination and limits)
@@ -745,7 +745,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'deliveryserviceserver', ('2.0',))
+ @api_request('post', 'deliveryserviceserver', ('3.0',))
def assign_deliveryservice_servers_by_ids(self, data=None):
"""
Assign servers by id to a Delivery Service. (New Method)
@@ -756,7 +756,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'deliveryservices/{xml_id}/servers', ('2.0',))
+ @api_request('post', 'deliveryservices/{xml_id}/servers', ('3.0',))
def assign_deliveryservice_servers_by_names(self, xml_id=None,
data=None):
"""
Assign servers by name to a Delivery Service by xmlId.
@@ -769,7 +769,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'deliveryserviceserver/{delivery_service_id:d}/{server_id:d}',('2.0',))
+ @api_request('delete',
'deliveryserviceserver/{delivery_service_id:d}/{server_id:d}',('3.0',))
def delete_deliveryservice_servers_by_id(self,
delivery_service_id=None, server_id=None):
"""
Removes a server (cache) from a delivery service.
@@ -782,7 +782,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'deliveryservices/{delivery_service_id:d}/servers',
('2.0',))
+ @api_request('get', 'deliveryservices/{delivery_service_id:d}/servers',
('3.0',))
def get_deliveryservice_servers(self, delivery_service_id=None):
"""
Retrieves properties of CDN EDGE or ORG servers assigned to a
delivery service.
@@ -793,7 +793,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get',
'deliveryservices/{delivery_service_id:d}/servers/eligible', ('2.0',))
+ @api_request('get',
'deliveryservices/{delivery_service_id:d}/servers/eligible', ('3.0',))
def get_deliveryservice_ineligible_servers(self,
delivery_service_id=None):
"""
Retrieves properties of CDN EDGE or ORG servers not eligible
for assignment to a delivery
@@ -808,7 +808,7 @@ class TOSession(RestApiSession):
#
# Delivery Service SSL Keys
#
- @api_request('get', 'deliveryservices/xmlId/{xml_id}/sslkeys', ('2.0',))
+ @api_request('get', 'deliveryservices/xmlId/{xml_id}/sslkeys', ('3.0',))
def get_deliveryservice_ssl_keys_by_xml_id(self, xml_id=None,
query_params=None):
"""
Get SSL keys for a Delivery Service by xmlId.
@@ -821,7 +821,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'deliveryservices/xmlId/{xml_id}/sslkeys',
('2.0',))
+ @api_request('delete', 'deliveryservices/xmlId/{xml_id}/sslkeys',
('3.0',))
def delete_deliveryservice_ssl_keys_by_xml_id(self, xml_id=None,
query_params=None):
"""
Delete SSL keys for a Delivery Service by xmlId.
@@ -834,7 +834,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'deliveryservices/sslkeys/generate', ('2.0',))
+ @api_request('post', 'deliveryservices/sslkeys/generate', ('3.0',))
def generate_deliveryservice_ssl_keys(self, data=None):
"""
Generate an SSL certificate. (self-signed)
@@ -845,7 +845,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'deliveryservices/sslkeys/add', ('2.0',))
+ @api_request('post', 'deliveryservices/sslkeys/add', ('3.0',))
def add_ssl_keys_to_deliveryservice(self, data=None):
"""
Add SSL keys to a Delivery Service.
@@ -859,7 +859,7 @@ class TOSession(RestApiSession):
#
# Delivery Service URL Sig Keys
#
- @api_request('post',
'deliveryservices/xmlId/{xml_id}/urlkeys/generate', ('2.0',))
+ @api_request('post',
'deliveryservices/xmlId/{xml_id}/urlkeys/generate', ('3.0',))
def generate_deliveryservice_url_signature_keys(self, xml_id=None):
"""
Generate URL Signature Keys for a Delivery Service by xmlId.
@@ -873,7 +873,7 @@ class TOSession(RestApiSession):
#
# Delivery Service Regexes
#
- @api_request('get', 'deliveryservices_regexes', ('2.0',))
+ @api_request('get', 'deliveryservices_regexes', ('3.0',))
def get_deliveryservices_regexes(self):
"""
Get RegExes for all Delivery Services.
@@ -882,7 +882,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'deliveryservices/{delivery_service_id:d}/regexes',
('2.0',))
+ @api_request('get', 'deliveryservices/{delivery_service_id:d}/regexes',
('3.0',))
def get_deliveryservice_regexes_by_id(self, delivery_service_id=None,
query_params=None):
"""
Get RegExes for a Delivery Service by Id.
@@ -895,7 +895,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post',
'deliveryservices/{delivery_service_id:d}/regexes', ('2.0',))
+ @api_request('post',
'deliveryservices/{delivery_service_id:d}/regexes', ('3.0',))
def create_deliveryservice_regexes(self, delivery_service_id=None,
data=None):
"""
Create a regex for a delivery service
@@ -908,7 +908,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put',
'deliveryservices/{delivery_service_id:d}/regexes/{regex_id:d}', ('2.0',))
+ @api_request('put',
'deliveryservices/{delivery_service_id:d}/regexes/{regex_id:d}', ('3.0',))
def update_deliveryservice_regexes(self, delivery_service_id=None,
regex_id=None,
query_params=None):
"""
@@ -925,7 +925,7 @@ class TOSession(RestApiSession):
"""
@api_request('delete',
'deliveryservices/{delivery_service_id:d}/regexes/'
- '{delivery_service_regex_id:d}', ('2.0',))
+ '{delivery_service_regex_id:d}', ('3.0',))
def delete_deliveryservice_regex_by_regex_id(self,
delivery_service_id=None,
delivery_service_regex_id=None):
"""
@@ -942,7 +942,7 @@ class TOSession(RestApiSession):
#
# Delivery Service Statistics
#
- @api_request('get', 'deliveryservice_stats', ('2.0',))
+ @api_request('get', 'deliveryservice_stats', ('3.0',))
def get_delivery_service_stats(self, query_params=None):
"""
Retrieves statistics on the delivery services.
@@ -956,7 +956,7 @@ class TOSession(RestApiSession):
#
# Divisions
#
- @api_request('get', 'divisions', ('2.0',))
+ @api_request('get', 'divisions', ('3.0',))
def get_divisions(self, query_params=None):
"""
Get all divisions.
@@ -965,7 +965,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'divisions/{division_id:d}', ('2.0',))
+ @api_request('put', 'divisions/{division_id:d}', ('3.0',))
def update_division(self, division_id=None, query_params=None):
"""
Update a division by division id
@@ -978,7 +978,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'divisions', ('2.0',))
+ @api_request('post', 'divisions', ('3.0',))
def create_division(self, data=None):
"""
Create a division
@@ -989,7 +989,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'divisions/{division_id:d}', ('2.0',))
+ @api_request('delete', 'divisions/{division_id:d}', ('3.0',))
def delete_division(self, division_id=None, query_params=None):
"""
Delete a division by division id
@@ -1005,7 +1005,7 @@ class TOSession(RestApiSession):
#
# Federation
#
- @api_request('get', 'federations', ('2.0',))
+ @api_request('get', 'federations', ('3.0',))
def get_federations(self):
"""
Retrieves a list of federation mappings (aka federation
resolvers) for a the current user
@@ -1015,7 +1015,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'federations', ('2.0',))
+ @api_request('post', 'federations', ('3.0',))
def create_federation(self, data=None):
"""
Allows a user to add federations for their delivery service(s).
@@ -1027,7 +1027,7 @@ class TOSession(RestApiSession):
"""
- @api_request('get', 'cdns/{cdn_name:s}/federations', ('2.0',))
+ @api_request('get', 'cdns/{cdn_name:s}/federations', ('3.0',))
def get_federations_for_cdn(self, cdn_name=None, query_params=None):
"""
Retrieves a list of federations for a cdn.
@@ -1041,7 +1041,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'cdns/{cdn_name:s}/federations', ('2.0',))
+ @api_request('post', 'cdns/{cdn_name:s}/federations', ('3.0',))
def create_federation_in_cdn(self, cdn_name=None, data=None):
"""
Create a federation.
@@ -1052,7 +1052,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'cdns/{cdn_name:s}/federations/{federation_id:d}',
('2.0',))
+ @api_request('put', 'cdns/{cdn_name:s}/federations/{federation_id:d}',
('3.0',))
def update_federation_in_cdn(self, cdn_name=None, federation_id=None,
query_params=None):
"""
Update a federation.
@@ -1065,7 +1065,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'cdns/{cdn_name:s}/federations/{federation_id:d}', ('2.0',))
+ @api_request('delete',
'cdns/{cdn_name:s}/federations/{federation_id:d}', ('3.0',))
def delete_federation_in_cdn(self, cdn_name=None, federation_id=None):
"""
Delete a federation.
@@ -1081,7 +1081,7 @@ class TOSession(RestApiSession):
#
# Federation Delivery Service
#
- @api_request('get', 'federations/{federation_id:d}/deliveryservices',
('2.0',))
+ @api_request('get', 'federations/{federation_id:d}/deliveryservices',
('3.0',))
def get_federation_delivery_services(self, federation_id=None):
"""
Retrieves delivery services assigned to a federation
@@ -1095,7 +1095,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'federations/{federation_id:d}/deliveryservices',
('2.0',))
+ @api_request('post', 'federations/{federation_id:d}/deliveryservices',
('3.0',))
def assign_delivery_services_to_federations(self, federation_id=None,
data=None):
"""
Create one or more federation / delivery service assignments.
@@ -1111,7 +1111,7 @@ class TOSession(RestApiSession):
#
# Federation Federation Resolver
#
- @api_request('get',
'federations/{federation_id:d}/federation_resolvers', ('2.0',))
+ @api_request('get',
'federations/{federation_id:d}/federation_resolvers', ('3.0',))
def get_federation_resolvers_by_id(self, federation_id=None):
"""
:ref:`to-api-federations-id-federation_resolvers`
@@ -1123,7 +1123,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post',
'federations/{federation_id:d}/federation_resolvers', ('2.0',))
+ @api_request('post',
'federations/{federation_id:d}/federation_resolvers', ('3.0',))
def assign_federation_resolver_to_federations(self, federation_id=None,
data=None):
"""
Create one or more federation / federation resolver assignments.
@@ -1139,7 +1139,7 @@ class TOSession(RestApiSession):
#
# Federation Resolver
#
- @api_request('get', 'federation_resolvers', ('2.0',))
+ @api_request('get', 'federation_resolvers', ('3.0',))
def get_federation_resolvers(self, query_params=None):
"""
Get federation resolvers.
@@ -1149,7 +1149,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'federation_resolvers', ('2.0',))
+ @api_request('post', 'federation_resolvers', ('3.0',))
def create_federation_resolver(self, data=None):
"""
Create a federation resolver.
@@ -1159,7 +1159,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'federation_resolvers/{federation_resolver_id:d}', ('2.0',))
+ @api_request('delete',
'federation_resolvers/{federation_resolver_id:d}', ('3.0',))
def delete_federation_resolver(self, federation_resolver_id=None):
"""
Delete a federation resolver.
@@ -1172,7 +1172,7 @@ class TOSession(RestApiSession):
#
# Federation User
#
- @api_request('get', 'federations/{federation_id:d}/users', ('2.0',))
+ @api_request('get', 'federations/{federation_id:d}/users', ('3.0',))
def get_federation_users(self, federation_id=None):
"""
Retrieves users assigned to a federation.
@@ -1181,7 +1181,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'federations/{federation_id:d}/users', ('2.0',))
+ @api_request('post', 'federations/{federation_id:d}/users', ('3.0',))
def create_federation_user(self, federation_id=None, data=None):
"""
Create one or more federation / user assignments.
@@ -1194,7 +1194,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'federations/{federation_id:d}/users/{user_id:d}', ('2.0',))
+ @api_request('delete',
'federations/{federation_id:d}/users/{user_id:d}', ('3.0',))
def delete_federation_user(self, federation_id=None, user_id=None):
"""
Delete one or more federation / user assignments.
@@ -1210,7 +1210,7 @@ class TOSession(RestApiSession):
#
# ISO
#
- @api_request('get', 'osversions', ('2.0',))
+ @api_request('get', 'osversions', ('3.0',))
def get_osversions(self):
"""
Get all OS versions for ISO generation and the directory where
the kickstarter files are
@@ -1222,7 +1222,7 @@ class TOSession(RestApiSession):
"""
#TODO: this currently doesn't work, as /isos wasn't rewritten yet
- @api_request('post', 'isos', ('2.0',))
+ @api_request('post', 'isos', ('3.0',))
def generate_iso(self, data=None):
"""
Generate an ISO
@@ -1236,7 +1236,7 @@ class TOSession(RestApiSession):
#
# Jobs
#
- @api_request('get', 'jobs', ('2.0',))
+ @api_request('get', 'jobs', ('3.0',))
def get_jobs(self, query_params=None):
"""
Get all content-invalidation jobs (tenancy permitting).
@@ -1245,7 +1245,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'jobs', ('2.0',))
+ @api_request('post', 'jobs', ('3.0',))
def create_job(self, data=None):
"""
Creates a new content-invalidation job sorted by start time.
@@ -1256,7 +1256,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'jobs', ('2.0',))
+ @api_request('get', 'jobs', ('3.0',))
def update_job(self, data=None, query_params=None):
"""
Replaces a content-invalidation job with the one passed.
@@ -1268,7 +1268,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'jobs', ('2.0',))
+ @api_request('delete', 'jobs', ('3.0',))
def delete_job(self, query_params=None):
"""
Deletes a content-invalidation job.
@@ -1281,7 +1281,7 @@ class TOSession(RestApiSession):
#
# Parameter
#
- @api_request('get', 'parameters', ('2.0',))
+ @api_request('get', 'parameters', ('3.0',))
def get_parameters(self, query_params=None):
"""
Get all Parameters.
@@ -1290,7 +1290,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'profiles/{id:d}/parameters', ('2.0',))
+ @api_request('get', 'profiles/{id:d}/parameters', ('3.0',))
def get_parameters_by_profile_id(self, profile_id=None):
"""
Get all Parameters associated with a Profile by Id.
@@ -1301,7 +1301,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'profiles/name/{profile_name}/parameters', ('2.0',))
+ @api_request('get', 'profiles/name/{profile_name}/parameters', ('3.0',))
def get_parameters_by_profile_name(self, profile_name=None):
"""
Get all Parameters associated with a Profile by Name.
@@ -1312,7 +1312,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'parameters', ('2.0',))
+ @api_request('post', 'parameters', ('3.0',))
def create_parameter(self, data=None):
"""
Create Parameter
@@ -1323,7 +1323,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'parameters/{parameter_id:d}', ('2.0',))
+ @api_request('put', 'parameters/{parameter_id:d}', ('3.0',))
def update_parameter(self, parameter_id=None, query_params=None):
"""
Update Parameter
@@ -1335,7 +1335,7 @@ class TOSession(RestApiSession):
"""
- @api_request('delete', 'parameters/{parameter_id:d}', ('2.0',))
+ @api_request('delete', 'parameters/{parameter_id:d}', ('3.0',))
def delete_parameter(self, parameter_id=None):
"""
Delete Parameter
@@ -1349,7 +1349,7 @@ class TOSession(RestApiSession):
#
# Physical Location
#
- @api_request('get', 'phys_locations', ('2.0',))
+ @api_request('get', 'phys_locations', ('3.0',))
def get_physical_locations(self, query_params=None):
"""
Get Physical Locations.
@@ -1358,7 +1358,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'phys_locations/{physical_location_id:d}', ('2.0',))
+ @api_request('put', 'phys_locations/{physical_location_id:d}', ('3.0',))
def update_physical_location(self, physical_location_id=None,
query_params=None):
"""
Update Physical Location by id
@@ -1369,7 +1369,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'phys_locations/{physical_location_id:d}',
('2.0',))
+ @api_request('delete', 'phys_locations/{physical_location_id:d}',
('3.0',))
def delete_physical_location(self, physical_location_id=None,
query_params=None):
"""
Delete Physical Location by id
@@ -1383,7 +1383,7 @@ class TOSession(RestApiSession):
#
# Plugins
#
- @api_request('get', 'plugins', ('2.0',))
+ @api_request('get', 'plugins', ('3.0',))
def get_plugins(self):
"""
Retrieves the list of plugins.
@@ -1395,7 +1395,7 @@ class TOSession(RestApiSession):
#
# Profiles
#
- @api_request('get', 'profiles', ('2.0',))
+ @api_request('get', 'profiles', ('3.0',))
def get_profiles(self, query_params=None):
"""
Get Profiles.
@@ -1404,7 +1404,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'profiles', ('2.0',))
+ @api_request('post', 'profiles', ('3.0',))
def create_profile(self, data=None):
"""
Create a profile
@@ -1415,7 +1415,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post',
'profiles/name/{new_profile_name:s}/copy/{copy_profile_name:s}', ('2.0',))
+ @api_request('post',
'profiles/name/{new_profile_name:s}/copy/{copy_profile_name:s}', ('3.0',))
def copy_profile(self, new_profile_name=None, copy_profile_name=None,
data=None):
"""
Copy profile to a new profile. The new profile name must not
exist
@@ -1430,7 +1430,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'profiles/{profile_id:d}', ('2.0',))
+ @api_request('put', 'profiles/{profile_id:d}', ('3.0',))
def update_profile_by_id(self, profile_id=None, data=None):
"""
Update Profile by Id.
@@ -1443,7 +1443,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'profiles/{profile_id:d}', ('2.0',))
+ @api_request('delete', 'profiles/{profile_id:d}', ('3.0',))
def delete_profile_by_id(self, profile_id=None):
"""
Delete Profile by Id.
@@ -1457,7 +1457,7 @@ class TOSession(RestApiSession):
#
# Profile Parameters
#
- @api_request('post', 'profileparameters', ('2.0',))
+ @api_request('post', 'profileparameters', ('3.0',))
def associate_paramater_to_profile(self, data=None):
"""
Associate parameter to profile.
@@ -1467,7 +1467,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'profiles/{profile_id:d}/parameters', ('2.0',))
+ @api_request('post', 'profiles/{profile_id:d}/parameters', ('3.0',))
def associate_parameters_by_profile_id(self, profile_id=None,
data=None):
"""
Associate Parameters to a Profile by Id.
@@ -1480,7 +1480,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'profileparameter', ('2.0',))
+ @api_request('post', 'profileparameter', ('3.0',))
def assign_profile_to_parameter_ids(self, data=None):
"""
Create one or more profile / parameter assignments.
@@ -1491,7 +1491,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'parameterprofile', ('2.0',))
+ @api_request('post', 'parameterprofile', ('3.0',))
def assign_parameter_to_profile_ids(self, data=None):
"""
Create one or more parameter / profile assignments.
@@ -1503,7 +1503,7 @@ class TOSession(RestApiSession):
"""
- @api_request('post', 'profiles/name/{profile_name}/parameters',
('2.0',))
+ @api_request('post', 'profiles/name/{profile_name}/parameters',
('3.0',))
def associate_parameters_by_profile_name(self, profile_name=None,
data=None):
"""
Associate Parameters to a Profile by Name.
@@ -1516,7 +1516,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete',
'profileparameters/{profile_id:d}/{parameter_id:d}', ('2.0',))
+ @api_request('delete',
'profileparameters/{profile_id:d}/{parameter_id:d}', ('3.0',))
def delete_profile_parameter_association_by_id(self, profile_id=None,
parameter_id=None):
"""
Delete Parameter association by Id for a Profile by Id.
@@ -1532,7 +1532,7 @@ class TOSession(RestApiSession):
#
# Regions
#
- @api_request('get', 'regions', ('2.0',))
+ @api_request('get', 'regions', ('3.0',))
def get_regions(self, query_params=None):
"""
Get Regions.
@@ -1543,7 +1543,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'regions', ('2.0',))
+ @api_request('post', 'regions', ('3.0',))
def create_region(self, query_params=None, data=None):
"""
Create a region
@@ -1554,7 +1554,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'regions', ('2.0',))
+ @api_request('delete', 'regions', ('3.0',))
def delete_region(self, query_params=None):
"""
Delete a region by name or ID as a query parameter
@@ -1565,7 +1565,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'regions/{region_id:d}', ('2.0',))
+ @api_request('put', 'regions/{region_id:d}', ('3.0',))
def update_region(self, region_id=None):
"""
Update a region
@@ -1579,7 +1579,7 @@ class TOSession(RestApiSession):
#
# Roles
#
- @api_request('get', 'roles', ('2.0',))
+ @api_request('get', 'roles', ('3.0',))
def get_roles(self):
"""
Get Roles.
@@ -1588,7 +1588,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'roles', ('2.0',))
+ @api_request('post', 'roles', ('3.0',))
def create_role(self, data=None):
"""
Create a new Role.
@@ -1599,7 +1599,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'roles', ('2.0',))
+ @api_request('put', 'roles', ('3.0',))
def update_role(self, data=None, query_params=None):
"""
Get Roles.
@@ -1611,7 +1611,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'roles', ('2.0',))
+ @api_request('delete', 'roles', ('3.0',))
def delete_role(self, query_params=None):
"""
Delete a Role.
@@ -1623,7 +1623,7 @@ class TOSession(RestApiSession):
#
# Server
#
- @api_request('get', 'servers', ('2.0',))
+ @api_request('get', 'servers', ('3.0',))
def get_servers(self, query_params=None):
"""
Get Servers.
@@ -1634,7 +1634,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'servers/{server_id:d}/deliveryservices', ('2.0',))
+ @api_request('get', 'servers/{server_id:d}/deliveryservices', ('3.0',))
def get_server_delivery_services(self, server_id=None):
"""
Retrieves all delivery services assigned to the server
@@ -1645,7 +1645,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'servercheck', ('2.0',))
+ @api_request('post', 'servercheck', ('3.0',))
def create_servercheck(self, data=None):
"""
Post a server check result to the serverchecks table.
@@ -1656,7 +1656,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'servers', ('2.0',))
+ @api_request('post', 'servers', ('3.0',))
def create_server(self, data=None):
"""
Create a new Server.
@@ -1667,7 +1667,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'servers/{server_id:d}', ('2.0',))
+ @api_request('put', 'servers/{server_id:d}', ('3.0',))
def update_server_by_id(self, server_id=None, data=None):
"""
Update a Server by Id.
@@ -1679,7 +1679,7 @@ class TOSession(RestApiSession):
:rtype: Tuple[Union[Dict[str, Any], List[Dict[str, Any]]],
requests.Response]
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'servers/{server_id:d}/status', ('2.0',))
+ @api_request('put', 'servers/{server_id:d}/status', ('3.0',))
def update_server_status_by_id(self, server_id=None, data=None):
"""
Update server_status by Id.
@@ -1691,7 +1691,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'servers/{server_id:d}', ('2.0',))
+ @api_request('delete', 'servers/{server_id:d}', ('3.0',))
def delete_server_by_id(self, server_id=None):
"""
Delete a Server by Id.
@@ -1702,7 +1702,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'servers/{server_id:d}/queue_update', ('2.0',))
+ @api_request('post', 'servers/{server_id:d}/queue_update', ('3.0',))
def servers_queue_update(self, server_id=None, data=None):
"""
Queue Updates by Server Id.
@@ -1715,7 +1715,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'servers/{server_name}/update_status', ('2.0',))
+ @api_request('get', 'servers/{server_name}/update_status', ('3.0',))
def get_server_update_status(self, server_name=None):
"""
Gets the current update status of a server named
``server_name``.
@@ -1728,7 +1728,7 @@ class TOSession(RestApiSession):
#
# Static DNS Entries
#
- @api_request('get', 'staticdnsentries', ('2.0',))
+ @api_request('get', 'staticdnsentries', ('3.0',))
def get_staticdnsentries(self, query_params=None):
"""
Get static DNS entries associated with the delivery service
@@ -1739,7 +1739,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'staticdnsentries', ('2.0',))
+ @api_request('post', 'staticdnsentries', ('3.0',))
def create_staticdnsentries(self, data=None):
"""
Create static DNS entries associated with the delivery service
@@ -1750,7 +1750,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'staticdnsentries', ('2.0',))
+ @api_request('put', 'staticdnsentries', ('3.0',))
def update_staticdnsentries(self, data=None, query_params=None):
"""
Update static DNS entries associated with the delivery service
@@ -1763,7 +1763,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'staticdnsentries', ('2.0',))
+ @api_request('delete', 'staticdnsentries', ('3.0',))
def delete_staticdnsentries(self, query_params=None):
"""
Delete static DNS entries associated with the delivery service
@@ -1777,7 +1777,7 @@ class TOSession(RestApiSession):
#
# Status
#
- @api_request('get', 'statuses', ('2.0',))
+ @api_request('get', 'statuses', ('3.0',))
def get_statuses(self, query_params=None):
"""
Retrieves a list of the server status codes available.
@@ -1789,7 +1789,7 @@ class TOSession(RestApiSession):
#
# System
#
- @api_request('get', 'system/info', ('2.0',))
+ @api_request('get', 'system/info', ('3.0',))
def get_system_info(self):
"""
Get information on the traffic ops system.
@@ -1802,7 +1802,7 @@ class TOSession(RestApiSession):
#
# Tenants
#
- @api_request('get', 'tenants', ('2.0',))
+ @api_request('get', 'tenants', ('3.0',))
def get_tenants(self, query_params=None):
"""
Get all tenants.
@@ -1811,7 +1811,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'tenants/{tenant_id:d}', ('2.0',))
+ @api_request('put', 'tenants/{tenant_id:d}', ('3.0',))
def update_tenant(self, tenant_id=None):
"""
Update a tenant
@@ -1822,7 +1822,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'tenants', ('2.0',))
+ @api_request('post', 'tenants', ('3.0',))
def create_tenant(self, data=None):
"""
Create a tenant
@@ -1837,7 +1837,7 @@ class TOSession(RestApiSession):
#
# TO Extensions
#
- @api_request('get', 'servercheck/extensions', ('2.0',))
+ @api_request('get', 'servercheck/extensions', ('3.0',))
def get_servercheck_extensions(self):
"""
Retrieves the list of extensions.
@@ -1846,7 +1846,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'servercheck/extensions', ('2.0',))
+ @api_request('post', 'servercheck/extensions', ('3.0',))
def create_to_extension(self, data=None):
"""
Creates a Traffic Ops extension.
@@ -1857,7 +1857,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'servercheck/extensions/{extension_id:d}',
('2.0',))
+ @api_request('delete', 'servercheck/extensions/{extension_id:d}',
('3.0',))
def delete_to_extension(self, extension_id=None):
"""
Deletes a Traffic Ops extension.
@@ -1874,6 +1874,7 @@ class TOSession(RestApiSession):
@api_request('post', 'topologies', ('3.0',))
def create_topology(self, data: Dict[str, Any]=None) ->
Tuple[Union[Dict[str, Any], List[Dict[str, Any]]], Response]:
"""
+ Create a topology
:ref:`to-api-topologies`
:param data: The Topology data to use for Topology creation.
:type data: Dict[str, Any]
@@ -1882,45 +1883,46 @@ class TOSession(RestApiSession):
"""
@api_request('get', 'topologies', ('3.0',))
- def create_topology(self, data: Dict[str, Any]=None) ->
Tuple[Union[Dict[str, Any], List[Dict[str, Any]]], Response]:
+ def get_topologies(self, query_params: Dict[str, Any]=None) ->
Tuple[Union[Dict[str, Any], List[Dict[str, Any]]], Response]:
"""
- :ref:`to-api-topologies`
Get Topologies.
:ref:`to-api-topologies`
+ :param query_params: The optional url query parameters for the
call
+ :type query_params: Dict[str, Any]
:rtype: Tuple[Union[Dict[str, Any], List[Dict[str, Any]]],
Response]
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'topologies', ('3.0',))
- def update_topologies(self, data: Dict[str, Any]=None, query_params:
Dict[str, Any]=None) -> Tuple[Union[Dict[str, Any], List[Dict[str, Any]]],
Response]:
+ @api_request('put', 'topologies?name={name:s}', ('3.0',))
+ def update_topology(self, name: str=None, data: Dict[str, Any]=None) ->
Tuple[Union[Dict[str, Any], List[Dict[str, Any]]], Response]:
"""
Update a Topology
:ref:`to-api-topologies`
+ :param name: The name of the Topology
+ :type name: str
:param data: The new values for the Topology
:type data: Dict[str, Any]
- :type query: Dict[str, Any]
- :param query_params: 'id' is a required parameter, defining the
Topology to be replaced.
:rtype: Tuple[Union[Dict[str, Any], List[Dict[str, Any]]],
Response]
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'topologies', ('3.0',))
- def delete_topology(self, query_params: Dict[str, Any]=None) ->
Tuple[Union[Dict[str, Any], List[Dict[str, Any]]], Response]:
+ @api_request('delete', 'topologies?name={name:s}', ('3.0',))
+ def delete_topology(self, name: str=None) -> Tuple[Union[Dict[str,
Any], List[Dict[str, Any]]], Response]:
"""
Delete a Topology
:ref:`to-api-topologies`
- :param topology_id: The ID of the Topology to delete
- :type topology_id: int
+ :param name: The name of the Topology to delete
+ :type name: str
:rtype: Tuple[Union[Dict[str, Any], List[Dict[str, Any]]],
Response]
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'topologies/{topology_name:s}/queue_update',
('3.0',))
- def topologies_queue_update(self, topology_name=None, data=None):
+ @api_request('post', 'topologies/{name:s}/queue_update', ('3.0',))
+ def topologies_queue_update(self, name=None, data=None):
"""
Queue Updates by Topology name.
:ref:`to-api-topologies-name-queue_update`
- :param topology_name: The Topology name
+ :param name: The Topology name
:param data: The update action.
:type data: Dict[str, Any]
:rtype: Tuple[Dict[str, Any], requests.Response]
@@ -1931,7 +1933,7 @@ class TOSession(RestApiSession):
#
# Types
#
- @api_request('get', 'types', ('2.0',))
+ @api_request('get', 'types', ('3.0',))
def get_types(self, query_params=None):
"""
Get Data Types.
@@ -1943,7 +1945,7 @@ class TOSession(RestApiSession):
#
# Users
#
- @api_request('get', 'users', ('2.0',))
+ @api_request('get', 'users', ('3.0',))
def get_users(self):
"""
Retrieves all users.
@@ -1952,7 +1954,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'users/{user_id:d}', ('2.0',))
+ @api_request('get', 'users/{user_id:d}', ('3.0',))
def get_user_by_id(self, user_id=None):
"""
Retrieves user by ID.
@@ -1963,7 +1965,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'users', ('2.0',))
+ @api_request('post', 'users', ('3.0',))
def create_user(self, data=None):
"""
Create a user.
@@ -1974,7 +1976,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'users/{user_id:d}', ('2.0',))
+ @api_request('put', 'users/{user_id:d}', ('3.0',))
def update_user_by_id(self, user_id=None, data=None):
"""
Update a user.
@@ -1985,7 +1987,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'users/register', ('2.0',))
+ @api_request('post', 'users/register', ('3.0',))
def create_user_with_registration(self, data=None):
"""
Register a user and send registration email
@@ -1996,7 +1998,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'user/current', ('2.0',))
+ @api_request('get', 'user/current', ('3.0',))
def get_authenticated_user(self):
"""
Retrieves the profile for the authenticated user.
@@ -2005,7 +2007,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'user/current', ('2.0',))
+ @api_request('put', 'user/current', ('3.0',))
def replace_authenticated_user(self, data=None):
"""
Updates the currently authenticated user.
@@ -2019,7 +2021,7 @@ class TOSession(RestApiSession):
#
# Snapshot CRConfig
#
- @api_request('get', 'cdns/{cdn_name}/snapshot', ('2.0',))
+ @api_request('get', 'cdns/{cdn_name}/snapshot', ('3.0',))
def get_current_snapshot_crconfig(self, cdn_name=None):
"""
Retrieves the CURRENT snapshot for a CDN which doesn't
necessarily represent the current
@@ -2032,7 +2034,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('get', 'cdns/{cdn_name}/snapshot/new', ('2.0',))
+ @api_request('get', 'cdns/{cdn_name}/snapshot/new', ('3.0',))
def get_pending_snapshot_crconfig(self, cdn_name=None):
"""
Retrieves a PENDING snapshot for a CDN which represents the
current state of the CDN. The
@@ -2046,7 +2048,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'snapshot', ('2.0',))
+ @api_request('put', 'snapshot', ('3.0',))
def snapshot_crconfig(self, query_params=None):
"""
Snapshot CRConfig by CDN Name or ID.
@@ -2060,7 +2062,7 @@ class TOSession(RestApiSession):
#
# Coordinate
#
- @api_request('get', 'coordinates', ('2.0',))
+ @api_request('get', 'coordinates', ('3.0',))
def get_coordinates(self, query_params=None):
"""
Get all coordinates associated with the cdn
@@ -2071,7 +2073,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'coordinates', ('2.0',))
+ @api_request('post', 'coordinates', ('3.0',))
def create_coordinates(self, data=None):
"""
Create coordinates
@@ -2082,7 +2084,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'coordinates', ('2.0',))
+ @api_request('put', 'coordinates', ('3.0',))
def update_coordinates(self, query_params=None, data=None):
"""
Update coordinates
@@ -2095,7 +2097,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'coordinates', ('2.0',))
+ @api_request('delete', 'coordinates', ('3.0',))
def delete_coordinates(self, query_params=None):
"""
Delete coordinates
@@ -2109,7 +2111,7 @@ class TOSession(RestApiSession):
#
# Origin
#
- @api_request('get', 'origins', ('2.0',))
+ @api_request('get', 'origins', ('3.0',))
def get_origins(self, query_params=None):
"""
Get origins associated with the delivery service
@@ -2120,7 +2122,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('post', 'origins', ('2.0',))
+ @api_request('post', 'origins', ('3.0',))
def create_origins(self, data=None):
"""
Creates origins associated with a delivery service
@@ -2131,7 +2133,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('put', 'origins', ('2.0',))
+ @api_request('put', 'origins', ('3.0',))
def update_origins(self, query_params=None):
"""
Updates origins associated with a delivery service
@@ -2144,7 +2146,7 @@ class TOSession(RestApiSession):
:raises: Union[LoginError, OperationError]
"""
- @api_request('delete', 'origins', ('2.0',))
+ @api_request('delete', 'origins', ('3.0',))
def delete_origins(self, query_params=None):
"""
Updates origins associated with a delivery service
