frp

frp is an open-source fast reverse proxy that exposes services running behind a NAT or firewall to the public internet. Both the server (frps) and the client (frpc) include built-in HTTP admin APIs that operators can use to inspect runtime status, manage proxies and visitors, hot-reload configuration, and scrape Prometheus metrics.

frp publishes 9 API contracts indexed on the APIs.io network, including Clients API, Configuration API, Health API, and 6 more. Tagged areas include NAT Traversal, Reverse Proxy, Tunneling, and Open Source.

The frp catalog on APIs.io includes 1 Spectral governance ruleset.

frp’s developer surface includes authentication, documentation, getting-started guide, release notes, and 11 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

29.5/100 thin ▬ flat Agent 24/100 agent aware self hosted · Apache-2.0 Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →

AccessFreemiumSelf serve

2 published contracts

NAT TraversalReverse Proxy Tunneling Open Source

Kin Score

Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0

Composite quality — 29.5/100 · thin

Contract Quality 9.4 / 19

Developer Ergonomics 5.0 / 15

Access Clarity 1.9 / 15

Operational Transparency 2.6 / 10

Contract Governance 1.2 / 9

Discoverability 3.6 / 8

Regulatory Posture 0.9 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 24/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 0 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/frp/"><img src="https://apis.io/badge/frp/card.svg" alt="frp on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0 Ask about this →
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link Ask about this →
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document Ask about this →
Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented) Ask about this →

9 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 12.8 — up to +17.4 composite points Ask about this →
Developer Ergonomics scores 33.3 — up to +13.3 composite points Ask about this →
Contract Quality scores 50.2 — up to +12.5 composite points Ask about this →

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/frp/apis.yml: open an issue on github.com/api-evangelist/frp to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Network Edge (CDN, networking, peering, edge compute)	undeclared	-	-	-
Cisco DevNet Ecosystem (builders on Meraki, Catalyst, ISE, ThousandEyes, Splunk)	undeclared	-	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 9

Individual APIs this provider publishes, each with its own machine-readable definition.

frp Clients API

Connected client inventory

frp Configuration API

Read and replace the in-memory frpc configuration

frp Health API

Liveness probe

frp Lifecycle API

Reload and stop the running frpc process

frp Metrics API

Prometheus metrics endpoint

frp Proxies API

Active proxy inventory and traffic stats

frp Server API

Server runtime information

frp Status API

Runtime status of proxies and visitors

frp Store API

Persistent configuration store for proxies and visitors

Scroll for all 9

Open Collections 11

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

frp Client Admin API

OPEN COLLECTION

frp Client Admin Clients API

OPEN COLLECTION

frp Client Admin Clients Configuration API

OPEN COLLECTION

frp Client Admin Clients Health API

OPEN COLLECTION

frp Client Admin Clients Lifecycle API

OPEN COLLECTION

frp Client Admin Clients Metrics API

OPEN COLLECTION

frp Client Admin Clients Proxies API

OPEN COLLECTION

frp Server Admin API

OPEN COLLECTION

frp Client Admin Clients Server API

OPEN COLLECTION

frp Client Admin Clients Status API

OPEN COLLECTION

frp Client Admin Clients Store API

OPEN COLLECTION

Scroll for all 11

frp API pricing

Not yet checked against frp's own pricing page. Compiled by API Evangelist on 2026-05-04; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Free freemium	Free
Professional paid	Free
Enterprise enterprise	—

Plan details, limits and sources →

Rate limits

Free Tier Default: 10 requests per minute
Free Tier Monthly Quota: 1000 requests per month
Professional Tier Default: 100 requests per minute

Compiled by API Evangelist, not yet checked against frp's documentation. All 5 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

frp Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

frp Rate Limits

5 limits

RATE LIMITS

Terms of Service 1

What its API terms permit and prohibit, quoted from its own page.

frp

5 quoted statements, read from frp's own page on 2026-11-09.

TERMS

Data License 1

How its data and outputs may be reused, quoted from its own terms.

frp

2 quoted statements, read from frp's own page on 2026-11-09.

LICENSE

FinOps 1

Cost, billing, and metering signals for API financial operations.

frp Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

frp API Rules

63 rules · 55 error-severity 7 warn-severity 1 info-severity

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

frp Authentication

http · 1 scheme

SECURITY

frp Domain Security

TLSv1.3 · HSTS · DNSSEC

SECURITY

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

frp Agentic Access

28 operations · 9 acting · 1 human-in-the-loop

28 operations · 9 acting

AGENTIC

Resources

Get Started 1

Portal, sign-up, and the first successful call

GettingStarted

GettingStarted

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

SourceCode

SourceCode

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 3

Status, limits, changes, and where to get help

RateLimits

RateLimits

Issues

Issues

ReleaseNotes

ReleaseNotes

Commercial 5

Pricing, plans, and the legal terms of use

Plans

FinOps

License

UsageTerms

DataLicense

Company 1

The organization behind the API

