[GH-ISSUE #3113] Documentation for API for remote management and status check

gitea-mirror commented

2026-05-05 13:36:22 -06:00

Owner

Copy link

Originally created by @Palezvar on GitHub (Sep 29, 2022).
Original GitHub issue: https://github.com/fatedier/frp/issues/3113

Bug Description

Are there any APIs on FRP that we can use to check the current status of proxies and get some details for each.

If so, is any documentation available?

Thanks,

frpc Version

0.44

frps Version

0.44

System Architecture

linux/amd64

Configurations

admin_addr = 127.0.0.1
admin_port = 7400

Logs

No response

Steps to reproduce

...

Affected area

Docs
Installation
Performance and Scalability
Security
User Experience
Test and Release
Developer Infrastructure
Client Plugin
Server Plugin
Extensions
Others

Originally created by @Palezvar on GitHub (Sep 29, 2022). Original GitHub issue: https://github.com/fatedier/frp/issues/3113 ### Bug Description Are there any APIs on FRP that we can use to check the current status of proxies and get some details for each. If so, is any documentation available? Thanks, ### frpc Version 0.44 ### frps Version 0.44 ### System Architecture linux/amd64 ### Configurations admin_addr = 127.0.0.1 admin_port = 7400 ### Logs _No response_ ### Steps to reproduce 1. 2. 3. ... ### Affected area - [X] Docs - [ ] Installation - [ ] Performance and Scalability - [ ] Security - [X] User Experience - [ ] Test and Release - [ ] Developer Infrastructure - [ ] Client Plugin - [ ] Server Plugin - [ ] Extensions - [ ] Others

gitea-mirror

2026-05-05 13:36:22 -06:00

closed this issue
added the
lifecycle/stale
label

gitea-mirror commented

2026-05-05 13:36:26 -06:00

Author

Owner

Copy link

@Becods commented on GitHub (Sep 29, 2022):

https://github.com/fatedier/frp/pull/1668

9d077b02cf/server/dashboard_api.go (L35-L52)

@Becods commented on GitHub (Sep 29, 2022): https://github.com/fatedier/frp/pull/1668 or https://github.com/fatedier/frp/blob/9d077b02cfd6967d0f2aa06f5f65cc3239bbac3f/server/dashboard_api.go#L35-L52

gitea-mirror commented

2026-05-05 13:36:27 -06:00

Author

Owner

Copy link

@Palezvar commented on GitHub (Sep 29, 2022):

Can you please elaborate on this one.

Can I actually access different proxy details and status externally using Postman or Curl? If so, what is the syntax?

My use case is that I am trying to detect new proxy connections and take some customs against them. That is the reason I am looking for an API to get a list of proxies and their details.

Thanks,

@Palezvar commented on GitHub (Sep 29, 2022): Can you please elaborate on this one. Can I actually access different proxy details and status externally using Postman or Curl? If so, what is the syntax? My use case is that I am trying to detect new proxy connections and take some customs against them. That is the reason I am looking for an API to get a list of proxies and their details. Thanks,

gitea-mirror commented

2026-05-05 13:36:28 -06:00

Author

Owner

Copy link

@Palezvar commented on GitHub (Oct 2, 2022):

folks, is there anyway for me to access the proxy details such as "name", "domain", "status", "encryption" remotely via an API? If not, maybe there is another method you could recommend me to harness this data via a script that runs locally on the frp server.

Please advise.

@Palezvar commented on GitHub (Oct 2, 2022): folks, is there anyway for me to access the proxy details such as "name", "domain", "status", "encryption" remotely via an API? If not, maybe there is another method you could recommend me to harness this data via a script that runs locally on the frp server. Please advise.

gitea-mirror commented

2026-05-05 13:36:29 -06:00

Author

Owner

Copy link

@github-actions[bot] commented on GitHub (Nov 2, 2022):

Issues go stale after 30d of inactivity. Stale issues rot after an additional 7d of inactivity and eventually close.

@github-actions[bot] commented on GitHub (Nov 2, 2022): Issues go stale after 30d of inactivity. Stale issues rot after an additional 7d of inactivity and eventually close.

No Branch/Tag specified