A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.
import { Carbon } from "@/components/carbon";
import { IconArrowRight } from "@tabler/icons-react";
import { pageMetadata } from "@/lib/metadata";
import Link from "next/link";
import { DocsPage } from "fumadocs-ui/layouts/docs/page";
import { apiSource } from "@/lib/openapi";
export const metadata = pageMetadata({
path: "/api-reference",
title: "API reference",
description: "Interactive reference for Homarr's HTTP API.",
});
export default function ApiReferenceIndexPage() {
const groups = apiSource.pageTree.children.filter((node) => node.type === "folder");
return (
<DocsPage full breadcrumb={{ enabled: false }} footer={{ enabled: false }}>
<header className="homarr-content-header max-w-2xl">
<p className="text-sm font-medium text-fd-primary">OpenAPI</p>
<h1 className="homarr-content-title mt-2">Homarr API reference</h1>
<p className="homarr-content-lead">
Browse request parameters and response schemas, enter your Homarr instance’s full URL in Server URL, then
review examples or send a test request from your browser.
</p>
</header>
<div className="mt-10 grid gap-6 lg:grid-cols-2">
{groups.map((group) => (
<section key={String(group.name)} className="min-w-0 rounded-xl border bg-fd-card p-5">
<h2 className="text-lg font-semibold">{group.name}</h2>
<div className="mt-3 divide-y border-t">
{group.children.map((page) => {
if (page.type !== "page") return null;
return (
<Link
key={page.url}
href={page.url}
className="group flex items-center gap-3 py-3 hover:bg-fd-accent/50"
>
<span className="min-w-0 flex-1 font-medium">{page.name}</span>
<IconArrowRight className="shrink-0 text-fd-muted-foreground" aria-hidden size={17} />
</Link>
);
})}
</div>
</section>
))}
</div>
<Carbon />
</DocsPage>
);
}