POST /api/v1/projects/{projectId}/api-keys

POST/api/v1/projects/{projectId}/api-keys

创建项目 API Key（需 admin 及以上，API Key 不可用；明文仅返回一次）

projectoperationId: projectApiKeyCreate

请求参数

名称	类型	位置	必填	说明
`projectId`	string	path	是	项目 ID（UUID）。携带 `X-API-Key` 时按 API Key scope 鉴权，否则按 JWT + 项目成员角色鉴权

请求体

请求数据

Content-Type · application/json

{
  "type": "object",
  "required": [
    "name",
    "scopes"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "read",
          "upload",
          "delete"
        ]
      },
      "description": "至少 1 个"
    }
  }
}

请求示例

cURL

curl -X POST 'http://localhost:8080/api/v1/projects/{projectId}/api-keys' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: <PROJECT_API_KEY>'
# 也可使用登录会话：-H 'Authorization: Bearer <JWT>'

JavaScript

const res = await fetch('http://localhost:8080/api/v1/projects/{projectId}/api-keys', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'X-API-Key': '<PROJECT_API_KEY>'
  },
});
const data = await res.json();

Python

import requests

res = requests.post(
    'http://localhost:8080/api/v1/projects/{projectId}/api-keys',
    headers={'Accept': 'application/json', 'X-API-Key': '<PROJECT_API_KEY>'}
)
print(res.json())

响应

201创建成功，`api_key` 明文仅本次返回（pk_live_ 前缀）

application/json

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "project_id": {
          "type": "string",
          "format": "uuid"
        },
        "user_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "key_prefix": {
          "type": "string"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "read",
              "upload",
              "delete"
            ]
          }
        },
        "last_used_at": {
          "type": "string",
          "format": "date-time",
          "nullable": true
        },
        "revoked_at": {
          "type": "string",
          "format": "date-time",
          "nullable": true
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "api_key": {
          "type": "string"
        }
      }
    }
  ]
}

400请求参数错误

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

403无权限（未通过 RBAC 或 2FA）

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

在线调试

凭证仅保存在当前页面内存中

请求地址projectIdBearer Token

自定义请求 Header

请求体 · application/json