<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/CLI.md - fork/chhoto-url @ unicode</title>
<meta name="description" content="docs/CLI.md in fork/chhoto-url at unicode.">
<meta property="og:title" content="docs/CLI.md - fork/chhoto-url @ unicode">
<meta property="og:description" content="docs/CLI.md in fork/chhoto-url at unicode.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="unicode" data-tip="82d990341772a1a355f33bfc992a3e69d7ae0726">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/chhoto-url</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/chhoto-url</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">SinTan1729</span><span class="commit-message" data-commit="a958f159bb83d9786fb2e070cce3db6942be7936">chg: &quot;nopass&quot; -&gt; &quot;nobody-nopass&quot;</span><span class="snapshot-sha sha" data-commit="a958f159bb83d9786fb2e070cce3db6942be7936">a958f15</span><time datetime="2026-09-23T15:34:08-05:00" title="2026-09-23 15:34:08 -0500">2026-09-23</time></p>
<header class="topbar"><details class="switcher"><summary>unicode</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/chhoto-url/ref/unicode/">unicode</a><a class="all" href="/fork/chhoto-url/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/chhoto-url/">chhoto-url</a> / <a href="/fork/chhoto-url/ref/unicode/tree/docs/">docs</a> / <span class="cur">CLI.md</span></nav>
<span class="view-stats"><span>9.1 KiB</span><span>305 lines</span></span><span class="actions"><a class="raw" href="/fork/chhoto-url/raw/fd099559d1096e1ac64000ff832f811a862ebff4/docs/CLI.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- SPDX-FileCopyrightText: 2023-2026 Sayantan Santra &lt;sayantan.santra689@gmail.com&gt; --&gt;
&lt;!-- SPDX-License-Identifier: MIT --&gt;
<h2>Official CLI App</h2>
<p>There's an official CLI app for Linux. It's maintained by me, even though I cannot promise to provide proper support. Take a look at it
<a href="https://github.com/SinTan1729/chhoto-url-cli">here</a>. The instructions below describe how to use all the features using <code>curl</code>.</p>
<h2>Instructions for CLI usage</h2>
<p>The application can be used from the terminal using something like <code>curl</code>. In all the examples
below, replace <code>http://localhost:4567</code> with where your instance of <code>chhoto-url</code> is accessible.</p>
<p>You can get the version of <code>chhoto-url</code> the server is running using <code>curl http://localhost:4567/api/version</code> and
get the siteurl using <code>curl http://localhost:4567/api/siteurl</code>. These routes are accessible without any authentication.</p>
<h3>API key validation</h3>
<p><strong>This is required for programs that rely on a JSON response from Chhoto URL.</strong></p>
<p>In order to use API key validation, set the <a href="/fork/chhoto-url/ref/unicode/blob/docs/INSTALLATION.md#chhoto_api_key"><code>CHHOTO_API_KEY</code></a> environment variable. If this is not set,
the API will default to cookie validation (see section above). If the API key is insecure, a warning will be outputted along with a generated
API key which may be used.</p>
<p><strong>All responses for requests using API key are JSON encoded.</strong></p>
<p>Example Linux command for generating a secure API key: <code>tr -dc A-Za-z0-9 &lt; /dev/urandom | head -c 128</code></p>
<p>For each response, the response code will be <code>200</code>, <code>401</code>, <code>400</code>, <code>500</code>, or <code>404</code>, depending on the context. The routes are as follows.</p>
<h2>Note</h2>
<p>Some of the requests/responses use <code>shorturl</code> and <code>longurl</code>, while some use <code>shortlink</code> and <code>longlink</code>. This is due to my own lack of
foresight while developing the initial API. I don't want to change it since it might break compatibility, and the issue isn't big enough to
make that worth it. So please be careful if you use the API.</p>
<h4><code>/api/new</code></h4>
<p>To add a link:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> POST \
    <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> \
    <a-co>-d</a-co> <a-s>&#39;{ \
        &quot;shortlink&quot;:&quot;&lt;shortlink&gt;&quot;, \
        &quot;longlink&quot;:&quot;&lt;longlink&gt;&quot;, \
        &quot;expiry_delay&quot;: &lt;expiry_delay&gt;, \
        &quot;notes&quot;: &quot;&lt;notes&gt;&quot; \
        }&#39;</a-s> \
    http://localhost:4567/api/new</pre>
