PPanel Edgeinstall
由 openapi.json 自动生成的 2 个端点及其请求、响应和权限元数据。
此参考由已发布 API 契约生成。字段、请求头和权限要求如下。
下载完整 OpenAPI 文档 · SHA-256: ccaa20cec11fad96e369b88073ce3608a5b071ce55d6dc03fa31df7b0f08c525
标识符和数据结构与公开契约一致，说明直接给出调用规则。共享模型见 数据模型.
POST /api/v1/public/install
POST /api/v1/public/install
Run the one-time install wizard: site, first root, preset roles, default settings
{
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallResponse"
}
}
},
"description": "Installed"
},
"403": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "Install secret missing or invalid"
},
"409": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "platform.already_installed, platform.install_in_progress or an Idempotency-Key conflict"
},
"422": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "Validation failed"
},
"428": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "Idempotency-Key missing"
},
"429": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "Rate limited"
}
},
"summary": "Run the one-time install wizard: site, first root, preset roles, default settings",
"tags": [
"install"
],
"x-audit": "platform.install",
"x-body": "json",
"x-body-limit": 65536,
"x-idempotency": "required",
"x-rate-limit": "platform.install.ip",
"effectiveSecurity": []
}GET /api/v1/public/install/status
GET /api/v1/public/install/status
Installation state and what the wizard needs
{
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallStatus"
}
}
},
"description": "State"
},
"429": {
"content": {
"application/problem+json": {
"schema": {}
}
},
"description": "Rate limited"
}
},
"summary": "Installation state and what the wizard needs",
"tags": [
"install"
],
"x-body": "none",
"x-body-limit": 0,
"x-rate-limit": "platform.install_status.ip",
"effectiveSecurity": []
}