rich1.0phorkiehttps://p.cweiske.de/Christian Weiske86400900900<!-- embedding all files of https://p.cweiske.de/969 --> <link rel="stylesheet" href="https://p.cweiske.de/css/embed.css"/> <div class="phork" id="969"> <div class="phork-file"> <div class="phork-content"> <div class="document"> <p>Atlassian's cloud products have REST APIs, but accessing them with tokens is a major pain - the base URL is different depending on the token type, and confluence API v2 documentation misses the API prefix.</p> <div class="section" id="scoped-vs-unscoped-tokens"> <h1>Scoped vs. unscoped tokens</h1> <p>Access tokens created via <a class="reference external" href="https://id.atlassian.com/manage-profile/security/api-tokens">https://id.atlassian.com/manage-profile/security/api-tokens</a> come in two flavors: scoped and unscoped.</p> <p>When using an unscoped token, you have to use <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/</span></tt> as API domain.</p> <p>Scoped tokens need a different domain and path: <tt class="docutils literal"><span class="pre">https://api.atlassian.com/ex/confluence/&lt;cloudid&gt;/</span></tt>. Cloud ID can be found at <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/_edge/tenant_info</span></tt>.</p> <p>Source: <a class="reference external" href="https://support.atlassian.com/confluence/kb/scoped-api-tokens-in-confluence-cloud">https://support.atlassian.com/confluence/kb/scoped-api-tokens-in-confluence-cloud</a></p> </div> <div class="section" id="rest-api-v1-vs-v2"> <h1>REST API v1 vs. v2</h1> <p>Links:</p> <ul class="simple"> <li>Confluence Spaces REST API v1: <a class="reference external" href="https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/">https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/</a></li> <li>Confluence Spaces REST API v2: <a class="reference external" href="https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/">https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/</a></li> </ul> <p>Documentation for v1 lists the whole path: <tt class="docutils literal">POST /wiki/rest/api/space</tt>. Just use the base URL + the path used here, e.g. <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/wiki/rest/api/space</span></tt>.</p> <p>Documentation for v2 misses some crucial bits, it only lists <tt class="docutils literal">GET /spaces</tt>. Appending that to the base URL will yield a 404. The solution is to put <tt class="docutils literal">/wiki/api/v2/</tt> between the base URL and the path given in the docs: <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/wiki/api/v2/spaces</span></tt>.</p> <ul class="simple"> <li>v1 path: <tt class="docutils literal">/wiki/rest/api/</tt></li> <li>v2 path: <tt class="docutils literal">/wiki/api/v2/</tt></li> </ul> <p>Passing tokens via HTTP Basic Auth is possible in REST API v1 <em>and</em> v2.</p> </div> <div class="section" id="spaces-api-example"> <h1>Spaces API example</h1> <ul class="simple"> <li>v1 + unscoped token: <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/wiki/rest/api/space</span></tt></li> <li>v1 + scoped token: <tt class="docutils literal"><span class="pre">https://api.atlassian.com/ex/confluence/&lt;cloudid&gt;/wiki/rest/api/space</span></tt></li> <li>v2 + unscoped token: <tt class="docutils literal"><span class="pre">https://customername.atlassian.net/wiki/api/v2/spaces</span></tt></li> <li>v2 + scoped token: <tt class="docutils literal"><span class="pre">https://api.atlassian.com/ex/confluence/&lt;cloudid&gt;/wiki/api/v2/spaces</span></tt></li> </ul> </div> </div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/969/rev-raw/aa66b403c47bc7f07f4281fe260f8a6b89d23c22/README.rst" style="float: right">view raw source</a> <a href="https://p.cweiske.de/969#README.rst">README.rst</a> </div> </div> </div>