<p>If <code>&lt;shortlink&gt;</code> is empty or omitted, one will be generated automatically.
The <code>&lt;expiry_delay&gt;</code> is specified in seconds. It is capped to a maximum of 5 years. A missing <code>&lt;expiry_delay&gt;</code> or a value of 0 will disable
expiry.</p>
<p>The server will reply in the following format.</p>
<pre class="language-json">{
    <a-s>&quot;success&quot;</a-s>: <a-co>true</a-co>,
    <a-s>&quot;error&quot;</a-s>: <a-co>false</a-co>,
    <a-s>&quot;shorturl&quot;</a-s>: <a-s>&quot;&lt;shortlink&gt;&quot;</a-s>,
    <a-s>&quot;expiry_time&quot;</a-s>: &lt;expiry_time&gt;
}</pre>
<p>or</p>
<pre class="language-json">{
  <a-s>&quot;success&quot;</a-s>: <a-co>false</a-co>,
  <a-s>&quot;error&quot;</a-s>: <a-co>true</a-co>,
  <a-s>&quot;reason&quot;</a-s>: <a-s>&quot;&lt;reason&gt;&quot;</a-s>
}</pre>
<p>Multiple links can be created in a single request by sending an array of objects like the example below.</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> POST \
    <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> \
    <a-co>-d</a-co> <a-s>&#39;[ \
            { \
                &quot;shortlink&quot;:&quot;&lt;shortlink1&gt;&quot;, \
                &quot;longlink&quot;:&quot;&lt;longlink1&gt;&quot;, \
                &quot;expiry_delay&quot;: &lt;expiry_delay1&gt;, \
                &quot;notes&quot;: &quot;&lt;notes1&gt;&quot; \
            }&#39;</a-s> \
        ,
            { \
                <a-s>&quot;shortlink&quot;</a-s><a-f>:</a-f><a-s>&quot;&lt;shortlink2&gt;&quot;</a-s><a-f>,</a-f> \
                <a-s>&quot;longlink&quot;</a-s>:<a-s>&quot;&lt;longlink2&gt;&quot;</a-s>, \
                <a-s>&quot;expiry_delay&quot;</a-s>: <a-o>&lt;</a-o>expiry_delay2<a-o>&gt;</a-o>, \
                <a-s>&quot;notes&quot;</a-s>: <a-s>&quot;&lt;notes2&gt;&quot;</a-s> \
          }&#39; \
        ...
        ...
        ] \
    http://localhost:4567/api/new</pre>
