Chore/update api paths (#379)

update api pathing to use new standard(api/v#/)

CHANGELOG.md

@@ -14,6 +14,10 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 - Removed method Get_alert_log(), method was no longer functional
 
+### Changed
+
+- updated URI paths to use new standardized versioning scheme
+
 ## 1.19.2 - 2021-10-19
 
 ### Fixed

docs/userguides/basics.md

@@ -45,7 +45,7 @@ import requests
 from requests.auth import HTTPBasicAuth
 def jwt_provider():
     res = requests.get(
-            'https://console.us.code42.com/c42api/v3/auth/jwt?useBody=true',
+            'https://console.us.code42.com/api/v3/auth/jwt?useBody=true',
             auth=HTTPBasicAuth('username', 'password')
           )
     res_json = json.loads(res.text)

src/py42/services/_auth.py

@@ -35,7 +35,7 @@ def __init__(self, auth_connection, totp=None):
         self._totp = totp if callable(totp) else lambda: totp
 
     def _get_credentials(self):
-        uri = "/c42api/v3/auth/jwt"
+        uri = "/api/v3/auth/jwt"
         params = {"useBody": True}
         current_token = self._totp()
         headers = {"totp-auth": str(current_token)} if current_token else None

src/py42/services/_connection.py

@@ -52,7 +52,7 @@ def get_host_address(self):
         return sts_url.replace("sts", self._prefix, 1)
 
     def _get_sts_base_url(self):
-        uri = "/api/ServerEnv"
+        uri = "/api/v1/ServerEnv"
         response = self._connection.get(uri)
 
         response_json = json_lib.loads(response.text)
@@ -84,7 +84,7 @@ def __init__(self, connection, device_guid):
 
     def get_host_address(self):
         response = self._connection.get(
-            "api/connectedServerUrl", params={"guid": self._device_guid}
+            "api/v1/connectedServerUrl", params={"guid": self._device_guid}
         )
         if response["serverUrl"] is None:
             raise Py42DeviceNotConnectedError(response, self._device_guid)

src/py42/services/administration.py

@@ -3,5 +3,5 @@
 
 class AdministrationService(BaseService):
     def get_current_tenant(self):
-        uri = "/c42api/v3/customer/my"
+        uri = "/api/v3/customer/my"
         return self._connection.get(uri)

src/py42/services/archive.py

@@ -5,7 +5,7 @@
 
 class ArchiveService(BaseService):
     def get_data_key_token(self, device_guid):
-        uri = "/api/DataKeyToken"
+        uri = "/api/v1/DataKeyToken"
         data = {"computerGuid": device_guid}
         return self._connection.post(uri, json=data)
 
@@ -18,7 +18,7 @@ def get_single_archive(self, archive_guid):
         Returns:
             :class:`py42.response.Py42Response`: A response containing archive information.
         """
-        uri = f"/api/Archive/{archive_guid}"
+        uri = f"/api/v1/Archive/{archive_guid}"
         return self._connection.get(uri)
 
     def get_page(self, page_num, page_size=None, **kwargs):
@@ -31,7 +31,7 @@ def get_page(self, page_num, page_size=None, **kwargs):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = "/api/Archive"
+        uri = "/api/v1/Archive"
         page_size = page_size or settings.items_per_page
         params = dict(pgNum=page_num, pgSize=page_size, **kwargs)
         return self._connection.get(uri, params=params)
@@ -52,7 +52,7 @@ def get_all_archives_from_value(self, id_value, id_type):
         return get_all_pages(self.get_page, "archives", **params)
 
     def get_backup_sets(self, device_guid, destination_guid):
-        uri = f"/c42api/v3/BackupSets/{device_guid}/{destination_guid}"
+        uri = f"/api/v3/BackupSets/{device_guid}/{destination_guid}"
         return self._connection.get(uri)
 
     def get_all_restore_history(self, days, id_type, id_value, **kwargs):
@@ -68,13 +68,13 @@ def get_all_restore_history(self, days, id_type, id_value, **kwargs):
     def _get_restore_history_page(
         self, days, id_type, id_value, page_num, page_size, **kwargs
     ):
-        uri = "/api/RestoreHistory"
+        uri = "/api/v1/RestoreHistory"
         params = dict(days=days, pgNum=page_num, pgSize=page_size, **kwargs)
         params[id_type] = id_value
         return self._connection.get(uri, params=params)
 
     def get_web_restore_info(self, src_guid, dest_guid):
-        uri = "/api/WebRestoreInfo"
+        uri = "/api/v1/WebRestoreInfo"
         params = {"srcGuid": src_guid, "destGuid": dest_guid}
         return self._connection.get(uri, params=params)
 
@@ -87,7 +87,7 @@ def _get_cold_storage_archives_page(
         page_size=None,
         page_num=None,
     ):
-        uri = "/api/ColdStorage"
+        uri = "/api/v1/ColdStorage"
         params = {
             "orgId": org_id,
             "incChildOrgs": include_child_orgs,
@@ -116,7 +116,7 @@ def get_all_org_cold_storage_archives(
         )
 
     def update_cold_storage_purge_date(self, archive_guid, purge_date):
-        uri = f"/api/coldStorage/{archive_guid}"
+        uri = f"/api/v1/coldStorage/{archive_guid}"
         params = {"idType": "guid"}
         data = {"archiveHoldExpireDate": purge_date}
         return self._connection.put(uri, params=params, json=data)

src/py42/services/devices.py

@@ -56,7 +56,7 @@ def get_page(
             :class:`py42.response.Py42Response`
         """
 
-        uri = "/api/Computer"
+        uri = "/api/v1/Computer"
         page_size = page_size or settings.items_per_page
         params = {
             "active": active,
@@ -145,7 +145,7 @@ def get_by_id(self, device_id, include_backup_usage=None, **kwargs):
         Returns:
             :class:`py42.response.Py42Response`: A response containing device information.
         """
-        uri = f"/api/Computer/{device_id}"
+        uri = f"/api/v1/Computer/{device_id}"
         params = dict(incBackupUsage=include_backup_usage, **kwargs)
         return self._connection.get(uri, params=params)
 
@@ -160,7 +160,7 @@ def get_by_guid(self, guid, include_backup_usage=None, **kwargs):
         Returns:
             :class:`py42.response.Py42Response`: A response containing device information.
         """
-        uri = f"/api/Computer/{guid}"
+        uri = f"/api/v1/Computer/{guid}"
         params = dict(idType="guid", incBackupUsage=include_backup_usage, **kwargs)
         return self._connection.get(uri, params=params)
 
@@ -174,7 +174,7 @@ def block(self, device_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/ComputerBlock/{device_id}"
+        uri = f"/api/v1/ComputerBlock/{device_id}"
         return self._connection.put(uri)
 
     def unblock(self, device_id):
@@ -186,7 +186,7 @@ def unblock(self, device_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/ComputerBlock/{device_id}"
+        uri = f"/api/v1/ComputerBlock/{device_id}"
         return self._connection.delete(uri)
 
     def deactivate(self, device_id):
@@ -229,7 +229,7 @@ def deauthorize(self, device_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/ComputerDeauthorization/{device_id}"
+        uri = f"/api/v1/ComputerDeauthorization/{device_id}"
         return self._connection.put(uri)
 
     def get_agent_state(self, guid, property_name):
@@ -280,7 +280,7 @@ def update_settings(self, device_settings):
         """
         device_settings = dict(device_settings)
         device_id = device_settings["computerId"]
-        uri = f"/api/Computer/{device_id}"
+        uri = f"/api/v1/Computer/{device_id}"
         new_config_date_ms = str(int(time() * 1000))
         device_settings["settings"]["configDateMs"] = new_config_date_ms
         return self._connection.put(uri, json=device_settings)

src/py42/services/legalhold.py

@@ -61,7 +61,7 @@ def create_matter(
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = "/api/LegalHold"
+        uri = "/api/v1/LegalHold"
         data = {
             "name": name,
             "holdPolicyUid": hold_policy_uid,
@@ -102,7 +102,7 @@ def get_matter_by_uid(self, legal_hold_uid):
         Returns:
             :class:`py42.response.Py42Response`: A response containing the Matter.
         """
-        uri = f"/api/LegalHold/{legal_hold_uid}"
+        uri = f"/api/v1/LegalHold/{legal_hold_uid}"
         try:
             return self._connection.get(uri)
         except Py42ForbiddenError as err:
@@ -139,7 +139,7 @@ def get_matters_page(
 
         active_state = _active_state_map(active)
         page_size = page_size or settings.items_per_page
-        uri = "/api/LegalHold"
+        uri = "/api/v1/LegalHold"
         params = {
             "creatorUserUid": creator_user_uid,
             "activeState": active_state,
@@ -224,7 +224,7 @@ def get_custodians_page(
             "pgNum": page_num,
             "pgSize": page_size,
         }
-        uri = "/api/LegalHoldMembership"
+        uri = "/api/v1/LegalHoldMembership"
         try:
             return self._connection.get(uri, params=params)
         except Py42BadRequestError as ex:
@@ -347,7 +347,7 @@ def add_to_matter(self, user_uid, legal_hold_uid):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = "/api/LegalHoldMembership"
+        uri = "/api/v1/LegalHoldMembership"
         data = {"legalHoldUid": legal_hold_uid, "userUid": user_uid}
         try:
             return self._connection.post(uri, json=data)
@@ -370,7 +370,7 @@ def remove_from_matter(self, legal_hold_membership_uid):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = "/api/LegalHoldMembershipDeactivation"
+        uri = "/api/v1/LegalHoldMembershipDeactivation"
         data = {"legalHoldMembershipUid": legal_hold_membership_uid}
         return self._connection.post(uri, json=data)
 
@@ -396,5 +396,5 @@ def reactivate_matter(self, legal_hold_uid):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/LegalHoldReactivation/{legal_hold_uid}"
+        uri = f"/api/v1/LegalHoldReactivation/{legal_hold_uid}"
         return self._connection.put(uri)

src/py42/services/orgs.py

@@ -33,7 +33,7 @@ def create_org(self, org_name, org_ext_ref=None, notes=None, parent_org_uid=None
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = "/api/Org/"
+        uri = "/api/v1/Org/"
         data = {
             "orgName": org_name,
             "orgExtRef": org_ext_ref,
@@ -51,7 +51,7 @@ def get_by_id(self, org_id, **kwargs):
         Returns:
             :class:`py42.response.Py42Response`: A response containing the organization.
         """
-        uri = f"/api/Org/{org_id}"
+        uri = f"/api/v1/Org/{org_id}"
         return self._connection.get(uri, params=kwargs)
 
     def get_by_uid(self, org_uid, **kwargs):
@@ -63,7 +63,7 @@ def get_by_uid(self, org_uid, **kwargs):
         Returns:
             :class:`py42.response.Py42Response`: A response containing the organization.
         """
-        uri = f"/api/Org/{org_uid}"
+        uri = f"/api/v1/Org/{org_uid}"
         params = dict(idType="orgUid", **kwargs)
         return self._connection.get(uri, params=params)
 
@@ -80,7 +80,7 @@ def get_page(self, page_num, page_size=None, **kwargs):
             :class:`py42.response.Py42Response`
         """
         page_size = page_size or settings.items_per_page
-        uri = "/api/Org"
+        uri = "/api/v1/Org"
         params = dict(pgNum=page_num, pgSize=page_size, **kwargs)
         return self._connection.get(uri, params=params)
 
@@ -105,7 +105,7 @@ def block(self, org_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/OrgBlock/{org_id}"
+        uri = f"/api/v1/OrgBlock/{org_id}"
         return self._connection.put(uri)
 
     def unblock(self, org_id):
@@ -118,7 +118,7 @@ def unblock(self, org_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/OrgBlock/{org_id}"
+        uri = f"/api/v1/OrgBlock/{org_id}"
         return self._connection.delete(uri)
 
     def deactivate(self, org_id):
@@ -131,7 +131,7 @@ def deactivate(self, org_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/OrgDeactivation/{org_id}"
+        uri = f"/api/v1/OrgDeactivation/{org_id}"
         return self._connection.put(uri)
 
     def reactivate(self, org_id):
@@ -144,7 +144,7 @@ def reactivate(self, org_id):
         Returns:
             :class:`py42.response.Py42Response`
         """
-        uri = f"/api/OrgDeactivation/{org_id}"
+        uri = f"/api/v1/OrgDeactivation/{org_id}"
         return self._connection.delete(uri)
 
     def get_current(self, **kwargs):
@@ -154,7 +154,7 @@ def get_current(self, **kwargs):
             :class:`py42.response.Py42Response`: A response containing the organization for the
             currently signed-in user.
         """
-        uri = "/api/Org/my"
+        uri = "/api/v1/Org/my"
         return self._connection.get(uri, params=kwargs)
 
     def get_agent_state(self, org_id, property_name):
@@ -221,7 +221,7 @@ def update_settings(self, org_settings):
                 org_settings_response = ex
 
         if org_settings.changes:
-            uri = f"/api/Org/{org_id}"
+            uri = f"/api/v1/Org/{org_id}"
             try:
                 org_response = self._connection.put(uri, json=org_settings.data)
             except Py42Error as ex:

src/py42/services/storage/_auth.py

@@ -41,7 +41,7 @@ def __init__(self, connection, user_id, device_guid, destination_guid):
         self._destination_guid = destination_guid
 
     def get_tmp_auth(self):
-        uri = "/api/LoginToken"
+        uri = "/api/v1/LoginToken"
         data = {
             "userId": self._user_id,
             "sourceGuid": self._device_guid,

src/py42/services/storage/preservationdata.py

@@ -3,7 +3,7 @@
 
 class StoragePreservationDataService(BaseService):
 
-    _base_uri = "c42api/v3/"
+    _base_uri = "api/v3/"
 
     def __init__(self, main_session, streaming_session):
         super().__init__(main_session)