Update docs.vt links

VirusTotal · Nov 20, 2023 · d0fedb2 · d0fedb2
1 parent d44c39a
commit d0fedb2
Show file tree

Hide file tree

Showing 16 changed files with 110 additions and 111 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,10 @@
 ![GitHub](https://img.shields.io/github/license/VirusTotal/vt-py)
 ![GitHub issues](https://img.shields.io/github/issues/VirusTotal/vt-py)
 
-
 # vt-py
 
 This is the official Python client library for VirusTotal. With this library
-you can interact with the [VirusTotal REST API v3](https://developers.virustotal.com/v3.0/reference)
+you can interact with the [VirusTotal REST API v3](https://docs.virustotal.com/reference/overview)
 and automate your workflow quickly and efficiently.
 
 ## Things you can do with vt-py

diff --git a/docs/_modules/vt/feed.html b/docs/_modules/vt/feed.html
@@ -9,23 +9,23 @@
   <!--[if lt IE 9]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
         <script src="../../_static/doctools.js"></script>
         <script src="../../_static/sphinx_highlight.js"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
-    <link rel="search" title="Search" href="../../search.html" /> 
+    <link rel="search" title="Search" href="../../search.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../../index.html" class="icon icon-home">
             vt-py
           </a>
@@ -68,7 +68,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <h1>Source code for vt.feed</h1><div class="highlight"><pre>
 <span></span><span class="ch">#!/usr/local/bin/python</span>
 <span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
@@ -116,7 +116,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Feed represents a stream of objects received from VirusTotal in real-time.</span>
 
 <span class="sd">  For more information about VirusTotal Feeds see:</span>
-<span class="sd">  https://developers.virustotal.com/v3.0/reference#feeds</span>
+<span class="sd">  https://docs.virustotal.com/reference/feeds</span>
 
 <span class="sd">  In the example below the loop iterates forever, retrieving file objects as</span>
 <span class="sd">  they are processed by VirusTotal. For a more elaborate example see the file</span>
@@ -255,7 +255,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -266,7 +266,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_modules/vt/iterator.html b/docs/_modules/vt/iterator.html
@@ -9,23 +9,23 @@
   <!--[if lt IE 9]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
         <script src="../../_static/doctools.js"></script>
         <script src="../../_static/sphinx_highlight.js"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
-    <link rel="search" title="Search" href="../../search.html" /> 
+    <link rel="search" title="Search" href="../../search.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../../index.html" class="icon icon-home">
             vt-py
           </a>
@@ -68,7 +68,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
 <span></span><span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
 <span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
@@ -98,14 +98,14 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
 <span class="sd">  Some endpoints in the VirusTotal API represent a collection of objects, for</span>
 <span class="sd">  example:</span>
 
-<span class="sd">  `/files/{id}/comments &lt;https://developers.virustotal.com/v3.0/reference#files-comments-get&gt;`_</span>
+<span class="sd">  `/files/{id}/comments &lt;https://docs.virustotal.com/reference/files-comments-get&gt;`_</span>
 
-<span class="sd">  `/intelligence/search &lt;https://developers.virustotal.com/v3.0/reference#intelligence-search&gt;`_</span>
+<span class="sd">  `/intelligence/search &lt;https://docs.virustotal.com/reference/intelligence-search&gt;`_</span>
 
 <span class="sd">  These collections can be iterated using an instance of this class.</span>
 
 <span class="sd">  Learn more about collections in the VirusTotal API in:</span>
-<span class="sd">  https://developers.virustotal.com/v3.0/reference#collections</span>
+<span class="sd">  https://docs.virustotal.com/reference/collections</span>
 
 <span class="sd">  The following example iterates over the most recent 200 comments, retrieving</span>
 <span class="sd">  them in batches of 20:</span>
@@ -253,7 +253,7 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -264,7 +264,7 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_modules/vt/object.html b/docs/_modules/vt/object.html
@@ -9,23 +9,23 @@
   <!--[if lt IE 9]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
         <script src="../../_static/doctools.js"></script>
         <script src="../../_static/sphinx_highlight.js"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
-    <link rel="search" title="Search" href="../../search.html" /> 
+    <link rel="search" title="Search" href="../../search.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../../index.html" class="icon icon-home">
             vt-py
           </a>
@@ -68,7 +68,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <h1>Source code for vt.object</h1><div class="highlight"><pre>
 <span></span><span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
 <span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
@@ -125,7 +125,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
 <span class="sd">  to :meth:`vt.Client.post_object`.</span>
 
 <span class="sd">  Learn more about objects in the VirusTotal API in:</span>
-<span class="sd">  https://developers.virustotal.com/v3.0/reference#objects</span>
+<span class="sd">  https://docs.virustotal.com/reference/objects</span>
 <span class="sd">  &quot;&quot;&quot;</span>
 
   <span class="c1"># Attributes from all object types that match any of the following names</span>
@@ -313,7 +313,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -324,7 +324,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -7,7 +7,7 @@ Welcome to vt-py's documentation!
 =================================
 
 `vt-py <https://github.com/VirusTotal/vt-py>`_ is the official Python client library
-for the `VirusTotal API v3 <https://developers.virustotal.com/v3.0/reference>`_.
+for the `VirusTotal API v3 <https://docs.virustotal.com/reference/overview>`_.
 
 This library requires Python 3.6.0+, Python 2.x is not supported. This is because vt-py
 makes use of the new `async/await <https://snarky.ca/how-the-heck-does-async-await-work-in-python-3-5/>`_

diff --git a/docs/_sources/overview.rst.txt b/docs/_sources/overview.rst.txt
@@ -3,9 +3,9 @@ Overview
 ********
 
 The API for this library is relatively small and shares the same concepts and
-principles seen in the underlying `REST API <https://developers.virustotal.com/v3.0/reference>`_.
+principles seen in the underlying `REST API <https://docs.virustotal.com/v3.0/reference>`_.
 For this reason we highly recommend you to familiarize yourself with these
-`concepts <https://developers.virustotal.com/v3.0/reference#key-concepts>`_ before
+`concepts <https://docs.virustotal.com/reference/key-concepts>`_ before
 continuing.
 
 While using this library you may have the impression that it's very similar to

diff --git a/docs/_sources/quickstart.rst.txt b/docs/_sources/quickstart.rst.txt
@@ -22,7 +22,7 @@ with some other SHA-256, SHA-1 or MD5:
 Now `file` is an instance of :class:`vt.Object` that contains information
 about the requested file. This object have the attributes returned in the
 API response which are listed in the `VirusTotal API v3 documentation
-<https://developers.virustotal.com/v3.0/reference#files>`_. Some examples:
+<https://docs.virustotal.com/reference/files>`_. Some examples:
 
 >>> file.size
 68
@@ -66,7 +66,7 @@ While retrieving a file any of its hashes can be used as the file identifier,
 but with URLs is a bit more complicated. You must use :func:`vt.url_id` for
 generating the appropriate identifier. You can find more information about why
 this is necessary in:
-`<https://developers.virustotal.com/v3.0/reference#url>`_.
+`<https://docs.virustotal.com/reference/url>`_.
 
 Also notice how we are using a placeholder `{}` in the path. The placeholder
 will be replaced with the value of `url_id`. This works exactly like Python's
@@ -187,7 +187,7 @@ Let's abort the job:
 
 Here we are using :meth:`vt.Client.post` instead of :meth:`vt.Client.post_object`,
 this is because the `/intelligence/retrohunt_jobs/{id}/abort
-<https://developers.virustotal.com/v3.0/reference#abort-retrohunt-job>`_
+<https://docs.virustotal.com/reference/abort-retrohunt-job>`_
 endpoint doesn't expect an object, just a POST request with an empty body. The
 result from :meth:`vt.Client.post` is a :class:`vt.ClientResponse` instance.
 

diff --git a/docs/api/feed.html b/docs/api/feed.html
@@ -10,25 +10,25 @@
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/doctools.js"></script>
         <script src="../_static/sphinx_highlight.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Object" href="object.html" />
-    <link rel="prev" title="Client" href="client.html" /> 
+    <link rel="prev" title="Client" href="client.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
 
-          
-          
+
+
           <a href="../index.html" class="icon icon-home">
             vt-py
           </a>
@@ -79,7 +79,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="feed">
 <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading"></a></h1>
 <div class="admonition note">
@@ -92,7 +92,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">vt.</span></span><span class="sig-name descname"><span class="pre">Feed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feed_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vt/feed.html#Feed"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Feed represents a stream of objects received from VirusTotal in real-time.</p>
 <p>For more information about VirusTotal Feeds see:
-<a class="reference external" href="https://developers.virustotal.com/v3.0/reference#feeds">https://developers.virustotal.com/v3.0/reference#feeds</a></p>
+<a class="reference external" href="https://docs.virustotal.com/reference/feeds">https://docs.virustotal.com/reference/feeds</a></p>
 <p>In the example below the loop iterates forever, retrieving file objects as
 they are processed by VirusTotal. For a more elaborate example see the file
 examples/file_feed.py in this repository.</p>
@@ -153,7 +153,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
+
 
 </footer>
         </div>
@@ -164,7 +164,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>