frp

frp Clients API

Connected client inventory

Documentation GitHub OpenAPI

Operations 2

GET /api/clients List clients #

GET /api/clients/{key} Get client detail #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/frp:frp-clients-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

openapi: 3.2.0
info:
  title: frp Server Admin Clients API
  description: The frp server (frps) exposes a built-in HTTP admin API on its dashboard web server. The API returns runtime information about the frps process, connected clients, and active proxies, and lets operators inspect proxy traffic statistics or clear offline proxies. All routes (except /healthz) require HTTP Basic authentication using the dashboard user and password configured in webServer.user and webServer.password.
  version: 0.0.1
  contact:
    name: frp
    url: https://gofrp.org/
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://{host}:{port}
  description: frp server dashboard (frps webServer)
  variables:
    host:
      default: localhost
      description: Address where frps webServer is listening (webServer.addr)
    port:
      default: '7500'
      description: Port where frps webServer is listening (webServer.port)
security:
- BasicAuth: []
tags:
- name: Clients
  description: Connected client inventory
paths:
  /api/clients:
    get:
      tags:
      - Clients
      summary: List clients
      description: Returns the registry of clients (frpc instances) that have authenticated against the server, with optional filters for user, client identifier, run identifier, and online status.
      operationId: listClients
      parameters:
      - name: user
        in: query
        description: Filter by client user name
        schema:
          type: string
      - name: clientId
        in: query
        description: Filter by client identifier
        schema:
          type: string
      - name: runId
        in: query
        description: Filter by frpc run identifier
        schema:
          type: string
      - name: status
        in: query
        description: Filter by online status
        schema:
          type: string
          enum:
          - all
          - online
          - offline
      responses:
        '200':
          description: Clients matching the filter
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientInfo'
  /api/clients/{key}:
    get:
      tags:
      - Clients
      summary: Get client detail
      description: Returns detail for a single client identified by its registry key.
      operationId: getClient
      parameters:
      - name: key
        in: path
        required: true
        description: Registry key for the client
        schema:
          type: string
      responses:
        '200':
          description: Client detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientInfo'
        '404':
          description: Client not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
        msg:
          type: string
    ClientInfo:
      type: object
      properties:
        key:
          type: string
        user:
          type: string
        clientId:
          type: string
        runId:
          type: string
        version:
          type: string
        hostname:
          type: string
        clientIp:
          type: string
        firstConnectedAt:
          type: integer
          format: int64
        lastConnectedAt:
          type: integer
          format: int64
        disconnectedAt:
          type: integer
          format: int64
        online:
          type: boolean
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth using webServer.user and webServer.password