<p>In that case, the response is an array containing one
result per input object (in order), each in one of the formats shown above.</p>
<p>Except for malformed requests or internal server errors, the HTTP status code is always <code>200</code>. Clients must inspect the <code>success</code> field of
each response object to determine whether the operation succeeded.</p>
<h4><code>/api/getconfig</code></h4>
<p>To get the config for the backend:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> \
<a-co>-d</a-co> <a-s>&#39;&lt;shortlink&gt;&#39;</a-s> http://localhost:4567/api/getconfig</pre>
<p>(This would work without authentication in public mode.)<br />
The server will reply in the following format.</p>
<pre class="language-json">{
    <a-s>&quot;version&quot;</a-s>: <a-s>&quot;&lt;version&gt;&quot;</a-s>,
    <a-s>&quot;site_url&quot;</a-s>: <a-s>&quot;&lt;site_url&gt;&quot;</a-s>,
    <a-s>&quot;allow_capital_letters&quot;</a-s>: <a-co>true</a-co>/<a-co>false</a-co>,
    <a-s>&quot;public_mode&quot;</a-s>: <a-co>true</a-co>/<a-co>false</a-co>,
    <a-s>&quot;public_mode_expiry_delay&quot;</a-s>: <a-s>&quot;&lt;delay&gt;&quot;</a-s>,
    <a-s>&quot;slug_style&quot;</a-s>: <a-s>&quot;&lt;style&gt;&quot;</a-s>,
    <a-s>&quot;slug_length&quot;</a-s>: <a-s>&quot;&lt;len&gt;&quot;</a-s>,
    <a-s>&quot;try_longer_slug&quot;</a-s>: <a-co>true</a-co>/<a-co>false</a-co>
}</pre>
<pre class="language-json">{
  <a-s>&quot;success&quot;</a-s>: <a-co>false</a-co>,
  <a-s>&quot;error&quot;</a-s>: <a-co>true</a-co>,
  <a-s>&quot;reason&quot;</a-s>: <a-s>&quot;&lt;reason&gt;&quot;</a-s>
}</pre>
<h4><code>/api/whoami</code></h4>
<p>To get the current user role:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> http://localhost:4567/api/whoami</pre>
<p>The server will reply with <code>admin</code> if admin access is granted, <code>public</code> if admin access is not granted but public mode is enabled,
<code>public-nopass</code> if public mode is enabled but no password is configured, <code>nobody-nopass</code> if no password is configured, and <code>nobody</code>
if no access is granted.</p>
<h4><code>/api/edit</code></h4>
<p>To edit an existing short link:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> PUT \
<a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> \
<a-co>-d</a-co> <a-s>&#39;{ \
    &quot;shortlink&quot;:&quot;&lt;shortlink&gt;&quot;, \
    &quot;longlink&quot;:&quot;&lt;longlink&gt;&quot;, \
    &quot;reset_hits&quot;: &lt;bool&gt;, \
    &quot;expiry_time&quot;: &lt;time&gt;, \
    &quot;notes&quot;: &lt;notes&gt; \
    }&#39;</a-s> \
