Skip to content

project API

API 参考/project

project API

project 分类下共有 34 个接口。接口详情、参数、请求体与响应均从项目 OpenAPI 规格自动生成。

GET/api/v1/projects我参与的项目列表(按创建时间倒序)↗POST/api/v1/projects创建项目(创建者自动成为 owner)↗GET/api/v1/projects/{projectId}项目详情(需 viewer 及以上)↗PATCH/api/v1/projects/{projectId}更新项目(需 admin 及以上,API Key 不可用)↗DELETE/api/v1/projects/{projectId}删除项目并级联清理成员/日志/域名/API Key/上传会话/存储(需 owner 及以上,API Key 不可用)↗GET/api/v1/projects/{projectId}/members项目成员列表(需 viewer 及以上)↗POST/api/v1/projects/{projectId}/members添加项目成员(需 admin 及以上,API Key 不可用;role 不可为 owner)↗DELETE/api/v1/projects/{projectId}/members/{userId}移除项目成员(需 admin 及以上,API Key 不可用;不可移除自己与 owner)↗POST/api/v1/projects/{projectId}/members/{userId}/transfer转让项目所有权(需 owner;原 owner 降为 admin)↗GET/api/v1/projects/{projectId}/logs项目操作日志(需 viewer 及以上)↗GET/api/v1/projects/{projectId}/storages项目存储列表(需 viewer 及以上,凭证仅以 has_credentials 标识)↗POST/api/v1/projects/{projectId}/storages绑定存储(需 admin 及以上,API Key 不可用;需项目开通 allow_s3 权益)↗GET/api/v1/projects/{projectId}/storages/{storageId}存储详情(需 viewer 及以上)↗PATCH/api/v1/projects/{projectId}/storages/{storageId}更新存储(需 admin 及以上,API Key 不可用;provider 不可改,提交 credentials 会重置为 pending)↗DELETE/api/v1/projects/{projectId}/storages/{storageId}删除存储(需 admin 及以上,API Key 不可用;级联解除域名绑定)↗POST/api/v1/projects/{projectId}/storages/{storageId}/test测试存储连通性(需 admin 及以上,API Key 不可用;失败也返回 200)↗POST/api/v1/projects/{projectId}/storages/{storageId}/default设为默认存储(需 admin 及以上,API Key 不可用;仅 active 存储可用)↗GET/api/v1/projects/{projectId}/domains项目域名列表(需 viewer 及以上)↗POST/api/v1/projects/{projectId}/domains接入自定义域名(需 admin 及以上,API Key 不可用;需项目开通 allow_custom_domain 权益)↗GET/api/v1/projects/{projectId}/domains/{domainId}域名详情(需 viewer 及以上)↗DELETE/api/v1/projects/{projectId}/domains/{domainId}删除域名(需 admin 及以上,API Key 不可用;异步清理并置为 deleting)↗POST/api/v1/projects/{projectId}/domains/{domainId}/configure触发域名配置(需 admin 及以上,API Key 不可用;异步 CNAME 配置)↗POST/api/v1/projects/{projectId}/domains/{domainId}/verify触发 TXT 所有权验证(需 admin 及以上,API Key 不可用)↗POST/api/v1/projects/{projectId}/domains/{domainId}/check-dns触发 CNAME 检测(需 admin 及以上,API Key 不可用)↗POST/api/v1/projects/{projectId}/domains/{domainId}/ssl上传或绑定域名证书(需 admin 及以上,API Key 不可用;仅返回元信息,不回传明文)↗GET/api/v1/projects/{projectId}/api-keys项目 API Key 列表(需 viewer 及以上,不含明文与哈希)↗POST/api/v1/projects/{projectId}/api-keys创建项目 API Key(需 admin 及以上,API Key 不可用;明文仅返回一次)↗DELETE/api/v1/projects/{projectId}/api-keys/{keyId}撤销项目 API Key(需 admin 及以上,API Key 不可用;软撤销)↗POST/api/v1/projects/{projectId}/uploads创建 Presigned 直传会话(需 developer 及以上;客户端直传对象存储,服务端不代理文件)↗POST/api/v1/projects/{projectId}/uploads/{uploadId}/confirm确认上传完成(需 developer 及以上;校验对象大小与类型,幂等,随后入队内容审核)↗DELETE/api/v1/projects/{projectId}/uploads/{uploadId}取消上传会话(需 developer 及以上;已上传对象一并删除)↗GET/api/v1/projects/{projectId}/files项目文件列表(需 viewer 及以上;prefix 必须以 `<项目slug>/` 开头)↗POST/api/v1/projects/{projectId}/files/presign生成文件下载签名 URL(需 developer 及以上;key 必须属于本项目且已通过审核)↗POST/api/v1/projects/{projectId}/files/purge刷新 CDN 缓存(需 admin 及以上,API Key 不可用;异步 cdn:purge 任务)↗