项目级别安全文件 API

  • 引入于极狐GitLab 14.8。功能标志ci_secure_files,默认禁用。
  • 功能标志移除于极狐GitLab 15.7。

每个项目限制为 100 个安全文件。文件必须小于 5 MB。

列出项目安全文件

获取项目中的安全文件列表。

GET /projects/:project_id/secure_files

支持的参数:

参数 类型 是否必需 描述
project_id integer/string Yes 授权用户拥有的项目 ID 或 URL 编码的路径

请求示例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files"

响应示例:

[
    {
        "id": 1,
        "name": "myfile.jks",
        "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
        "checksum_algorithm": "sha256",
        "created_at": "2022-02-22T22:22:22.222Z",
        "expires_at": null,
        "metadata": null
    },
    {
        "id": 2,
        "name": "myfile.cer",
        "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aa2",
        "checksum_algorithm": "sha256",
        "created_at": "2022-02-22T22:22:22.222Z",
        "expires_at": "2022-09-21T14:56:00.000Z",
        "metadata": {
            "id":"75949910542696343243264405377658443914",
            "issuer": {
                "C":"US",
                "O":"Apple Inc.",
                "CN":"Apple Worldwide Developer Relations Certification Authority",
                "OU":"G3"
            },
            "subject": {
                "C":"US",
                "O":"Organization Name",
                "CN":"Apple Distribution: Organization Name (ABC123XYZ)",
                "OU":"ABC123XYZ",
                "UID":"ABC123XYZ"
            },
            "expires_at":"2022-09-21T14:56:00.000Z"
        }
    }
]

显示安全文件详细信息

获取项目中特定安全文件的详细信息。

GET /projects/:project_id/secure_files/:id

支持的参数:

参数 类型 是否必需 描述
project_id integer/string Yes 授权用户拥有的项目 ID 或 URL 编码的路径
id integer Yes 安全文件的 id

请求示例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files/1"

响应示例:

{
  "id": 1,
  "name": "myfile.jks",
  "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
  "checksum_algorithm": "sha256",
  "created_at": "2022-02-22T22:22:22.222Z",
  "expires_at": null,
  "metadata": null
}

创建安全文件

创建新的安全文件。

POST /projects/:project_id/secure_files

支持的参数:

参数 类型 是否必需 描述
project_id integer/string Yes 授权用户拥有的项目 ID 或 URL 编码的路径
name string Yes 上传的文件的 name。文件名在项目中必须唯一
file file Yes 上传的 file(限制为 5 MB)

请求示例:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/1/secure_files"  --form "name=myfile.jks" --form "file=@/path/to/file/myfile.jks"

响应示例:

{
  "id": 1,
  "name": "myfile.jks",
  "checksum": "16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac",
  "checksum_algorithm": "sha256",
  "created_at": "2022-02-22T22:22:22.222Z",
  "expires_at": null,
  "metadata": null
}

下载安全文件

下载项目安全文件的内容。

GET /projects/:project_id/secure_files/:id/download

支持的参数:

参数 类型 是否必需 描述
project_id integer/string Yes 授权用户拥有的项目 ID 或 URL 编码的路径
id integer Yes 安全文件的 id

请求示例:

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/secure_files/1/download --output myfile.jks

移除安全文件

移除项目的安全文件。

DELETE /projects/:project_id/secure_files/:id

支持的参数:

参数 类型 是否必需 描述
project_id integer/string Yes 授权用户拥有的项目 ID 或 URL 编码的路径
id integer Yes 安全文件的 id

请求示例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/secure_files/1"