GitLab Secure files API

openapi: 3.2.0
info:
  title: GitLab REST Secure files API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Secure files
  description: Use this API to manage secure files for a project.
  x-displayName: Secure files
  externalDocs:
    url: https://docs.gitlab.com/api/secure_files/
paths:
  /api/v4/projects/{id}/secure_files:
    get:
      operationId: getApiV4ProjectsIdSecureFiles
      summary: List all secure files for a project
      description: Lists all secure files for a specified project.
      tags:
      - Secure files
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiSecureFile'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdSecureFiles
      summary: Create a secure file
      description: Creates a secure file in a specified project.
      tags:
      - Secure files
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiSecureFile'
        '400':
          description: 400 Bad Request
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdSecureFilesRequest'
  /api/v4/projects/{id}/secure_files/{secure_file_id}:
    get:
      operationId: getApiV4ProjectsIdSecureFilesSecureFileId
      summary: Retrieve details of a secure file
      description: Retrieves details of a specified secure file in a project.
      tags:
      - Secure files
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiSecureFile'
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: secure_file_id
        required: true
        description: ID of the secure file.
        schema:
          type: integer
        in: path
    delete:
      operationId: deleteApiV4ProjectsIdSecureFilesSecureFileId
      summary: Delete a secure file
      description: Deletes a specified secure file from a project.
      tags:
      - Secure files
      responses:
        '204':
          description: Resource deleted
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: secure_file_id
        required: true
        description: ID of the secure file.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/secure_files/{secure_file_id}/download:
    get:
      operationId: getApiV4ProjectsIdSecureFilesSecureFileIdDownload
      summary: Download a secure file
      description: Downloads the contents of a specified secure file in a project.
      tags:
      - Secure files
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: secure_file_id
        required: true
        description: ID of the secure file.
        schema:
          type: integer
        in: path
components:
  schemas:
    APIEntitiesCiSecureFile:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 123
        name:
          type: string
          example: upload-keystore.jks
        checksum:
          type: string
          example: 16630b189ab34b2e3504f4758e1054d2e478deda510b2b08cc0ef38d12e80aac
        checksum_algorithm:
          type: string
          example: sha256
        created_at:
          type: string
          format: date-time
          example: '2022-02-22T22:22:22.222Z'
        expires_at:
          type: string
          format: date-time
          example: '2023-09-21T14:55:59.000Z'
        metadata:
          type: object
          example:
            id: '75949910542696343243264405377658443914'
        file_extension:
          type: string
          example: jks
    postApiV4ProjectsIdSecureFilesRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: "The name of the file being uploaded. The filename must be unique within\n            the project"
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The secure file being uploaded
      required:
      - name
      - file
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header