跳转到主要内容

FASTPANEL API

简介

FASTPANEL® API 为您提供了一种无需依赖 Web 界面即可管理控制面板的灵活方式。 它有助于自动化日常操作、将 FASTPANEL® 与外部服务集成,并构建更高效的基础设施管理工作流。

令牌管理

提示

目前,API 令牌管理仅适用于运行在 Ubuntu 20.04 上的 FASTPANEL® 安装。

要打开 API 令牌管理部分,请点击 FASTPANEL® 界面右上角的用户名,然后选择“API tokens”。

要创建新的 API 令牌,请点击“Add API Token”。 随后会显示一个需要填写的表单:

  • Name — 令牌的任意名称。
  • Full API access — 如果需要完全访问权限,请保持启用。
  • Constraint IP — 将 API 访问限制为此字段中指定的 IP 地址。
  • Expires at — 令牌的过期日期。

要完成令牌创建,请点击“Add”。

重要

请务必保存该令牌——您将无法再次查看它!

使用令牌

详细的 FASTPANEL® API 文档可通过以下链接查看。

例如,要获取控制面板用户列表,您可以使用以下命令:

curl 'https://yourserverip.example/api/users?page=1&per_page=20' \
--header 'Authorization: YOUR_SECRET_TOKEN'

其中

  • YOUR_SECRET_TOKEN — 之前创建的令牌
  • yourserverip.example — 您服务器的 IP 地址或域名