Get Instance Setting

GET /api/v1/instance/settings/{key}

InstanceService · InstanceService_GetInstanceSetting

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义；本站不会向真实服务执行示例。

访问权限

读取策略取决于键：STORAGE 与 NOTIFICATION 需要实例 ADMIN，AI 需要认证，允许启动读取的键可匿名读取。批量读取会逐项应用同样检查。

实际可调用的设置路由

协议 HTTP 注解实际绑定 /api/v1/instance/settings/{KEY}，例如 /api/v1/instance/settings/GENERAL。下方 /api/v1/instance/{instance}/* 是生成的 OpenAPI 表达，不应按字面发送带星号的 URL。更新时 JSON 请求体为 InstanceSetting 对象，载荷必须匹配设置键，资源 name 由 URL 提供。

读取已知设置

此只读示例检查 GENERAL。STORAGE 与 NOTIFICATION 需要管理员，AI 需要认证。已存储的 S3、SMTP 与 AI 凭据会被隐藏。BASIC 是兼容旧版本的键，仅返回名称而非秘密。

curl --fail-with-body \
  -H "Authorization: Bearer $MEMOS_TOKEN" \
  "$MEMOS_URL/api/v1/instance/settings/GENERAL"

请求

Gets an instance setting.

GET/api/v1/instance/settings/{key}

生成的 OpenAPI 将此路径表达为 /api/v1/instance/{instance}/*. 实际调用请使用上方 Rust 路由；下载的接口定义保留原始内容。

协议声明的参数

下表中名为 instance 的生成路径参数属于协议元数据。实际调用上方路由时，应将 {key} 替换为 GENERAL 这样的设置键，不要发送字面星号。

名称 / 位置	类型 / 是否必需	描述
`instance` path	string 必需	The instance id.

请求体

未声明请求体。

响应

200 · OK

application/json · InstanceSetting

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义

{
  "tags": [
    "InstanceService"
  ],
  "description": "Gets an instance setting.",
  "operationId": "InstanceService_GetInstanceSetting",
  "parameters": [
    {
      "name": "instance",
      "in": "path",
      "description": "The instance id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/InstanceSetting"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}