http://localhost:4567/api/edit</pre>
<p>The fields <code>expiry_time</code> and <code>notes</code> are optional. The existing values will be kept in the database if nothing is provided.</p>
<p>The server will reply in the following format.</p>
<pre class="language-json">{
    <a-s>&quot;success&quot;</a-s>: <a-co>true</a-co>/<a-co>false</a-co>,
    <a-s>&quot;error&quot;</a-s>: <a-co>false</a-co>/<a-co>true</a-co>,
    <a-s>&quot;reason&quot;</a-s>: <a-s>&quot;&lt;reason&quot;</a-s>
}</pre>
<h4><code>/api/expand</code></h4>
<p>To get information about a single short link:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> \
<a-co>-d</a-co> <a-s>&#39;&lt;shortlink&gt;&#39;</a-s> http://localhost:4567/api/expand</pre>
<p>The server will reply in the following format.</p>
<pre class="language-json">{
    <a-s>&quot;success&quot;</a-s>: <a-co>true</a-co>,
    <a-s>&quot;error&quot;</a-s>: <a-co>false</a-co>,
    <a-s>&quot;longurl&quot;</a-s>: <a-s>&quot;&lt;longurl&gt;&quot;</a-s>,
    <a-s>&quot;hits&quot;</a-s>: <a-s>&quot;&lt;hits&gt;&quot;</a-s>,
    <a-s>&quot;expiry_time&quot;</a-s>: &lt;expiry_time&gt;,
    <a-s>&quot;notes&quot;</a-s>: <a-s>&quot;&lt;notes&gt;&quot;</a-s>
}</pre>
<p>Or,</p>
<pre class="language-json">{
  <a-s>&quot;success&quot;</a-s>: <a-co>false</a-co>,
  <a-s>&quot;error&quot;</a-s>: <a-co>true</a-co>,
  <a-s>&quot;reason&quot;</a-s>: <a-s>&quot;&lt;reason&gt;&quot;</a-s>
}</pre>
<p>(This route is not accessible using cookie validation.)</p>
<h4><code>/api/all?{params}</code></h4>
<p>To get a list of all the currently available links:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> http://localhost:4567/api/all</pre>
<p>Supported query parameters are as follows.</p>
<ol>
<li><code>page_after</code>: An offset where to start pagination after. It should be a valid shortlink, or an empty response will be received.
This is faster, and the preferred way of doing pagination.</li>
<li><code>page_size</code>: The size of a returned page in number of shortlinks. Default value is 10.</li>
<li><code>page_no</code>: Alternative way of doing pagination. This is slower, and should be used only when using <code>page_after</code> isn't viable.</li>
<li><code>filter</code>: For filtering links. The filter is applied on <code>shorturl</code>, <code>longurl</code>, and <code>notes</code> fields. Must be ASCII, and at least 3
characters long. Only alphanumeric characters are used for the filtering. Everything else is treated as a separator.</li>
</ol>
<p>None of the parameters are required. In absence of all of those, all shortlinks are returned. The entries should be positive integers.
If only <code>page_size</code> is provided, the first page is returned.</p>
<p>A successful reply would be an array and look like the following.</p>
<pre class="language-json">[
    ...
  {
    <a-s>&quot;shortlink&quot;</a-s>: <a-s>&quot;&lt;shortlink&gt;&quot;</a-s>,
    <a-s>&quot;longlink&quot;</a-s>: <a-s>&quot;&lt;longlink&gt;&quot;</a-s>,
    <a-s>&quot;hits&quot;</a-s>: &lt;hits&gt;,
    <a-s>&quot;expiry_time&quot;</a-s>: &lt;expiry_time&gt;,
    <a-s>&quot;notes&quot;</a-s>: <a-s>&quot;&lt;notes&gt;&quot;</a-s>
  },
    ...
]</pre>
<h4><code>/api/del/{shortlink}</code></h4>
<p>To delete a link:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> DELETE <a-co>-H</a-co> <a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s> http://localhost:4567/api/del/<a-o>&lt;</a-o>shortlink<a-o>&gt;</a-o></pre>
<p>Where <code>&lt;shortlink&gt;</code> is name of the shortened link you would like to delete. For example, if the shortened link is
<code>http://localhost:4567/example</code>, <code>&lt;shortlink&gt;</code> would be <code>example</code>.</p>
<p>The server will output when the instance is accessed over API, when an incorrect API key is received, etc.</p>
<h3>Cookie validation</h3>
<p>If you have set up a password, first do the following to get an authentication cookie and store it in a file.</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> POST <a-co>-H</a-co> <a-s>&quot;Content-Type: application/json&quot;</a-s> <a-co>-d</a-co> <a-s>&#39;{&quot;password&quot;:&quot;&lt;your-password&gt;&quot;,&quot;remember&quot;: true}&#39;</a-s> \
<a-co>-c</a-co> cookie.txt http://localhost:4567/api/login</pre>
<p>Or,</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> POST <a-co>-d</a-co> <a-s>&quot;&lt;your-password&gt;&quot;</a-s> <a-co>-c</a-co> cookie.txt http://localhost:4567/api/login</pre>
<p>You should receive "Correct password!" if the provided password was correct. This will be remembered for 7 days.</p>
<p>For a temporary login session (15 minutes), use the following.</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-X</a-co> POST <a-co>-H</a-co> <a-s>&quot;Content-Type: application/json&quot;</a-s> <a-co>-d</a-co> <a-s>&#39;{&quot;password&quot;:&quot;&lt;your-password&gt;&quot;,&quot;remember&quot;: false}&#39;</a-s> \
<a-co>-c</a-co> cookie.txt http://localhost:4567/api/login</pre>
<p>For any subsequent request, please add <code>-b cookie.txt</code> to provide authentication. Unless specified, all API methods should work
with cookies.</p>
<h2>Disable authentication</h2>
<p>If you do not define a <a href="/fork/chhoto-url/ref/unicode/blob/docs/INSTALLATION.md#chhoto_password"><code>CHHOTO_PASSWORD</code></a> environment variable when starting the docker
image, authentication will be disabled.</p>
<p>This if not recommended in actual use however, as it will allow anyone to create new links and delete
old ones. This might not seem like a bad idea, until you have hundreds of links pointing to illegal content.
Since there are no logs, it's impossible to prove that those links aren't created by you.</p>
<h2>Healthcheck</h2>
<p>There's a special unauthenticated healthcheck route listening to <code>127.0.0.1:1729/healthz</code> (so not accessible by the public).
When accessed, it would either return <code>healthy</code> or <code>unhealthy</code>. Look at the <a href="/fork/chhoto-url/ref/unicode/tree/deploy/">deployment examples</a> to see how to use it for healthchecks.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- SPDX-FileCopyrightText: 2023-2026 Sayantan Santra &lt;sayantan.santra689@gmail.com&gt; --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-c>&lt;!-- SPDX-License-Identifier: MIT --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>##</a-p> <a-tt>Official CLI App</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">There&#39;s an official CLI app for Linux. It&#39;s maintained by me, even though I cannot promise to provide proper support. Take a look at it</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">[here](https://github.com/SinTan1729/chhoto-url-cli). The instructions below describe how to use all the features using `curl`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>##</a-p> <a-tt>Instructions for CLI usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">The application can be used from the terminal using something like `curl`. In all the examples</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">below, replace `http://localhost:4567` with where your instance of `chhoto-url` is accessible.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">You can get the version of `chhoto-url` the server is running using `curl http://localhost:4567/api/version` and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">get the siteurl using `curl http://localhost:4567/api/siteurl`. These routes are accessible without any authentication.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>###</a-p> <a-tt>API key validation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">**This is required for programs that rely on a JSON response from Chhoto URL.**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">In order to use API key validation, set the [`CHHOTO_API_KEY`](./INSTALLATION.md#chhoto_api_key) environment variable. If this is not set,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">the API will default to cookie validation (see section above). If the API key is insecure, a warning will be outputted along with a generated</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">API key which may be used.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">**All responses for requests using API key are JSON encoded.**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">Example Linux command for generating a secure API key: `tr -dc A-Za-z0-9 &lt; /dev/urandom | head -c 128`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">For each response, the response code will be `200`, `401`, `400`, `500`, or `404`, depending on the context. The routes are as follows.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>##</a-p> <a-tt>Note</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">Some of the requests/responses use `shorturl` and `longurl`, while some use `shortlink` and `longlink`. This is due to my own lack of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">foresight while developing the initial API. I don&#39;t want to change it since it might break compatibility, and the issue isn&#39;t big enough to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">make that worth it. So please be careful if you use the API.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>####</a-p> <a-tt>`/api/new`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">To add a link:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> POST \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>    </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>    </a-p><a-co>-d</a-co><a-p> </a-p><a-s>&#39;{ \</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>        &quot;shortlink&quot;:&quot;&lt;shortlink&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>        &quot;longlink&quot;:&quot;&lt;longlink&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>        &quot;expiry_delay&quot;: &lt;expiry_delay&gt;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>        &quot;notes&quot;: &quot;&lt;notes&gt;&quot; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>        }&#39; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>    http://localhost:4567/api/new</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>If `&lt;shortlink&gt;` is empty or omitted, one will be generated automatically.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>The `&lt;expiry_delay&gt;` is specified in seconds. It is capped to a maximum of 5 years. A missing `&lt;expiry_delay&gt;` or a value of 0 will disable</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>expiry.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>The server will reply in the following format.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>    </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    </a-p><a-s>&quot;shorturl&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;shortlink&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>    </a-p><a-s>&quot;expiry_time&quot;</a-s><a-p>: &lt;expiry_time&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>  </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>  </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>  </a-p><a-s>&quot;reason&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;reason&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>Multiple links can be created in a single request by sending an array of objects like the example below.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> POST \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>    </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    </a-p><a-co>-d</a-co><a-p> </a-p><a-s>&#39;[ \</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>            { \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>                &quot;shortlink&quot;:&quot;&lt;shortlink1&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>                &quot;longlink&quot;:&quot;&lt;longlink1&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>                &quot;expiry_delay&quot;: &lt;expiry_delay1&gt;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>                &quot;notes&quot;: &quot;&lt;notes1&gt;&quot; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>            }&#39; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>        ,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>            { \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>                </a-p><a-s>&quot;shortlink&quot;</a-s><a-f>:</a-f><a-s>&quot;&lt;shortlink2&gt;&quot;</a-s><a-f>,</a-f><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>                </a-p><a-s>&quot;longlink&quot;</a-s><a-p>:</a-p><a-s>&quot;&lt;longlink2&gt;&quot;</a-s><a-p>, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>                </a-p><a-s>&quot;expiry_delay&quot;</a-s><a-p>: </a-p><a-o>&lt;</a-o><a-p>expiry_delay2</a-p><a-o>&gt;</a-o><a-p>, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>                </a-p><a-s>&quot;notes&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;notes2&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>          }&#39; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>        ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>        ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>        ] \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>    http://localhost:4567/api/new</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>In that case, the response is an array containing one</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>result per input object (in order), each in one of the formats shown above.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>Except for malformed requests or internal server errors, the HTTP status code is always `200`. Clients must inspect the `success` field of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>each response object to determine whether the operation succeeded.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/getconfig`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>To get the config for the backend:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>curl </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>-d </a-p><a-s>&#39;&lt;shortlink&gt;&#39;</a-s><a-p> http://localhost:4567/api/getconfig</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>(This would work without authentication in public mode.)  </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>The server will reply in the following format.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>    </a-p><a-s>&quot;version&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;version&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>    </a-p><a-s>&quot;site_url&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;site_url&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>    </a-p><a-s>&quot;allow_capital_letters&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>/</a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>    </a-p><a-s>&quot;public_mode&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>/</a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>    </a-p><a-s>&quot;public_mode_expiry_delay&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;delay&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>    </a-p><a-s>&quot;slug_style&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;style&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>    </a-p><a-s>&quot;slug_length&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;len&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>    </a-p><a-s>&quot;try_longer_slug&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>/</a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>  </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>  </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>  </a-p><a-s>&quot;reason&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;reason&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/whoami`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>To get the current user role:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>curl </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> http://localhost:4567/api/whoami</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>The server will reply with `admin` if admin access is granted, `public` if admin access is not granted but public mode is enabled,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>`public-nopass` if public mode is enabled but no password is configured, `nobody-nopass` if no password is configured, and `nobody`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>if no access is granted.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/edit`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>To edit an existing short link:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> PUT \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>-H </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>-d </a-p><a-s>&#39;{ \</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>    &quot;shortlink&quot;:&quot;&lt;shortlink&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>    &quot;longlink&quot;:&quot;&lt;longlink&gt;&quot;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>    &quot;reset_hits&quot;: &lt;bool&gt;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>    &quot;expiry_time&quot;: &lt;time&gt;, \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>    &quot;notes&quot;: &lt;notes&gt; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>    }&#39; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>http://localhost:4567/api/edit</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>The fields `expiry_time` and `notes` are optional. The existing values will be kept in the database if nothing is provided.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>The server will reply in the following format.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>    </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>/</a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>    </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>/</a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>    </a-p><a-s>&quot;reason&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;reason&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/expand`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>To get information about a single short link:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>curl </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>-d </a-p><a-s>&#39;&lt;shortlink&gt;&#39;</a-s><a-p> http://localhost:4567/api/expand</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"><a-p>The server will reply in the following format.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"><a-p>    </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"><a-p>    </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p>    </a-p><a-s>&quot;longurl&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;longurl&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>    </a-p><a-s>&quot;hits&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;hits&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"><a-p>    </a-p><a-s>&quot;expiry_time&quot;</a-s><a-p>: &lt;expiry_time&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>    </a-p><a-s>&quot;notes&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;notes&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"><a-p>Or,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"><a-p>  </a-p><a-s>&quot;success&quot;</a-s><a-p>: </a-p><a-co>false</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"><a-p>  </a-p><a-s>&quot;error&quot;</a-s><a-p>: </a-p><a-co>true</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"><a-p>  </a-p><a-s>&quot;reason&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;reason&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"><a-p>(This route is not accessible using cookie validation.)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/all?{params}`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"><a-p>To get a list of all the currently available links:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"><a-p>curl </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> http://localhost:4567/api/all</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"><a-p>Supported query parameters are as follows.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>1. `page_after`: An offset where to start pagination after. It should be a valid shortlink, or an empty response will be received.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"><a-p>   This is faster, and the preferred way of doing pagination.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text"><a-p>1. `page_size`: The size of a returned page in number of shortlinks. Default value is 10.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text"><a-p>1. `page_no`: Alternative way of doing pagination. This is slower, and should be used only when using `page_after` isn&#39;t viable.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"><a-p>1. `filter`: For filtering links. The filter is applied on `shorturl`, `longurl`, and `notes` fields. Must be ASCII, and at least 3</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"><a-p>   characters long. Only alphanumeric characters are used for the filtering. Everything else is treated as a separator.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"><a-p>None of the parameters are required. In absence of all of those, all shortlinks are returned. The entries should be positive integers.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text"><a-p>If only `page_size` is provided, the first page is returned.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>A successful reply would be an array and look like the following.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"><a-p>[</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><a-p>    ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"><a-p>  {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p>    </a-p><a-s>&quot;shortlink&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;shortlink&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"><a-p>    </a-p><a-s>&quot;longlink&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;longlink&gt;&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>    </a-p><a-s>&quot;hits&quot;</a-s><a-p>: &lt;hits&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"><a-p>    </a-p><a-s>&quot;expiry_time&quot;</a-s><a-p>: &lt;expiry_time&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"><a-p>    </a-p><a-s>&quot;notes&quot;</a-s><a-p>: </a-p><a-s>&quot;&lt;notes&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"><a-p>  },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"><a-p>    ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"><a-p>#### </a-p><a-tt>`/api/del/{shortlink}`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"><a-p>To delete a link:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> DELETE </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;X-API-Key: &lt;YOUR_API_KEY&gt;&quot;</a-s><a-p> http://localhost:4567/api/del/</a-p><a-o>&lt;</a-o><a-p>shortlink</a-p><a-o>&gt;</a-o></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"><a-p>Where `&lt;shortlink&gt;` is name of the shortened link you would like to delete. For example, if the shortened link is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"><a-p>`http://localhost:4567/example`, `&lt;shortlink&gt;` would be `example`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"><a-p>The server will output when the instance is accessed over API, when an incorrect API key is received, etc.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"><a-p>### </a-p><a-tt>Cookie validation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"><a-p>If you have set up a password, first do the following to get an authentication cookie and store it in a file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> POST </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;Content-Type: application/json&quot;</a-s><a-p> </a-p><a-co>-d</a-co><a-p> </a-p><a-s>&#39;{&quot;password&quot;:&quot;&lt;your-password&gt;&quot;,&quot;remember&quot;: true}&#39;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"><a-p>-c cookie.txt http://localhost:4567/api/login</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p>Or,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> POST </a-p><a-co>-d</a-co><a-p> </a-p><a-s>&quot;&lt;your-password&gt;&quot;</a-s><a-p> </a-p><a-co>-c</a-co><a-p> cookie.txt http://localhost:4567/api/login</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"><a-p>You should receive &quot;Correct password!&quot; if the provided password was correct. This will be remembered for 7 days.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"><a-p>For a temporary login session (15 minutes), use the following.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"><a-p>curl </a-p><a-co>-X</a-co><a-p> POST </a-p><a-co>-H</a-co><a-p> </a-p><a-s>&quot;Content-Type: application/json&quot;</a-s><a-p> </a-p><a-co>-d</a-co><a-p> </a-p><a-s>&#39;{&quot;password&quot;:&quot;&lt;your-password&gt;&quot;,&quot;remember&quot;: false}&#39;</a-s><a-p> \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"><a-p>-c cookie.txt http://localhost:4567/api/login</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"><a-p>For any subsequent request, please add `-b cookie.txt` to provide authentication. Unless specified, all API methods should work</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-p>with cookies.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text"><a-p>## </a-p><a-tt>Disable authentication</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-p>If you do not define a [`CHHOTO_PASSWORD`](./INSTALLATION.md#chhoto_password) environment variable when starting the docker</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"><a-p>image, authentication will be disabled.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"><a-p>This if not recommended in actual use however, as it will allow anyone to create new links and delete</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p>old ones. This might not seem like a bad idea, until you have hundreds of links pointing to illegal content.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"><a-p>Since there are no logs, it&#39;s impossible to prove that those links aren&#39;t created by you.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text"><a-p>## </a-p><a-tt>Healthcheck</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text">There&#39;s a special unauthenticated healthcheck route listening to `127.0.0.1:1729/healthz` (so not accessible by the public).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text">When accessed, it would either return `healthy` or `unhealthy`. Look at the [deployment examples](../deploy) to see how to use it for healthchecks.</span></span></pre></div></div>
</main>
</body>
</html>