Website

Website

Source (apis.yml)

aid: frp
name: frp
description: frp is an open-source fast reverse proxy that exposes services running behind a NAT or firewall to the public
  internet. Both the server (frps) and the client (frpc) include built-in HTTP admin APIs that operators can use to inspect
  runtime status, manage proxies and visitors, hot-reload configuration, and scrape Prometheus metrics.
type: Index
deliveryModel:
  model: self-hosted
  license: Apache-2.0
  license_evidence:
    repo: fatedier/frp
    spdx: Apache-2.0
    stars: 109623
  open_source: true
  commercial: false
  callable_host: false
  label: Self-hosted open source · you run it yourself
  confidence: medium
  source:
  - openapi
  - repository-license
  generated: '2026-09-25'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  try_now_blocked_by: loopback
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-13'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/frp.png
access: Open Source
created: '2026-03-27'
modified: '2026-05-19'
tags:
- NAT Traversal
- Reverse Proxy
- Tunneling
- Open Source
tags_raw:
- NAT Traversal
- Reverse Proxy
- Tunneling
- Open Source
- Open-Source
url: https://raw.githubusercontent.com/api-evangelist/frp/refs/heads/main/apis.yml
specificationVersion: '0.23'
apis:
- aid: frp:frp-clients-api
  name: frp Clients API
  description: Connected client inventory
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Clients
  properties:
  - type: OpenAPI
    url: openapi/frp-clients-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-configuration-api
  name: frp Configuration API
  description: Read and replace the in-memory frpc configuration
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Configuration
  properties:
  - type: OpenAPI
    url: openapi/frp-configuration-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-health-api
  name: frp Health API
  description: Liveness probe
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/frp-health-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-lifecycle-api
  name: frp Lifecycle API
  description: Reload and stop the running frpc process
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Lifecycle
  properties:
  - type: OpenAPI
    url: openapi/frp-lifecycle-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-metrics-api
  name: frp Metrics API
  description: Prometheus metrics endpoint
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Metrics
  properties:
  - type: OpenAPI
    url: openapi/frp-metrics-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-proxies-api
  name: frp Proxies API
  description: Active proxy inventory and traffic stats
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Proxies
  properties:
  - type: OpenAPI
    url: openapi/frp-proxies-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-server-api
  name: frp Server API
  description: Server runtime information
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Servers
  tags_raw:
  - Server
  properties:
  - type: OpenAPI
    url: openapi/frp-server-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-status-api
  name: frp Status API
  description: Runtime status of proxies and visitors
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Status
  properties:
  - type: OpenAPI
    url: openapi/frp-status-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
- aid: frp:frp-store-api
  name: frp Store API
  description: Persistent configuration store for proxies and visitors
  humanURL: https://gofrp.org/en/docs/features/common/server-dashboard/
  baseURL: http://localhost:7500
  tags:
  - Store
  properties:
  - type: OpenAPI
    url: openapi/frp-store-api-openapi.yml
  - type: Documentation
    url: https://gofrp.org/en/docs/features/common/server-dashboard/
  - type: Documentation
    url: https://gofrp.org/en/docs/reference/client-configures/
common:
- type: Plans
  url: plans/frp-plans-pricing.yml
- type: RateLimits
  url: rate-limits/frp-rate-limits.yml
- type: FinOps
  url: finops/frp-finops.yml
- type: AgenticAccess
  url: agentic-access/frp-agentic-access.yml
- type: DomainSecurity
  url: security/frp-domain-security.yml
- type: Authentication
  url: authentication/frp-authentication.yml
- type: Website
  url: https://gofrp.org/
- type: Documentation
  url: https://gofrp.org/en/docs/
- type: GettingStarted
  url: https://gofrp.org/en/docs/setup/
- type: SourceCode
  url: https://github.com/fatedier/frp
- type: Issues
  url: https://github.com/fatedier/frp/issues
- type: ReleaseNotes
  url: https://github.com/fatedier/frp/releases
- type: License
  url: https://github.com/fatedier/frp/blob/master/LICENSE
- type: UsageTerms
  url: terms/frp-terms-of-service.yml
- type: DataLicense
  url: data-license/frp-data-license.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

frp API — frequently asked questions

Does frp have an API?

Yes. APIs.io lists 9 APIs from frp, including frp Clients API, frp Configuration API and frp Health API, and 6 more.

Is there an OpenAPI specification for the frp API?

Yes. APIs.io indexes 9 OpenAPI specifications for frp, each linked for download from this page.

How do I authenticate with the frp API?

frp uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as frp Authentication.

How much does the frp API cost?

APIs.io lists 3 pricing plans for frp, with each plan's price, limits and inclusions under Pricing on this page.

Is the frp API ready for AI agents?

frp has a Kin Score of 29.5 out of 100 (thin) and an Agent Readiness score of 24.4 (agent-aware), scored by API Evangelist on 2026-11-13.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/frp"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/frp/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/frp/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.