Something went wrong. Try again.
A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536<!doctype html><html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-reference/admin-api" data-has-hydrated="false"><head><meta charset="UTF-8"><meta name="generator" content="Docusaurus v3.10.0"><title data-rh="true">Admin API | HappyView</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" name="twitter:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" property="og:url" content="https://happyview.dev/reference/admin-api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Admin API | HappyView"><meta data-rh="true" name="description" content="The admin API lets you manage lexicons, monitor records, run backfill jobs, and control user access. All endpoints live under /admin and require authentication from a DID that exists in the users table, with the appropriate permissions for the endpoint being called. You can also manage all of this through the web dashboard."><meta data-rh="true" property="og:description" content="The admin API lets you manage lexicons, monitor records, run backfill jobs, and control user access. All endpoints live under /admin and require authentication from a DID that exists in the users table, with the appropriate permissions for the endpoint being called. You can also manage all of this through the web dashboard."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://happyview.dev/reference/admin-api"><link data-rh="true" rel="alternate" href="https://happyview.dev/reference/admin-api" hreflang="en"><link data-rh="true" rel="alternate" href="https://happyview.dev/reference/admin-api" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Overview","item":"https://happyview.dev/reference/admin-api"}]}</script><link rel="stylesheet" href="/assets/css/styles.18b9c377.css"><script src="/assets/js/runtime~main.413aac68.js" defer="defer"></script><script src="/assets/js/main.c991874c.js" defer="defer"></script></head><body><svg style="display: none;"><defs><symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol></defs></svg><script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo.light.png"><link rel="preload" as="image" href="/img/logo.dark.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_hn_G" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.light.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--light_EnZ3"><img src="/img/logo.dark.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--dark_UTRq"></div><b class="navbar__title text--truncate"></b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/gamesgamesgamesgamesgames/happyview" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_yqny"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_pDN8 colorModeToggle_WR5U"><button class="clean-btn toggleButton__Co1 toggleButtonDisabled_pTNf" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c lightToggleIcon_z1QC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c darkToggleIcon_O_bk"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c systemToggleIcon_SKeC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_qQFS"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_NcQk"><div class="docsWrapper_tjyD"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_J6bC" type="button"></button><div class="docRoot_mCS9"><aside class="theme-doc-sidebar-container docSidebarContainer_AIvH"><div class="sidebarViewport_v5_F"><div class="sidebar_TbVu"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_hz51"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="Introduction" class="linkLabel_GBZK">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/getting-started/quickstart"><span title="Getting Started" class="categoryLinkLabel_ppUb">Getting Started</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/tutorials/statusphere"><span title="Tutorials" class="categoryLinkLabel_ppUb">Tutorials</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/guides/lexicons"><span title="Guides" class="categoryLinkLabel_ppUb">Guides</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/sdk/overview"><span title="JavaScript SDK" class="categoryLinkLabel_ppUb">JavaScript SDK</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/reference/xrpc-api"><span title="Reference" class="categoryLinkLabel_ppUb">Reference</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/xrpc-api"><span title="XRPC API" class="linkLabel_GBZK">XRPC API</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/reference/admin-api"><span title="Admin API" class="categoryLinkLabel_ppUb">Admin API</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/reference/admin-api"><span title="Overview" class="linkLabel_GBZK">Overview</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/lexicons"><span title="Lexicons" class="linkLabel_GBZK">Lexicons</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/stats"><span title="Stats" class="linkLabel_GBZK">Stats</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/backfill"><span title="Backfill" class="linkLabel_GBZK">Backfill</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/events"><span title="Event Logs" class="linkLabel_GBZK">Event Logs</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/api-keys"><span title="API Keys" class="linkLabel_GBZK">API Keys</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/users"><span title="Users" class="linkLabel_GBZK">Users</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/labelers"><span title="Labelers" class="linkLabel_GBZK">Labelers</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/settings"><span title="Instance Settings" class="linkLabel_GBZK">Instance Settings</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/domains"><span title="Domains" class="linkLabel_GBZK">Domains</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/script-variables"><span title="Script Variables" class="linkLabel_GBZK">Script Variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/api-clients"><span title="API Clients" class="linkLabel_GBZK">API Clients</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/admin/plugins"><span title="Plugins" class="linkLabel_GBZK">Plugins</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/reference/lua/record-api"><span title="Lua API" class="categoryLinkLabel_ppUb">Lua API</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/glossary"><span title="Glossary" class="linkLabel_GBZK">Glossary</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/architecture"><span title="Architecture" class="linkLabel_GBZK">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/reference/troubleshooting"><span title="Troubleshooting" class="linkLabel_GBZK">Troubleshooting</span></a></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_Gcuv"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_SLVn"><div class="docItemContainer_gUK8"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer__5rh" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_ilNI"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Reference</span></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Admin API</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Overview</span></li></ul></nav><div class="tocCollapsible_vaUl theme-doc-toc-mobile tocMobile_CcuZ"><button type="button" class="clean-btn tocCollapsibleButton__AHn">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Admin API</h1></header><p>The admin API lets you manage lexicons, monitor records, run backfill jobs, and control user access. All endpoints live under <code>/admin</code> and require authentication from a DID that exists in the <code>users</code> table, with the appropriate <a class="" href="/guides/permissions">permissions</a> for the endpoint being called. You can also manage all of this through the <a class="" href="/getting-started/dashboard">web dashboard</a>.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="auth">Auth<a href="#auth" class="hash-link" aria-label="Direct link to Auth" title="Direct link to Auth" translate="no"></a></h2><p>The admin API supports two authentication methods:</p><ol><li class=""><strong>API keys</strong> — read/write tokens starting with <code>hv_</code>, passed as <code>Authorization: Bearer hv_...</code>. See the <a class="" href="/guides/api-keys">API Keys guide</a> for details.</li><li class=""><strong>Service auth JWT</strong> — atproto inter-service authentication via signed JWTs.</li></ol><p>In all cases the resolved DID is checked against the <code>users</code> table, and the user's permissions are loaded to authorize the request.</p><p><strong>Auto-bootstrap</strong>: If the <code>users</code> table is empty, the first authenticated request automatically creates the caller as the <strong>super user</strong> with all permissions granted.</p><p>Non-user DIDs receive a <code>403 Forbidden</code> response. Users without the required permission for a specific endpoint also receive <code>403 Forbidden</code>.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="errors">Errors<a href="#errors" class="hash-link" aria-label="Direct link to Errors" title="Direct link to Errors" translate="no"></a></h2><p>All error responses return JSON with an <code>error</code> field:</p><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"error"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"description of what went wrong"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><table><thead><tr><th>Status</th><th>Meaning</th></tr></thead><tbody><tr><td><code>400 Bad Request</code></td><td>Invalid input (missing required fields, malformed lexicon JSON)</td></tr><tr><td><code>401 Unauthorized</code></td><td>Missing or invalid API key or service auth JWT</td></tr><tr><td><code>403 Forbidden</code></td><td>Authenticated DID is not in the users table, or user lacks the required permission</td></tr><tr><td><code>404 Not Found</code></td><td>Lexicon, user, or backfill job not found</td></tr></tbody></table><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain"># All examples assume $TOKEN is an API key (hv_...)</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">AUTH="Authorization: Bearer $TOKEN"</span><br></div></code></pre></div></div><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="endpoint-groups">Endpoint groups<a href="#endpoint-groups" class="hash-link" aria-label="Direct link to Endpoint groups" title="Direct link to Endpoint groups" translate="no"></a></h2><table><thead><tr><th>Group</th><th>Description</th></tr></thead><tbody><tr><td><a class="" href="/reference/admin/lexicons">Lexicons</a></td><td>Upload, list, get, and delete lexicons and network lexicons</td></tr><tr><td><a class="" href="/reference/admin/stats">Stats</a></td><td>Record counts by collection</td></tr><tr><td><a class="" href="/reference/admin/backfill">Backfill</a></td><td>Create and monitor historical backfill jobs</td></tr><tr><td><a class="" href="/reference/admin/events">Event Logs</a></td><td>Query the audit trail of system events</td></tr><tr><td><a class="" href="/reference/admin/api-keys">API Keys</a></td><td>Create, list, and revoke API keys</td></tr><tr><td><a class="" href="/reference/admin/users">Users</a></td><td>Create, list, update, and delete admin users</td></tr><tr><td><a class="" href="/reference/admin/labelers">Labelers</a></td><td>Manage external labeler subscriptions</td></tr><tr><td><a class="" href="/reference/admin/settings">Instance Settings</a></td><td>Configure app name, logo, and policy URLs</td></tr><tr><td><a class="" href="/reference/admin/domains">Domains</a></td><td>Manage domains and their OAuth client identities</td></tr><tr><td><a class="" href="/reference/admin/script-variables">Script Variables</a></td><td>Encrypted key/value pairs for Lua scripts</td></tr><tr><td><a class="" href="/reference/admin/api-clients">API Clients</a></td><td>Register and manage third-party XRPC clients</td></tr><tr><td><a class="" href="/reference/admin/plugins">Plugins</a></td><td>Install, configure, and manage WASM plugins</td></tr></tbody></table><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="permissions">Permissions<a href="#permissions" class="hash-link" aria-label="Direct link to Permissions" title="Direct link to Permissions" translate="no"></a></h2><p>Each admin API endpoint requires a specific permission. See the <a class="" href="/guides/permissions">Permissions guide</a> for the full list of permissions and templates.</p><table><thead><tr><th>Endpoint</th><th>Required Permission</th></tr></thead><tbody><tr><td><code>POST /admin/lexicons</code></td><td><code>lexicons:create</code></td></tr><tr><td><code>GET /admin/lexicons</code></td><td><code>lexicons:read</code></td></tr><tr><td><code>GET /admin/lexicons/{id}</code></td><td><code>lexicons:read</code></td></tr><tr><td><code>DELETE /admin/lexicons/{id}</code></td><td><code>lexicons:delete</code></td></tr><tr><td><code>POST /admin/network-lexicons</code></td><td><code>lexicons:create</code></td></tr><tr><td><code>GET /admin/network-lexicons</code></td><td><code>lexicons:read</code></td></tr><tr><td><code>DELETE /admin/network-lexicons/{id}</code></td><td><code>lexicons:delete</code></td></tr><tr><td><code>GET /admin/stats</code></td><td><code>stats:read</code></td></tr><tr><td><code>POST /admin/backfill</code></td><td><code>backfill:create</code></td></tr><tr><td><code>GET /admin/backfill/status</code></td><td><code>backfill:read</code></td></tr><tr><td><code>GET /admin/events</code></td><td><code>events:read</code></td></tr><tr><td><code>POST /admin/api-keys</code></td><td><code>api-keys:create</code></td></tr><tr><td><code>GET /admin/api-keys</code></td><td><code>api-keys:read</code></td></tr><tr><td><code>DELETE /admin/api-keys/{id}</code></td><td><code>api-keys:delete</code></td></tr><tr><td><code>POST /admin/users</code></td><td><code>users:create</code></td></tr><tr><td><code>GET /admin/users</code></td><td><code>users:read</code></td></tr><tr><td><code>GET /admin/users/{id}</code></td><td><code>users:read</code></td></tr><tr><td><code>PATCH /admin/users/{id}/permissions</code></td><td><code>users:update</code></td></tr><tr><td><code>DELETE /admin/users/{id}</code></td><td><code>users:delete</code></td></tr><tr><td><code>POST /admin/users/transfer-super</code></td><td>Super user only</td></tr><tr><td><code>GET /admin/script-variables</code></td><td><code>script-variables:read</code></td></tr><tr><td><code>POST /admin/script-variables</code></td><td><code>script-variables:create</code></td></tr><tr><td><code>DELETE /admin/script-variables/{key}</code></td><td><code>script-variables:delete</code></td></tr><tr><td><code>POST /admin/labelers</code></td><td><code>labelers:create</code></td></tr><tr><td><code>GET /admin/labelers</code></td><td><code>labelers:read</code></td></tr><tr><td><code>PATCH /admin/labelers/{did}</code></td><td><code>labelers:create</code></td></tr><tr><td><code>DELETE /admin/labelers/{did}</code></td><td><code>labelers:delete</code></td></tr><tr><td><code>GET /admin/settings</code></td><td><code>settings:manage</code></td></tr><tr><td><code>PUT /admin/settings/{key}</code></td><td><code>settings:manage</code></td></tr><tr><td><code>DELETE /admin/settings/{key}</code></td><td><code>settings:manage</code></td></tr><tr><td><code>PUT /admin/settings/logo</code></td><td><code>settings:manage</code></td></tr><tr><td><code>DELETE /admin/settings/logo</code></td><td><code>settings:manage</code></td></tr><tr><td><code>GET /admin/plugins</code></td><td><code>plugins:read</code></td></tr><tr><td><code>POST /admin/plugins</code></td><td><code>plugins:create</code></td></tr><tr><td><code>POST /admin/plugins/preview</code></td><td><code>plugins:read</code></td></tr><tr><td><code>GET /admin/plugins/official</code></td><td><code>plugins:read</code></td></tr><tr><td><code>DELETE /admin/plugins/{id}</code></td><td><code>plugins:delete</code></td></tr><tr><td><code>POST /admin/plugins/{id}/reload</code></td><td><code>plugins:create</code></td></tr><tr><td><code>POST /admin/plugins/{id}/check-update</code></td><td><code>plugins:read</code></td></tr><tr><td><code>GET /admin/plugins/{id}/secrets</code></td><td><code>plugins:read</code></td></tr><tr><td><code>PUT /admin/plugins/{id}/secrets</code></td><td><code>plugins:create</code></td></tr><tr><td><code>GET /admin/domains</code></td><td><code>settings:manage</code></td></tr><tr><td><code>POST /admin/domains</code></td><td><code>settings:manage</code></td></tr><tr><td><code>DELETE /admin/domains/{id}</code></td><td><code>settings:manage</code></td></tr><tr><td><code>POST /admin/domains/{id}/primary</code></td><td><code>settings:manage</code></td></tr><tr><td><code>GET /admin/api-clients</code></td><td><code>api-clients:view</code></td></tr><tr><td><code>POST /admin/api-clients</code></td><td><code>api-clients:create</code></td></tr><tr><td><code>GET /admin/api-clients/{id}</code></td><td><code>api-clients:view</code></td></tr><tr><td><code>PUT /admin/api-clients/{id}</code></td><td><code>api-clients:edit</code></td></tr><tr><td><code>DELETE /admin/api-clients/{id}</code></td><td><code>api-clients:delete</code></td></tr></tbody></table></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/reference/xrpc-api"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">XRPC API</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reference/admin/lexicons"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Lexicons</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_X45M thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#auth" class="table-of-contents__link toc-highlight">Auth</a></li><li><a href="#errors" class="table-of-contents__link toc-highlight">Errors</a></li><li><a href="#endpoint-groups" class="table-of-contents__link toc-highlight">Endpoint groups</a></li><li><a href="#permissions" class="table-of-contents__link toc-highlight">Permissions</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://birb.house">Birbhouse Games</a>.</div></div></div></footer></div></body></html>