PENG-7708-python-sdk-zoneexport

examples/zone-export.py

@@ -0,0 +1,25 @@
+#
+# Copyright (c) 2025 NSONE, Inc.
+#
+# License under The MIT License (MIT). See LICENSE in project root.
+#
+
+from ns1 import NS1
+
+# NS1 will use config in ~/.nsone by default
+api = NS1()
+
+# to specify an apikey here instead, use:
+# api = NS1(apiKey='<<CLEARTEXT API KEY>>')
+
+# to load an alternate configuration file:
+# api = NS1(configFile='/etc/ns1/api.json')
+
+# export a zone to BIND format
+zone = api.loadZone("example.com")
+zone_file = zone.export()
+print(zone_file)
+
+# save to a file
+with open("example.com.zone", "w") as f:
+    f.write(zone_file)

ns1/rest/zones.py

@@ -188,6 +188,49 @@ def delete_version(self, zone, version_id, callback=None, errback=None):
             errback=errback,
         )
 
+    def export(self, zone, callback=None, errback=None):
+        """
+        Export zone as BIND-compatible zone file.
+
+        :param str zone: zone name
+        :return: zone file content as string
+        """
+        return self._make_request(
+            "GET",
+            f"{self.ROOT}/{zone}/export",
+            callback=callback,
+            errback=errback,
+        )
+
+    def initiate_export(self, zone, callback=None, errback=None):
+        """
+        Initiate zone export job.
+
+        :param str zone: zone name
+        :return: export status response
+        """
+        return self._make_request(
+            "PUT",
+            f"export/zonefile/{zone}",
+            body={},
+            callback=callback,
+            errback=errback,
+        )
+
+    def export_status(self, zone, callback=None, errback=None):
+        """
+        Check zone export status.
+
+        :param str zone: zone name
+        :return: export status response
+        """
+        return self._make_request(
+            "GET",
+            f"export/zonefile/{zone}/status",
+            callback=callback,
+            errback=errback,
+        )
+
 
 # successive pages just extend the list of zones
 def zone_list_pagination(curr_json, next_json):

ns1/zones.py

@@ -287,3 +287,37 @@ def usage(self, callback=None, errback=None, **kwargs):
         return stats.usage(
             zone=self.zone, callback=callback, errback=errback, **kwargs
         )
+
+    def export(self, callback=None, errback=None):
+        """
+        Export zone as a BIND-compatible zone file.
+
+        :param callback: optional callback
+        :param errback: optional error callback
+        :return: zone file content as string
+        """
+        return self._rest.export(self.zone, callback=callback, errback=errback)
+
+    def initiate_export(self, callback=None, errback=None):
+        """
+        Initiate zone export job.
+
+        :param callback: optional callback
+        :param errback: optional error callback
+        :return: export status response
+        """
+        return self._rest.initiate_export(
+            self.zone, callback=callback, errback=errback
+        )
+
+    def export_status(self, callback=None, errback=None):
+        """
+        Check zone export status.
+
+        :param callback: optional callback
+        :param errback: optional error callback
+        :return: export status response
+        """
+        return self._rest.export_status(
+            self.zone, callback=callback, errback=errback
+        )

tests/unit/test_zone.py

@@ -251,3 +251,49 @@ def test_rest_zone_buildbody(zones_config):
         "tags": {"foo": "bar", "hai": "bai"},
     }
     assert z._buildBody(zone, **kwargs) == body
+
+
+@pytest.mark.parametrize(
+    "zone, url", [("test.zone", "zones/test.zone/export")]
+)
+def test_rest_zone_export(zones_config, zone, url):
+    z = ns1.rest.zones.Zones(zones_config)
+    z._make_request = mock.MagicMock()
+    z.export(zone)
+    z._make_request.assert_called_once_with(
+        "GET",
+        url,
+        callback=None,
+        errback=None,
+    )
+
+
+@pytest.mark.parametrize(
+    "zone, url", [("test.zone", "export/zonefile/test.zone")]
+)
+def test_rest_zone_initiate_export(zones_config, zone, url):
+    z = ns1.rest.zones.Zones(zones_config)
+    z._make_request = mock.MagicMock()
+    z.initiate_export(zone)
+    z._make_request.assert_called_once_with(
+        "PUT",
+        url,
+        body={},
+        callback=None,
+        errback=None,
+    )
+
+
+@pytest.mark.parametrize(
+    "zone, url", [("test.zone", "export/zonefile/test.zone/status")]
+)
+def test_rest_zone_export_status(zones_config, zone, url):
+    z = ns1.rest.zones.Zones(zones_config)
+    z._make_request = mock.MagicMock()
+    z.export_status(zone)
+    z._make_request.assert_called_once_with(
+        "GET",
+        url,
+        callback=None,
+        errback=None,
+    )