mirror of
https://github.com/LogicLabs-OU/OpenArchiver.git
synced 2026-04-06 00:31:57 +02:00
40 lines
88 KiB
HTML
40 lines
88 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>API Keys | Open Archiver Docs</title>
|
||
<meta name="description" content="Official documentation for the Open Archiver project.">
|
||
<meta name="generator" content="VitePress v1.6.4">
|
||
<link rel="preload stylesheet" href="/assets/style.BRVqMv4m.css" as="style">
|
||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/assets/app.Dfrf8uHm.js"></script>
|
||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/assets/chunks/theme.W2NStNbJ.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.DHqKNX4U.js">
|
||
<link rel="modulepreload" href="/assets/api_api-keys.md.Dn21HeSJ.lean.js">
|
||
<script defer src="https://analytics.openarchiver.com/script.js" data-website-id="2c8b452e-eab5-4f82-8ead-902d8f8b976f"></script>
|
||
<link rel="icon" href="/logo-sq.svg">
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-6d457d7f><!--[--><!--]--><!--[--><span tabindex="-1" data-v-9f15b6e6></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-9f15b6e6>Skip to content</a><!--]--><!----><header class="VPNav" data-v-6d457d7f data-v-06aeb22c><div class="VPNavBar" data-v-06aeb22c data-v-9f44cfca><div class="wrapper" data-v-9f44cfca><div class="container" data-v-9f44cfca><div class="title" data-v-9f44cfca><div class="VPNavBarTitle has-sidebar" data-v-9f44cfca data-v-cea99ba2><a class="title" href="/" data-v-cea99ba2><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo-sq.svg" alt data-v-384abc6c><!--]--><span data-v-cea99ba2>Open Archiver Docs</span><!--[--><!--]--></a></div></div><div class="content" data-v-9f44cfca><div class="content-body" data-v-9f44cfca><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9f44cfca><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9f44cfca data-v-bc890e2b><span id="main-nav-aria-label" class="visually-hidden" data-v-bc890e2b> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-bc890e2b data-v-358f64d2><!--[--><span data-v-358f64d2>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/LogicLabs-OU/OpenArchiver" target="_blank" rel="noreferrer" tabindex="0" data-v-bc890e2b data-v-358f64d2><!--[--><span data-v-358f64d2>Github</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://openarchiver.com/" target="_blank" rel="noreferrer" tabindex="0" data-v-bc890e2b data-v-358f64d2><!--[--><span data-v-358f64d2>Website</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://discord.gg/MTtD7BhuTQ" target="_blank" rel="noreferrer" tabindex="0" data-v-bc890e2b data-v-358f64d2><!--[--><span data-v-358f64d2>Discord</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9f44cfca data-v-1a8fd632><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-1a8fd632 data-v-77125d61 data-v-44c0c9c3><span class="check" data-v-44c0c9c3><span class="icon" data-v-44c0c9c3><!--[--><span class="vpi-sun sun" data-v-77125d61></span><span class="vpi-moon moon" data-v-77125d61></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-9f44cfca data-v-cb22ae83 data-v-ce17dc3c><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-ce17dc3c><span class="vpi-more-horizontal icon" data-v-ce17dc3c></span></button><div class="menu" data-v-ce17dc3c><div class="VPMenu" data-v-ce17dc3c data-v-a0929307><!----><!--[--><!--[--><!----><div class="group" data-v-cb22ae83><div class="item appearance" data-v-cb22ae83><p class="label" data-v-cb22ae83>Appearance</p><div class="appearance-action" data-v-cb22ae83><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-cb22ae83 data-v-77125d61 data-v-44c0c9c3><span class="check" data-v-44c0c9c3><span class="icon" data-v-44c0c9c3><!--[--><span class="vpi-sun sun" data-v-77125d61></span><span class="vpi-moon moon" data-v-77125d61></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9f44cfca data-v-42f375ed><span class="container" data-v-42f375ed><span class="top" data-v-42f375ed></span><span class="middle" data-v-42f375ed></span><span class="bottom" data-v-42f375ed></span></span></button></div></div></div></div><div class="divider" data-v-9f44cfca><div class="divider-line" data-v-9f44cfca></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-6d457d7f data-v-e17e33c6><div class="container" data-v-e17e33c6><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-e17e33c6><span class="vpi-align-left menu-icon" data-v-e17e33c6></span><span class="menu-text" data-v-e17e33c6>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-e17e33c6 data-v-bab32157><button data-v-bab32157>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-6d457d7f data-v-91b447a8><div class="curtain" data-v-91b447a8></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-91b447a8><span class="visually-hidden" id="sidebar-aria-label" data-v-91b447a8> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-6b998b36><section class="VPSidebarItem level-0" data-v-6b998b36 data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h2 class="text" data-v-5f79b55d>User Guides</h2><!----></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Get Started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/installation.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Installation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/integrity-check.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Email Integrity Check</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1 collapsible collapsed is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/" data-v-5f79b55d><!--[--><h3 class="text" data-v-5f79b55d>Email Providers</h3><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-5f79b55d><span class="vpi-chevron-right caret-icon" data-v-5f79b55d></span></div></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/imap.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Generic IMAP Server</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/google-workspace.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Google Workspace</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/microsoft-365.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Microsoft 365</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/eml.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>EML Import</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/pst.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>PST Import</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/email-providers/mbox.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Mbox Import</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1 collapsible collapsed" data-v-5f79b55d data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h3 class="text" data-v-5f79b55d>Settings</h3><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-5f79b55d><span class="vpi-chevron-right caret-icon" data-v-5f79b55d></span></div></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/settings/system.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>System</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1 collapsible collapsed" data-v-5f79b55d data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h3 class="text" data-v-5f79b55d>Upgrading and Migration</h3><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-5f79b55d><span class="vpi-chevron-right caret-icon" data-v-5f79b55d></span></div></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/upgrade-and-migration/upgrade.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Upgrading</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/user-guides/upgrade-and-migration/meilisearch-upgrade.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Meilisearch Upgrade</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="no-transition group" data-v-6b998b36><section class="VPSidebarItem level-0 has-active" data-v-6b998b36 data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h2 class="text" data-v-5f79b55d>API Reference</h2><!----></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/authentication.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Authentication</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/rate-limiting.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Rate Limiting</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/auth.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Auth</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/archived-email.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Archived Email</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/dashboard.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Dashboard</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/ingestion.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Ingestion</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/integrity.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Integrity Check</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/search.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Search</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/storage.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Storage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/upload.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Upload</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/jobs.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Jobs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/users.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Users</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/iam.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>IAM</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/api-keys.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>API Keys</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/api/settings.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Settings</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-6b998b36><section class="VPSidebarItem level-0" data-v-6b998b36 data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h2 class="text" data-v-5f79b55d>Services</h2><!----></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/services/" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/services/storage-service.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>Storage Service</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/services/ocr-service.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>OCR Service</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1" data-v-5f79b55d data-v-5f79b55d><div class="item" role="button" tabindex="0" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><h3 class="text" data-v-5f79b55d>IAM Service</h3><!----></div><div class="items" data-v-5f79b55d><!--[--><div class="VPSidebarItem level-2 is-link" data-v-5f79b55d data-v-5f79b55d><div class="item" data-v-5f79b55d><div class="indicator" data-v-5f79b55d></div><a class="VPLink link link" href="/services/iam-service/iam-policy.html" data-v-5f79b55d><!--[--><p class="text" data-v-5f79b55d>IAM Policies</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-6d457d7f data-v-413f3f32><div class="VPDoc has-sidebar" data-v-413f3f32 data-v-29334b8c><!--[--><!--]--><div class="container" data-v-29334b8c><!----><div class="content" data-v-29334b8c><div class="content-container" data-v-29334b8c><!--[--><!--]--><main class="main" data-v-29334b8c><div style="position:relative;" class="vp-doc _api_api-keys" data-v-29334b8c><div><h1 id="api-keys" tabindex="-1">API Keys <a class="header-anchor" href="#api-keys" aria-label="Permalink to "API Keys""></a></h1><p>Generate and manage API keys for programmatic access to the Open Archiver API. API keys are scoped to the user that created them and carry the same permissions as that user. The raw key value is only shown once at creation time.</p><h2 id="generate-an-api-key" tabindex="-1">Generate an API Key <a class="header-anchor" href="#generate-an-api-key" aria-label="Permalink to "Generate an API Key""></a></h2><!--[--><!--[--><div class="OAPath flex flex-col space-y-4"><!--[--><div class="flex flex-col"><div class="flex flex-row gap-2"><!--[--><!--]--></div><h1 id="generate-an-api-key" tabindex="-1" class="scroll-m-[var(--vp-nav-height)]"><!--[-->Generate an API key<!--]--><a class="header-anchor header-anchor" href="#generate-an-api-key" aria-label="Permalink to Generate an API key"></a></h1></div><!--]--><!----><div class="sm:grid-cols-2 relative grid grid-cols-1"><div class="OAPathContentStart flex flex-col"><div class="flex flex-col gap-4"><div class="sm:hidden"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--post px-2 py-1 rounded" data-v-ae22f171><!--[-->POST<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys</span></span></div></div></div><!--]--></div><!--[--><div class="OAMarkdown oa-doc"><p>Generates a new API key for the authenticated user. The raw key value is only returned once at creation time. The key name must be between 1–255 characters. Expiry is required and must be within 730 days (2 years). Disabled in demo mode.</p>
|
||
</div><!--]--></div><!--[--><!--[--><div class="flex flex-col"><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)]"><div class="flex flex-row items-center"><h2 id="authorizations" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0"><!--[-->Authorizations<!--]--><a class="header-anchor !top-0" href="#authorizations" aria-label="Permalink to Authorizations"></a></h2><span class="flex-grow min-w-2"></span></div></div><div class="flex flex-col gap-3"><!--[--><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class="border-gray-600 dark:border-gray-400"><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">bearerAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>JWT obtained from <code>POST /v1/auth/login</code>. Pass as <code>Authorization: Bearer <token></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">HTTP (bearer)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><div class="flex flex-row items-center space-x-2"><span class="text-sm font-bold">or</span><span class="flex-grow border-t border-[var(--vp-c-divider)]"></span></div></div><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class=""><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">apiKeyAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>API key generated via <code>POST /v1/api-keys</code>. Pass as <code>X-API-KEY: <key></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">API Key (header: X-API-KEY)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><!----></div><!--]--></div></div><!--]--><!--]--><!--[--><!----><!--]--><!--[--><!--[--><div><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)] flex flex-row items-center"><h2 id="request-body" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0 inline-block"><!--[-->Request Body<!--]--><a class="header-anchor !top-0" href="#request-body" aria-label="Permalink to Request Body"></a></h2><div class="relative flex-1"><div class="absolute inset-x-0 top-[-14px] w-full flex justify-end"><div><div class="ml-auto max-w-40 hover:max-w-full truncate transition-all duration-200 ease-in-out"><span class="h-6 text-xs rounded-md bg-muted px-3 py-1">application/json</span></div></div></div></div></div><div dir="ltr" data-orientation="horizontal" content-type="application/json"><!--[--><!--[--><div class="h-10 items-center rounded-md bg-muted p-1 text-muted-foreground relative flex flex-row justify-start overflow-x-auto" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-0-trigger-schema" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->Schema<!--]--><!--]--></button><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-0-trigger-examples.JSON" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->JSON<!--]--><!--]--></button><!--]--><!--]--><!--]--></div><div id="reka-tabs-v-0-content-schema" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-0-trigger-schema" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--[--><div id="reka-tabs-v-0-content-examples.JSON" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-0-trigger-examples.JSON" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col gap-2"><!----><div class="vp-adaptive-theme min-h-16 language-json !m-0"><button title="Copy Code" class="copy"></button><span class="lang">JSON</span><div class="vjs-tree p-2" style=""><!--[--><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><span class="vjs-carets vjs-carets-open"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="caret-down" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M840.4 300H183.6c-19.7 0-30.7 20.8-18.5 35l328.4 380.8c9.4 10.9 27.5 10.9 37 0L858.9 335c12.2-14.2 1.2-35-18.5-35z"></path></svg></span></div><!----><span><span class="vjs-tree-brackets">{</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"name"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"CI/CD Pipeline Key"</span><span>,</span><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"expiresInDays"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-number">90</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><!----></div><!----><span><span class="vjs-tree-brackets">}</span><!----><!----></span><!----></div></div><!--]--></div></div></div><!--]--><!--]--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--><!--[--><!--[--><div class="flex flex-col"><div dir="ltr" data-orientation="horizontal"><!--[--><!--[--><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)] flex flex-wrap flex-row items-center justify-between gap-y-[16px]"><h2 id="responses" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0 inline-block"><!--[-->Responses<!--]--><a class="header-anchor !top-0" href="#responses" aria-label="Permalink to Responses"></a></h2><div class="overflow-x-auto"><div class="w-full flex"><div class="inline-flex h-10 items-center justify-center rounded-md bg-transparent text-muted-foreground p-0" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><div class="relative flex flex-row"><!--[--><!--v-if--><!--[--><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-3-trigger-201" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->201<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-3-trigger-400" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->400<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-3-trigger-401" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->401<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-3-trigger-403" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->403<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-3-trigger-500" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->500<!--]--><!--]--></button><!--]--><!--]--><!----></div><!--]--><!--]--></div></div></div></div><!--[--><div id="reka-tabs-v-3-content-201" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-3-trigger-201" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col space-y-4"><div class="OAMarkdown oa-doc"><p>API key created. The raw <code>key</code> value is only shown once.</p>
|
||
</div><div class="flex flex-row items-center gap-2 text-xs"><label for="content-type-52qie" class="text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70 flex-shrink-0 text-muted-foreground"><!--[--><!--[-->Content-Type<!--]--><!--]--></label><div class="flex-shrink-0"><div><div class="ml-auto max-w-40 hover:max-w-full truncate transition-all duration-200 ease-in-out"><span class="h-6 text-xs rounded-md bg-muted px-3 py-1">application/json</span></div></div></div></div><div dir="ltr" data-orientation="horizontal" content-type="application/json"><!--[--><!--[--><div class="h-10 items-center rounded-md bg-muted p-1 text-muted-foreground relative flex flex-row justify-start overflow-x-auto" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-9-trigger-schema" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->Schema<!--]--><!--]--></button><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-9-trigger-examples.JSON" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->JSON<!--]--><!--]--></button><!--]--><!--]--><!--]--></div><div id="reka-tabs-v-9-content-schema" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-9-trigger-schema" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--[--><div id="reka-tabs-v-9-content-examples.JSON" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-9-trigger-examples.JSON" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col gap-2"><!----><div class="vp-adaptive-theme min-h-16 language-json !m-0"><button title="Copy Code" class="copy"></button><span class="lang">JSON</span><div class="vjs-tree p-2" style=""><!--[--><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><span class="vjs-carets vjs-carets-open"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="caret-down" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M840.4 300H183.6c-19.7 0-30.7 20.8-18.5 35l328.4 380.8c9.4 10.9 27.5 10.9 37 0L858.9 335c12.2-14.2 1.2-35-18.5-35z"></path></svg></span></div><!----><span><span class="vjs-tree-brackets">{</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"key"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"oa_live_abc123..."</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><!----></div><!----><span><span class="vjs-tree-brackets">}</span><!----><!----></span><!----></div></div><!--]--></div></div></div><!--]--><!--]--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--></div><div id="reka-tabs-v-3-content-400" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-3-trigger-400" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><div id="reka-tabs-v-3-content-401" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-3-trigger-401" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><div id="reka-tabs-v-3-content-403" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-3-trigger-403" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><div id="reka-tabs-v-3-content-500" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-3-trigger-500" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--></div><div class="flex flex-col"><div class="OAPathContentEnd sticky top-[100px] inset-x-0 flex flex-col"><div class="hidden sm:block sm:mb-2"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--post px-2 py-1 rounded" data-v-ae22f171><!--[-->POST<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys</span></span></div></div></div><!--]--></div><div><!--[--><div class="flex flex-col gap-2"><h2 id="playground" tabindex="-1" class="block sm:hidden"><!--[-->Playground<!--]--><a class="header-anchor header-anchor" href="#playground" aria-label="Permalink to Playground"></a></h2><div class="OAPlaygroundParameters" data-v-b7652c8b><!----><details open data-v-b7652c8b><summary data-v-b7652c8b>Authorization <div class="w-full max-w-[33%] md:max-w-[50%] ml-auto -mt-8" data-v-b7652c8b><!--[--><!--[--><!--[--><button class="flex w-full items-center justify-between rounded-md border border-input bg-muted text-sm ring-offset-background placeholder:text-muted-foreground focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 [&>span]:line-clamp-1 h-9 px-3 py-1.5 text-foreground font-normal" aria-label="Security Scheme" role="combobox" type="button" aria-controls="reka-select-content-v-12" aria-expanded="false" aria-required="false" aria-autocomplete="none" dir="ltr" data-state="closed" data-v-b7652c8b><!--[--><!--[--><span style="pointer-events:none;" data-placeholder="bearerAuth" data-v-b7652c8b><!--[-->bearerAuth<!--]--></span><!--]--><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" class="lucide w-4 h-4 opacity-50 lucide-chevron-down-icon lucide-chevron-down w-4 h-4 opacity-50"><path d="m6 9 6 6 6-6"></path></svg><!--]--></button><!--v-if--><!--]--><!--]--><select aria-hidden="true" tabindex="-1" style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);clip-path:inset(50%);white-space:nowrap;word-wrap:normal;top:-1px;left:-1px;" value="bearerAuth"><!--[--><!--]--></select><!--]--></div></summary><div class="flex flex-col gap-2" data-v-b7652c8b><!--[--><div class="flex flex-col" data-v-b7652c8b><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><label for="bearerAuth" class="peer-disabled:cursor-not-allowed peer-disabled:opacity-70 text-sm font-bold" data-v-b7652c8b><!--[--><!--[-->bearerAuth<!--]--><!--]--></label></div><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><div class="flex flex-col space-y-2 w-full" data-v-b7652c8b><div class="relative flex items-center w-full"><input id="bearerAuth" name="bearerAuth" placeholder="Token" type="text" class="flex h-10 w-full rounded-md border border-input px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 pr-8 bg-muted" value="Token"><button type="button" class="absolute right-2 text-muted-foreground hover:text-foreground focus:outline-none" tabindex="-1"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide h-4 w-4 lucide-x-icon lucide-x h-4 w-4" aria-hidden="true"><path d="M18 6 6 18"></path><path d="m6 6 12 12"></path></svg></button></div></div></div></div><!--]--></div></details><!----><!----><details open data-v-b7652c8b><summary data-v-b7652c8b>Body</summary><div data-v-b7652c8b><div class="bg-muted p-1 rounded"><!----></div></div></details></div><div class="flex flex-col gap-2"><button class="inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 bg-primary text-primary-foreground hover:bg-primary/90 h-10 px-4 py-2"><!--[-->Try it out<!--]--></button><!----></div></div><!--]--></div><div><!--[--><h2 id="samples" tabindex="-1" class=""><!--[-->Samples<!--]--><a class="header-anchor header-anchor" href="#samples" aria-label="Permalink to Samples"></a></h2><div><!----></div><!--]--></div></div></div></div><!--[--><span class="text-sm text-muted-foreground text-center" operationid="generateApiKey" method="post" path="/v1/api-keys">Powered by <a href="https://github.com/enzonotario/vitepress-openapi" target="_blank" class="text-primary-foreground"> VitePress OpenAPI </a></span><!--]--><!--[--><!--]--></div><!--]--><!--]--><h2 id="list-api-keys" tabindex="-1">List API Keys <a class="header-anchor" href="#list-api-keys" aria-label="Permalink to "List API Keys""></a></h2><!--[--><!--[--><div class="OAPath flex flex-col space-y-4"><!--[--><div class="flex flex-col"><div class="flex flex-row gap-2"><!--[--><!--]--></div><h1 id="list-api-keys" tabindex="-1" class="scroll-m-[var(--vp-nav-height)]"><!--[-->List API keys<!--]--><a class="header-anchor header-anchor" href="#list-api-keys" aria-label="Permalink to List API keys"></a></h1></div><!--]--><!----><div class="sm:grid-cols-2 relative grid grid-cols-1"><div class="OAPathContentStart flex flex-col"><div class="flex flex-col gap-4"><div class="sm:hidden"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--get px-2 py-1 rounded" data-v-ae22f171><!--[-->GET<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys</span></span></div></div></div><!--]--></div><!--[--><div class="OAMarkdown oa-doc"><p>Returns all API keys belonging to the currently authenticated user. The raw key value is not included.</p>
|
||
</div><!--]--></div><!--[--><!--[--><div class="flex flex-col"><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)]"><div class="flex flex-row items-center"><h2 id="authorizations" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0"><!--[-->Authorizations<!--]--><a class="header-anchor !top-0" href="#authorizations" aria-label="Permalink to Authorizations"></a></h2><span class="flex-grow min-w-2"></span></div></div><div class="flex flex-col gap-3"><!--[--><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class="border-gray-600 dark:border-gray-400"><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">bearerAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>JWT obtained from <code>POST /v1/auth/login</code>. Pass as <code>Authorization: Bearer <token></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">HTTP (bearer)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><div class="flex flex-row items-center space-x-2"><span class="text-sm font-bold">or</span><span class="flex-grow border-t border-[var(--vp-c-divider)]"></span></div></div><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class=""><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">apiKeyAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>API key generated via <code>POST /v1/api-keys</code>. Pass as <code>X-API-KEY: <key></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">API Key (header: X-API-KEY)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><!----></div><!--]--></div></div><!--]--><!--]--><!--[--><!----><!--]--><!--[--><!----><!--]--><!--[--><!--[--><div class="flex flex-col"><div dir="ltr" data-orientation="horizontal"><!--[--><!--[--><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)] flex flex-wrap flex-row items-center justify-between gap-y-[16px]"><h2 id="responses" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0 inline-block"><!--[-->Responses<!--]--><a class="header-anchor !top-0" href="#responses" aria-label="Permalink to Responses"></a></h2><div class="overflow-x-auto"><div class="w-full flex"><div class="inline-flex h-10 items-center justify-center rounded-md bg-transparent text-muted-foreground p-0" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><div class="relative flex flex-row"><!--[--><!--v-if--><!--[--><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-13-trigger-200" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->200<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-13-trigger-401" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->401<!--]--><!--]--></button><!--]--><!--]--><!----></div><!--]--><!--]--></div></div></div></div><!--[--><div id="reka-tabs-v-13-content-200" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-13-trigger-200" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col space-y-4"><div class="OAMarkdown oa-doc"><p>List of API keys (without raw key values).</p>
|
||
</div><div class="flex flex-row items-center gap-2 text-xs"><label for="content-type-zw7jt" class="text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70 flex-shrink-0 text-muted-foreground"><!--[--><!--[-->Content-Type<!--]--><!--]--></label><div class="flex-shrink-0"><div><div class="ml-auto max-w-40 hover:max-w-full truncate transition-all duration-200 ease-in-out"><span class="h-6 text-xs rounded-md bg-muted px-3 py-1">application/json</span></div></div></div></div><div dir="ltr" data-orientation="horizontal" content-type="application/json"><!--[--><!--[--><div class="h-10 items-center rounded-md bg-muted p-1 text-muted-foreground relative flex flex-row justify-start overflow-x-auto" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-16-trigger-schema" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->Schema<!--]--><!--]--></button><!--[--><button variant="schemaTabs" class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:bg-background data-[state=active]:text-foreground data-[state=active]:shadow-sm h-full" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-16-trigger-examples.JSON" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->JSON<!--]--><!--]--></button><!--]--><!--]--><!--]--></div><div id="reka-tabs-v-16-content-schema" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-16-trigger-schema" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--[--><div id="reka-tabs-v-16-content-examples.JSON" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-16-trigger-examples.JSON" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col gap-2"><!----><div class="vp-adaptive-theme min-h-16 language-json !m-0"><button title="Copy Code" class="copy"></button><span class="lang">JSON</span><div class="vjs-tree p-2" style=""><!--[--><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><span class="vjs-carets vjs-carets-open"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="caret-down" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M840.4 300H183.6c-19.7 0-30.7 20.8-18.5 35l328.4 380.8c9.4 10.9 27.5 10.9 37 0L858.9 335c12.2-14.2 1.2-35-18.5-35z"></path></svg></span></div><!----><span><span class="vjs-tree-brackets">[</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><span class="vjs-carets vjs-carets-open"><svg viewBox="0 0 1024 1024" focusable="false" data-icon="caret-down" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M840.4 300H183.6c-19.7 0-30.7 20.8-18.5 35l328.4 380.8c9.4 10.9 27.5 10.9 37 0L858.9 335c12.2-14.2 1.2-35-18.5-35z"></path></svg></span></div><!----><span><span class="vjs-tree-brackets">{</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"id"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"clx1y2z3a0000b4d2"</span><span>,</span><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"name"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"CI/CD Pipeline Key"</span><span>,</span><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"key"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"oa_live_abc1..."</span><span>,</span><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"expiresAt"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"string"</span><span>,</span><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><span class="vjs-key">"createdAt"<span class="vjs-colon">: </span></span><span><span class="vjs-value vjs-value-string">"string"</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><div class="vjs-indent-unit has-line"><!--[--><!--[--> <!--]--><!--[--> <!--]--><!--]--></div><!--]--><!----></div><!----><span><span class="vjs-tree-brackets">}</span><!----><!----></span><!----></div></div><div><div class="vjs-tree-node has-carets dynamic-height" style=""><!----><!----><div class="vjs-indent"><!--[--><!--]--><!----></div><!----><span><span class="vjs-tree-brackets">]</span><!----><!----></span><!----></div></div><!--]--></div></div></div><!--]--><!--]--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--></div><div id="reka-tabs-v-13-content-401" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-13-trigger-401" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--></div><div class="flex flex-col"><div class="OAPathContentEnd sticky top-[100px] inset-x-0 flex flex-col"><div class="hidden sm:block sm:mb-2"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--get px-2 py-1 rounded" data-v-ae22f171><!--[-->GET<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys</span></span></div></div></div><!--]--></div><div><!--[--><div class="flex flex-col gap-2"><h2 id="playground" tabindex="-1" class="block sm:hidden"><!--[-->Playground<!--]--><a class="header-anchor header-anchor" href="#playground" aria-label="Permalink to Playground"></a></h2><div class="OAPlaygroundParameters" data-v-b7652c8b><!----><details open data-v-b7652c8b><summary data-v-b7652c8b>Authorization <div class="w-full max-w-[33%] md:max-w-[50%] ml-auto -mt-8" data-v-b7652c8b><!--[--><!--[--><!--[--><button class="flex w-full items-center justify-between rounded-md border border-input bg-muted text-sm ring-offset-background placeholder:text-muted-foreground focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 [&>span]:line-clamp-1 h-9 px-3 py-1.5 text-foreground font-normal" aria-label="Security Scheme" role="combobox" type="button" aria-controls="reka-select-content-v-19" aria-expanded="false" aria-required="false" aria-autocomplete="none" dir="ltr" data-state="closed" data-v-b7652c8b><!--[--><!--[--><span style="pointer-events:none;" data-placeholder="bearerAuth" data-v-b7652c8b><!--[-->bearerAuth<!--]--></span><!--]--><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" class="lucide w-4 h-4 opacity-50 lucide-chevron-down-icon lucide-chevron-down w-4 h-4 opacity-50"><path d="m6 9 6 6 6-6"></path></svg><!--]--></button><!--v-if--><!--]--><!--]--><select aria-hidden="true" tabindex="-1" style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);clip-path:inset(50%);white-space:nowrap;word-wrap:normal;top:-1px;left:-1px;" value="bearerAuth"><!--[--><!--]--></select><!--]--></div></summary><div class="flex flex-col gap-2" data-v-b7652c8b><!--[--><div class="flex flex-col" data-v-b7652c8b><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><label for="bearerAuth" class="peer-disabled:cursor-not-allowed peer-disabled:opacity-70 text-sm font-bold" data-v-b7652c8b><!--[--><!--[-->bearerAuth<!--]--><!--]--></label></div><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><div class="flex flex-col space-y-2 w-full" data-v-b7652c8b><div class="relative flex items-center w-full"><input id="bearerAuth" name="bearerAuth" placeholder="Token" type="text" class="flex h-10 w-full rounded-md border border-input px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 pr-8 bg-muted" value="Token"><button type="button" class="absolute right-2 text-muted-foreground hover:text-foreground focus:outline-none" tabindex="-1"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide h-4 w-4 lucide-x-icon lucide-x h-4 w-4" aria-hidden="true"><path d="M18 6 6 18"></path><path d="m6 6 12 12"></path></svg></button></div></div></div></div><!--]--></div></details><!----><!----><!----></div><div class="flex flex-col gap-2"><button class="inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 bg-primary text-primary-foreground hover:bg-primary/90 h-10 px-4 py-2"><!--[-->Try it out<!--]--></button><!----></div></div><!--]--></div><div><!--[--><h2 id="samples" tabindex="-1" class=""><!--[-->Samples<!--]--><a class="header-anchor header-anchor" href="#samples" aria-label="Permalink to Samples"></a></h2><div><!----></div><!--]--></div></div></div></div><!--[--><span class="text-sm text-muted-foreground text-center" operationid="getApiKeys" method="get" path="/v1/api-keys">Powered by <a href="https://github.com/enzonotario/vitepress-openapi" target="_blank" class="text-primary-foreground"> VitePress OpenAPI </a></span><!--]--><!--[--><!--]--></div><!--]--><!--]--><h2 id="delete-an-api-key" tabindex="-1">Delete an API Key <a class="header-anchor" href="#delete-an-api-key" aria-label="Permalink to "Delete an API Key""></a></h2><!--[--><!--[--><div class="OAPath flex flex-col space-y-4"><!--[--><div class="flex flex-col"><div class="flex flex-row gap-2"><!--[--><!--]--></div><h1 id="delete-an-api-key" tabindex="-1" class="scroll-m-[var(--vp-nav-height)]"><!--[-->Delete an API key<!--]--><a class="header-anchor header-anchor" href="#delete-an-api-key" aria-label="Permalink to Delete an API key"></a></h1></div><!--]--><!----><div class="sm:grid-cols-2 relative grid grid-cols-1"><div class="OAPathContentStart flex flex-col"><div class="flex flex-col gap-4"><div class="sm:hidden"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--delete px-2 py-1 rounded" data-v-ae22f171><!--[-->DELETE<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys/{id}</span></span></div></div></div><!--]--></div><!--[--><div class="OAMarkdown oa-doc"><p>Permanently revokes and deletes an API key by ID. Only the owning user can delete their own keys. Disabled in demo mode.</p>
|
||
</div><!--]--></div><!--[--><!--[--><div class="flex flex-col"><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)]"><div class="flex flex-row items-center"><h2 id="authorizations" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0"><!--[-->Authorizations<!--]--><a class="header-anchor !top-0" href="#authorizations" aria-label="Permalink to Authorizations"></a></h2><span class="flex-grow min-w-2"></span></div></div><div class="flex flex-col gap-3"><!--[--><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class="border-gray-600 dark:border-gray-400"><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">bearerAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>JWT obtained from <code>POST /v1/auth/login</code>. Pass as <code>Authorization: Bearer <token></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">HTTP (bearer)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><div class="flex flex-row items-center space-x-2"><span class="text-sm font-bold">or</span><span class="flex-grow border-t border-[var(--vp-c-divider)]"></span></div></div><div class="flex flex-col gap-3"><div class="flex flex-col gap-1"><!----><div class=""><!--[--><div><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">apiKeyAuth</span></div><div class="OAMarkdown oa-doc text-sm"><p>API key generated via <code>POST /v1/api-keys</code>. Pass as <code>X-API-KEY: <key></code>.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">API Key (header: X-API-KEY)</span></div><!----></div></div><!----></div><!--[--><!----><!----><!----><!--]--></div><!----></div><!--]--></div></div><!----></div><!--]--></div></div><!--]--><!--]--><!--[--><!--[--><h2 id="parameters" tabindex="-1" class=""><!--[-->Parameters<!--]--><a class="header-anchor header-anchor" href="#parameters" aria-label="Permalink to Parameters"></a></h2><div class="flex flex-col"><!----><div class="space-y-4"><h3>Path Parameters</h3><!--[--><div class="flex flex-col p-3 gap-2 rounded bg-muted"><div class="flex flex-col gap-2"><div class="flex flex-row items-center gap-2"><span class="text-sm font-bold">id</span><span class="text-sm text-destructive">*</span></div><div class="OAMarkdown oa-doc text-sm"><p>The ID of the API key to delete.</p>
|
||
</div></div><div class="flex flex-col gap-2"><div class="flex flex-row gap-2"><div class="flex flex-row gap-2 text-sm"><span class="font-bold">Type</span><div class="flex justify-between items-start gap-2 flex-1"><div><span class="text-muted-foreground">string</span></div><!----></div></div><span class="text-sm text-destructive">Required</span></div><!----><!--[--><div class="flex flex-row items-center gap-2"><span class="text-sm">Example</span><code class="!text-xs break-all text-wrap cursor-pointer hover:opacity-80" role="button" title="Click to set in playground">"clx1y2z3a0000b4d2"</code></div><!----><!----><!--]--><!----></div></div><!--]--></div><!----></div><!--]--><!--]--><!--[--><!----><!--]--><!--[--><!--[--><div class="flex flex-col"><div dir="ltr" data-orientation="horizontal"><!--[--><!--[--><div class="mt-[48px] mb-[16px] pt-[24px] border-t-[1px] border-[var(--vp-c-divider)] flex flex-wrap flex-row items-center justify-between gap-y-[16px]"><h2 id="responses" tabindex="-1" class="text-[var(--vp-c-text-1)] !my-0 !py-0 !border-t-0 inline-block"><!--[-->Responses<!--]--><a class="header-anchor !top-0" href="#responses" aria-label="Permalink to Responses"></a></h2><div class="overflow-x-auto"><div class="w-full flex"><div class="inline-flex h-10 items-center justify-center rounded-md bg-transparent text-muted-foreground p-0" tabindex="-1" data-orientation="horizontal" dir="ltr" style="outline:none;" role="tablist" aria-orientation="horizontal"><!--[--><!--[--><div class="relative flex flex-row"><!--[--><!--v-if--><!--[--><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" data-active id="reka-tabs-v-20-trigger-204" role="tab" type="button" aria-selected="true" data-state="active"><!--[--><!--[-->204<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-20-trigger-401" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->401<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-20-trigger-403" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->403<!--]--><!--]--></button><button class="inline-flex items-center justify-center whitespace-nowrap rounded-sm px-3 py-1.5 text-sm font-medium ring-offset-background transition-all focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 h-full z-10" data-reka-collection-item tabindex="-1" data-orientation="horizontal" id="reka-tabs-v-20-trigger-500" role="tab" type="button" aria-selected="false" data-state="inactive"><!--[--><!--[-->500<!--]--><!--]--></button><!--]--><!--]--><!----></div><!--]--><!--]--></div></div></div></div><!--[--><div id="reka-tabs-v-20-content-204" role="tabpanel" data-state="active" data-orientation="horizontal" aria-labelledby="reka-tabs-v-20-trigger-204" tabindex="0" style="animation-duration:0s;" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--[--><!--[--><div class="flex flex-col space-y-4"><div class="OAMarkdown oa-doc"><p>API key deleted. No content returned.</p>
|
||
</div><!----><!----></div><!--]--><!--]--></div><div id="reka-tabs-v-20-content-401" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-20-trigger-401" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><div id="reka-tabs-v-20-content-403" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-20-trigger-403" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><div id="reka-tabs-v-20-content-500" role="tabpanel" data-state="inactive" data-orientation="horizontal" aria-labelledby="reka-tabs-v-20-trigger-500" hidden tabindex="0" style="" class="mt-2 ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"><!--v-if--></div><!--]--><!--]--><!--]--></div></div><!--]--><!--]--></div><div class="flex flex-col"><div class="OAPathContentEnd sticky top-[100px] inset-x-0 flex flex-col"><div class="hidden sm:block sm:mb-2"><!--[--><div class="flex flex-col gap-2 text-sm bg-muted rounded p-1.5" data-v-ae22f171><div class="language-bash !overflow-hidden !m-0 h-8 flex flex-row items-center gap-1.5" data-v-ae22f171><button title="Copy endpoint" class="copy absolute !top-1 z-50 OAPathEndpoint__copy" data-v-ae22f171></button><div class="inline-flex items-center border text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 border-transparent OAMethodBadge--delete px-2 py-1 rounded" data-v-ae22f171><!--[-->DELETE<!--]--></div><div class="overflow-x-auto whitespace-nowrap" data-v-ae22f171><span class="flex flex-row flex-shrink-0" data-v-ae22f171><!----><span class="font-bold select-all" data-v-ae22f171>/v1/api-keys/{id}</span></span></div></div></div><!--]--></div><div><!--[--><div class="flex flex-col gap-2"><h2 id="playground" tabindex="-1" class="block sm:hidden"><!--[-->Playground<!--]--><a class="header-anchor header-anchor" href="#playground" aria-label="Permalink to Playground"></a></h2><div class="OAPlaygroundParameters" data-v-b7652c8b><!----><details open data-v-b7652c8b><summary data-v-b7652c8b>Authorization <div class="w-full max-w-[33%] md:max-w-[50%] ml-auto -mt-8" data-v-b7652c8b><!--[--><!--[--><!--[--><button class="flex w-full items-center justify-between rounded-md border border-input bg-muted text-sm ring-offset-background placeholder:text-muted-foreground focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 [&>span]:line-clamp-1 h-9 px-3 py-1.5 text-foreground font-normal" aria-label="Security Scheme" role="combobox" type="button" aria-controls="reka-select-content-v-25" aria-expanded="false" aria-required="false" aria-autocomplete="none" dir="ltr" data-state="closed" data-v-b7652c8b><!--[--><!--[--><span style="pointer-events:none;" data-placeholder="bearerAuth" data-v-b7652c8b><!--[-->bearerAuth<!--]--></span><!--]--><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" class="lucide w-4 h-4 opacity-50 lucide-chevron-down-icon lucide-chevron-down w-4 h-4 opacity-50"><path d="m6 9 6 6 6-6"></path></svg><!--]--></button><!--v-if--><!--]--><!--]--><select aria-hidden="true" tabindex="-1" style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);clip-path:inset(50%);white-space:nowrap;word-wrap:normal;top:-1px;left:-1px;" value="bearerAuth"><!--[--><!--]--></select><!--]--></div></summary><div class="flex flex-col gap-2" data-v-b7652c8b><!--[--><div class="flex flex-col" data-v-b7652c8b><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><label for="bearerAuth" class="peer-disabled:cursor-not-allowed peer-disabled:opacity-70 text-sm font-bold" data-v-b7652c8b><!--[--><!--[-->bearerAuth<!--]--><!--]--></label></div><div class="flex flex-row items-center space-x-2" data-v-b7652c8b><div class="flex flex-col space-y-2 w-full" data-v-b7652c8b><div class="relative flex items-center w-full"><input id="bearerAuth" name="bearerAuth" placeholder="Token" type="text" class="flex h-10 w-full rounded-md border border-input px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 pr-8 bg-muted" value="Token"><button type="button" class="absolute right-2 text-muted-foreground hover:text-foreground focus:outline-none" tabindex="-1"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide h-4 w-4 lucide-x-icon lucide-x h-4 w-4" aria-hidden="true"><path d="M18 6 6 18"></path><path d="m6 6 12 12"></path></svg></button></div></div></div></div><!--]--></div></details><!----><details open data-v-b7652c8b><summary data-v-b7652c8b>Variables</summary><div class="flex flex-col gap-1" data-v-b7652c8b><div class="flex flex-row gap-2" data-v-b7652c8b><div class="w-[16px]" data-v-b7652c8b></div><div class="flex flex-row flex-grow gap-2" data-v-b7652c8b><div class="w-1/2 flex justify-start" data-v-b7652c8b><span class="text-xs text-muted-foreground uppercase" data-v-b7652c8b>Key</span></div><div class="w-1/2 flex justify-start" data-v-b7652c8b><span class="text-xs text-muted-foreground uppercase" data-v-b7652c8b>Value</span></div></div></div><!--[--><div class="grid gap-2 grid-cols-2 items-center" data-v-b7652c8b><div class="flex items-center gap-2"><button variant="toggle" class="peer h-4 w-4 shrink-0 rounded-sm border border-primary ring-offset-background focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 border-solid" id="enable-deleteApiKey:path:id" role="checkbox" type="button" aria-checked="true" aria-required="false" data-state="checked"><!--[--><span data-state="checked" style="pointer-events:none;" class="flex h-full w-full items-center justify-center text-current"><!--[--><!--[--><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide h-4 w-4 lucide-check-icon lucide-check h-4 w-4" aria-hidden="true"><path d="M20 6 9 17l-5-5"></path></svg><!--]--><!--]--></span><!--]--><!--[--><!-- We render single input if it's required --><!--[--><input data-hidden tabindex="-1" style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);clip-path:inset(50%);white-space:nowrap;word-wrap:normal;top:-1px;left:-1px;" name="enable-deleteApiKey:path:id" value="on" checked type="checkbox"><!--]--><!--]--></button><label for="deleteApiKey:path:id" class="peer-disabled:cursor-not-allowed peer-disabled:opacity-70 text-sm font-bold space-x-2"><!--[--><!--[--><span>id</span><span class="text-sm text-destructive">*</span><!--]--><!--]--></label></div><div class="flex items-center flex-grow gap-2"><div class="flex-grow flex items-center gap-1"><div class="relative flex items-center w-full"><input id="deleteApiKey:path:id" name="deleteApiKey:path:id" placeholder="clx1y2z3a0000b4d2" type="text" class="flex h-10 w-full rounded-md border border-input px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50 pr-8 bg-muted" value="clx1y2z3a0000b4d2"><button type="button" class="absolute right-2 text-muted-foreground hover:text-foreground focus:outline-none" tabindex="-1"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide h-4 w-4 lucide-x-icon lucide-x h-4 w-4" aria-hidden="true"><path d="M18 6 6 18"></path><path d="m6 6 12 12"></path></svg></button></div></div></div></div><!--]--></div></details><!----></div><div class="flex flex-col gap-2"><button class="inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 bg-primary text-primary-foreground hover:bg-primary/90 h-10 px-4 py-2"><!--[-->Try it out<!--]--></button><!----></div></div><!--]--></div><div><!--[--><h2 id="samples" tabindex="-1" class=""><!--[-->Samples<!--]--><a class="header-anchor header-anchor" href="#samples" aria-label="Permalink to Samples"></a></h2><div><!----></div><!--]--></div></div></div></div><!--[--><span class="text-sm text-muted-foreground text-center" operationid="deleteApiKey" method="delete" path="/v1/api-keys/{id}">Powered by <a href="https://github.com/enzonotario/vitepress-openapi" target="_blank" class="text-primary-foreground"> VitePress OpenAPI </a></span><!--]--><!--[--><!--]--></div><!--]--><!--]--></div></div></main><footer class="VPDocFooter" data-v-29334b8c data-v-a014c1de><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-a014c1de><span class="visually-hidden" id="doc-footer-aria-label" data-v-a014c1de>Pager</span><div class="pager" data-v-a014c1de><a class="VPLink link pager-link prev" href="/api/iam.html" data-v-a014c1de><!--[--><span class="desc" data-v-a014c1de>Previous page</span><span class="title" data-v-a014c1de>IAM</span><!--]--></a></div><div class="pager" data-v-a014c1de><a class="VPLink link pager-link next" href="/api/settings.html" data-v-a014c1de><!--[--><span class="desc" data-v-a014c1de>Next page</span><span class="title" data-v-a014c1de>Settings</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_api-keys.md\":\"Dn21HeSJ\",\"api_archived-email.md\":\"BT-mHBqK\",\"api_auth.md\":\"D-468dKx\",\"api_authentication.md\":\"3ZX-rlxc\",\"api_dashboard.md\":\"CSiI_2IK\",\"api_iam.md\":\"B5FbdpjA\",\"api_index.md\":\"B_r30QlK\",\"api_ingestion.md\":\"CRDN5lCu\",\"api_integrity.md\":\"B9VpMKD6\",\"api_jobs.md\":\"CTasZcNL\",\"api_rate-limiting.md\":\"BqhkXaUd\",\"api_search.md\":\"Cu20yO7t\",\"api_settings.md\":\"CwhPvkZf\",\"api_storage.md\":\"CTn9PQaD\",\"api_upload.md\":\"CfCXTOWM\",\"api_users.md\":\"BdQul9nH\",\"enterprise_audit-log_api.md\":\"jQPQ8cO8\",\"enterprise_audit-log_audit-service.md\":\"D9higq7j\",\"enterprise_audit-log_guide.md\":\"DuHTEaId\",\"enterprise_audit-log_index.md\":\"By894rqA\",\"enterprise_legal-holds_api.md\":\"E6pKaGoK\",\"enterprise_legal-holds_guide.md\":\"4JCnApXO\",\"enterprise_legal-holds_index.md\":\"CXivackd\",\"enterprise_retention-labels_api.md\":\"De0lRuGD\",\"enterprise_retention-labels_automated-tagging.md\":\"uMCViAe6\",\"enterprise_retention-labels_guide.md\":\"LMnSU6ly\",\"enterprise_retention-labels_index.md\":\"gaps1eMo\",\"enterprise_retention-policy_api.md\":\"Dv1_ca5K\",\"enterprise_retention-policy_guide.md\":\"BxhZekoC\",\"enterprise_retention-policy_index.md\":\"C_qinQpQ\",\"enterprise_retention-policy_lifecycle-worker.md\":\"CLFQ4ZEf\",\"enterprise_retention-policy_retention-service.md\":\"0HsJnlOP\",\"index.md\":\"ChFzL1lA\",\"services_iam-service_iam-policy.md\":\"DSOajx7I\",\"services_index.md\":\"BmWnT3gS\",\"services_job-queue.md\":\"_FwJJttJ\",\"services_ocr-service.md\":\"B6-nFSTJ\",\"services_storage-service.md\":\"Bpdj_lG7\",\"summary.md\":\"C_r3wuBH\",\"user-guides_email-providers_eml.md\":\"DV6Zs6RI\",\"user-guides_email-providers_google-workspace.md\":\"CaNRUOL2\",\"user-guides_email-providers_imap.md\":\"CQ8xQOnx\",\"user-guides_email-providers_index.md\":\"D2IiEdvn\",\"user-guides_email-providers_mbox.md\":\"B68Wejyx\",\"user-guides_email-providers_microsoft-365.md\":\"BNGY0WTw\",\"user-guides_email-providers_pst.md\":\"Dech_zDS\",\"user-guides_installation.md\":\"CYbox6PW\",\"user-guides_integrity-check.md\":\"BfM1nsWe\",\"user-guides_settings_system.md\":\"BI9F6Lpw\",\"user-guides_troubleshooting_cors-errors.md\":\"wu2DtNUw\",\"user-guides_upgrade-and-migration_meilisearch-upgrade.md\":\"BTQMSseX\",\"user-guides_upgrade-and-migration_upgrade.md\":\"DlOu8Pon\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Open Archiver Docs\",\"description\":\"Official documentation for the Open Archiver project.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"search\":{\"provider\":\"local\"},\"logo\":{\"src\":\"/logo-sq.svg\"},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Github\",\"link\":\"https://github.com/LogicLabs-OU/OpenArchiver\"},{\"text\":\"Website\",\"link\":\"https://openarchiver.com/\"},{\"text\":\"Discord\",\"link\":\"https://discord.gg/MTtD7BhuTQ\"}],\"sidebar\":[{\"text\":\"User Guides\",\"items\":[{\"text\":\"Get Started\",\"link\":\"/\"},{\"text\":\"Installation\",\"link\":\"/user-guides/installation\"},{\"text\":\"Email Integrity Check\",\"link\":\"/user-guides/integrity-check\"},{\"text\":\"Email Providers\",\"link\":\"/user-guides/email-providers/\",\"collapsed\":true,\"items\":[{\"text\":\"Generic IMAP Server\",\"link\":\"/user-guides/email-providers/imap\"},{\"text\":\"Google Workspace\",\"link\":\"/user-guides/email-providers/google-workspace\"},{\"text\":\"Microsoft 365\",\"link\":\"/user-guides/email-providers/microsoft-365\"},{\"text\":\"EML Import\",\"link\":\"/user-guides/email-providers/eml\"},{\"text\":\"PST Import\",\"link\":\"/user-guides/email-providers/pst\"},{\"text\":\"Mbox Import\",\"link\":\"/user-guides/email-providers/mbox\"}]},{\"text\":\"Settings\",\"collapsed\":true,\"items\":[{\"text\":\"System\",\"link\":\"/user-guides/settings/system\"}]},{\"text\":\"Upgrading and Migration\",\"collapsed\":true,\"items\":[{\"text\":\"Upgrading\",\"link\":\"/user-guides/upgrade-and-migration/upgrade\"},{\"text\":\"Meilisearch Upgrade\",\"link\":\"/user-guides/upgrade-and-migration/meilisearch-upgrade\"}]}]},{\"text\":\"API Reference\",\"items\":[{\"text\":\"Overview\",\"link\":\"/api/\"},{\"text\":\"Authentication\",\"link\":\"/api/authentication\"},{\"text\":\"Rate Limiting\",\"link\":\"/api/rate-limiting\"},{\"text\":\"Auth\",\"link\":\"/api/auth\"},{\"text\":\"Archived Email\",\"link\":\"/api/archived-email\"},{\"text\":\"Dashboard\",\"link\":\"/api/dashboard\"},{\"text\":\"Ingestion\",\"link\":\"/api/ingestion\"},{\"text\":\"Integrity Check\",\"link\":\"/api/integrity\"},{\"text\":\"Search\",\"link\":\"/api/search\"},{\"text\":\"Storage\",\"link\":\"/api/storage\"},{\"text\":\"Upload\",\"link\":\"/api/upload\"},{\"text\":\"Jobs\",\"link\":\"/api/jobs\"},{\"text\":\"Users\",\"link\":\"/api/users\"},{\"text\":\"IAM\",\"link\":\"/api/iam\"},{\"text\":\"API Keys\",\"link\":\"/api/api-keys\"},{\"text\":\"Settings\",\"link\":\"/api/settings\"}]},{\"text\":\"Services\",\"items\":[{\"text\":\"Overview\",\"link\":\"/services/\"},{\"text\":\"Storage Service\",\"link\":\"/services/storage-service\"},{\"text\":\"OCR Service\",\"link\":\"/services/ocr-service\"},{\"text\":\"IAM Service\",\"items\":[{\"text\":\"IAM Policies\",\"link\":\"/services/iam-service/iam-policy\"}]}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |