149 lines
7.3 KiB
HTML
149 lines
7.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-theme="dark">
|
|
<head>
|
|
<!-- Theme: FOUC-safe bootstrap (localStorage peardata.site.theme) -->
|
|
<script>
|
|
(function () {
|
|
try {
|
|
var t = localStorage.getItem('peardata.site.theme');
|
|
if (t !== 'light' && t !== 'dark') t = 'dark';
|
|
document.documentElement.setAttribute('data-theme', t);
|
|
var meta = document.querySelector('meta[name="theme-color"]');
|
|
if (meta) meta.setAttribute('content', t === 'light' ? '#f3f5f8' : '#0a0c10');
|
|
} catch (e) {
|
|
document.documentElement.setAttribute('data-theme', 'dark');
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<meta charset="UTF-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
|
|
<title>REST & access · PearData Docs</title>
|
|
<meta name="description" content="PearData local REST API on loopback and HyperDHT control plane access. Scripts, Prometheus, Grafana — no public metrics port." />
|
|
<meta name="keywords" content="PearData REST, localhost API, HyperDHT, Prometheus, Grafana" />
|
|
<meta name="author" content="HoneyPeer, LLC" />
|
|
<meta name="robots" content="index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1" />
|
|
<meta name="googlebot" content="index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1" />
|
|
<meta name="theme-color" content="#2dd4bf" />
|
|
<meta name="color-scheme" content="dark light" />
|
|
<meta name="application-name" content="PearData" />
|
|
<meta name="apple-mobile-web-app-title" content="PearData" />
|
|
<meta name="apple-mobile-web-app-capable" content="yes" />
|
|
<meta name="mobile-web-app-capable" content="yes" />
|
|
<meta name="msapplication-TileColor" content="#2dd4bf" />
|
|
<meta name="msapplication-config" content="/assets/favicons/browserconfig.xml" />
|
|
<meta name="format-detection" content="telephone=no" />
|
|
<link rel="canonical" href="https://peardata.rest/docs/holesail" />
|
|
<link rel="alternate" hreflang="en" href="https://peardata.rest/docs/holesail" />
|
|
<link rel="alternate" hreflang="x-default" href="https://peardata.rest/docs/holesail" />
|
|
|
|
<!-- Open Graph -->
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:site_name" content="PearData" />
|
|
<meta property="og:locale" content="en_US" />
|
|
<meta property="og:url" content="https://peardata.rest/docs/holesail" />
|
|
<meta property="og:title" content="REST & access · PearData Docs" />
|
|
<meta property="og:description" content="PearData local REST API on loopback and HyperDHT control plane access. Scripts, Prometheus, Grafana — no public metrics port." />
|
|
<meta property="og:image" content="https://peardata.rest/assets/brand/og-image.png" />
|
|
<meta property="og:image:secure_url" content="https://peardata.rest/assets/brand/og-image.png" />
|
|
<meta property="og:image:type" content="image/png" />
|
|
<meta property="og:image:width" content="1200" />
|
|
<meta property="og:image:height" content="630" />
|
|
<meta property="og:image:alt" content="PearData: decentralized P2P monitoring on HyperDHT" />
|
|
|
|
<!-- Twitter / X -->
|
|
<meta name="twitter:card" content="summary_large_image" />
|
|
<meta name="twitter:title" content="REST & access · PearData Docs" />
|
|
<meta name="twitter:description" content="PearData local REST API on loopback and HyperDHT control plane access. Scripts, Prometheus, Grafana — no public metrics port." />
|
|
<meta name="twitter:image" content="https://peardata.rest/assets/brand/twitter-card.png" />
|
|
<meta name="twitter:image:alt" content="PearData: decentralized P2P monitoring" />
|
|
|
|
<!-- Icons & PWA -->
|
|
<link rel="icon" href="/assets/favicons/favicon.ico" sizes="any" />
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicons/favicon-32x32.png" />
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicons/favicon-16x16.png" />
|
|
<link rel="icon" type="image/png" sizes="48x48" href="/assets/favicons/favicon-48x48.png" />
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/assets/favicons/apple-touch-icon.png" />
|
|
<link rel="manifest" href="/assets/favicons/site.webmanifest" />
|
|
<link rel="mask-icon" href="/assets/logo/peardata-wordmark.svg" color="#2dd4bf" />
|
|
|
|
<!-- Article -->
|
|
<meta property="article:section" content="Documentation" />
|
|
<meta property="article:author" content="HoneyPeer, LLC" />
|
|
<meta property="article:publisher" content="HoneyPeer, LLC" />
|
|
|
|
<script type="application/ld+json">
|
|
{
|
|
"@context": "https://schema.org",
|
|
"@type": [
|
|
"WebPage",
|
|
"TechArticle"
|
|
],
|
|
"name": "REST & access \u00b7 PearData Docs",
|
|
"description": "PearData local REST API on loopback and HyperDHT control plane access. Scripts, Prometheus, Grafana — no public metrics port.",
|
|
"url": "https://peardata.rest/docs/holesail",
|
|
"isPartOf": {
|
|
"@type": "WebSite",
|
|
"name": "PearData",
|
|
"url": "https://peardata.rest"
|
|
},
|
|
"publisher": {
|
|
"@type": "Organization",
|
|
"name": "HoneyPeer, LLC",
|
|
"url": "https://peardata.rest"
|
|
},
|
|
"inLanguage": "en-US",
|
|
"primaryImageOfPage": {
|
|
"@type": "ImageObject",
|
|
"url": "https://peardata.rest/assets/brand/og-image.png",
|
|
"width": 1200,
|
|
"height": 630
|
|
},
|
|
"headline": "REST & access \u00b7 PearData Docs"
|
|
}
|
|
</script>
|
|
|
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet" />
|
|
<link rel="stylesheet" href="/src/styles/global.css" />
|
|
<link rel="stylesheet" href="/src/styles/docs.css" />
|
|
<link rel="stylesheet" href="/src/styles/theme-light.css" />
|
|
</head>
|
|
<body>
|
|
<div class="bg-mesh" aria-hidden="true"></div>
|
|
<div data-nav data-prefix="../"></div>
|
|
|
|
<div class="docs-layout">
|
|
<aside class="docs-sidebar" data-docs-nav data-prefix="../"></aside>
|
|
<button type="button" class="docs-sidebar-toggle" aria-label="Docs menu">☰</button>
|
|
|
|
<article class="docs-main">
|
|
<h1>REST & access</h1>
|
|
<p class="docs-lead">PearData agents expose optional HTTP on loopback for scripts and scrapers. Remote access to the control plane is HyperDHT — not a public REST port.</p>
|
|
|
|
<h2>Local REST</h2>
|
|
<p>Default: <code>http://127.0.0.1:18888</code>. Disable with <code>PEARDATA_REST=0</code>.</p>
|
|
<pre><code>curl -s http://127.0.0.1:18888/api/v3/info
|
|
curl -s http://127.0.0.1:18888/api/v3/health
|
|
curl -s 'http://127.0.0.1:18888/api/v3/data?chart=system.cpu&after=-60&points=60'
|
|
curl -s http://127.0.0.1:18888/api/v3/ai/snapshot</code></pre>
|
|
|
|
<h2>P2P control plane</h2>
|
|
<p>Desktops dial the agent public key over HyperDHT + protomux-rpc. Roles and invites apply here. Do not expose the REST port to the internet.</p>
|
|
|
|
<h2>Optional tunnels</h2>
|
|
<p>If you use Holepunch-ecosystem tunnels for other services on the host, treat them as a separate data plane. PearData itself does not require them for metrics or QVAC.</p>
|
|
|
|
<div class="docs-pager">
|
|
<a class="prev" href="/docs/operator"><span>Prev</span><strong>← Operator</strong></a>
|
|
<a class="next" href="/docs/security"><span>Next</span><strong>Security →</strong></a>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div data-footer data-prefix="../"></div>
|
|
<script type="module" src="/src/js/site.js"></script>
|
|
</body>
|
|
</html>
|