Admin API 密钥

Admin API 密钥用于控制对 APISIX Admin API 端点的访问，仅允许授权用户通过 Admin API 管理 APISIX 资源。

密钥要求和权限

强烈建议你在生产环境中开启 Admin API 密钥的强制要求，并配置一组复杂的密钥以加强 APISIX 实例的安全性。

示例 配置文件 记录了以下详细信息，其中默认情况下需要 Admin API 密钥并设置为空字符串：

config.yaml.example

deployment:
  admin:
    admin_key_required: true
    admin_key:
      -
        name: admin
        key: ''
        role: admin    # 读写访问
      -
        name: viewer
        key: 4054f7cf07e344346cd3f287985e76a2
        role: viewer   # 只读访问

如果你未配置自定义 Admin API 密钥，APISIX 将在运行时自动生成一个密钥。

要为你的部署自定义这些配置，请将自定义配置添加到 config.yaml 配置文件 并 重新加载 APISIX 以使更改生效。

其他 Admin API 安全选项

除了设置 Admin API 密钥外，你还可以自定义其他配置以进一步保护 Admin API，例如：

• Admin API CORS
• Admin API 访问 IP 白名单
• Admin API mTLS

有关配置选项的完整列表，请参阅 config.yaml.example。