GitLab Attestations API

openapi: 3.2.0
info:
  title: GitLab REST Attestations 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: Attestations
  description: 'Use this API to retrieve and download provenance attestations for a project.


    > [!note]

    > The availability of these endpoints is controlled by a feature flag. They are available for

    > testing, but not ready for production use.'
  x-displayName: Attestations
  externalDocs:
    url: https://docs.gitlab.com/api/attestations/
paths:
  /api/v4/projects/{id}/attestations/{subject_digest}:
    get:
      operationId: getApiV4ProjectsIdAttestationsSubjectDigest
      summary: List all attestations for a project
      description: Lists all attestations for a specified project and artifact hash. This feature was introduced in GitLab 18.7.
      tags:
      - Attestations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSupplyChainAttestation'
        '404':
          description: Artifact SHA-256 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: subject_digest
        required: true
        description: Hex-encoded SHA-256 hash of the artifact.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/attestations/{attestation_iid}/download:
    get:
      operationId: getApiV4ProjectsIdAttestationsAttestationIidDownload
      summary: Retrieve an attestation bundle
      description: This feature was introduced in GitLab 18.7
      tags:
      - Attestations
      responses:
        '200':
          description: OK
        '404':
          description: Artifact SHA-256 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: attestation_iid
        required: true
        description: Internal ID of the attestation, as returned by the list attestations API endpoint.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
components:
  schemas:
    APIEntitiesSupplyChainAttestation:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 14
        created_at:
          type: string
          format: date-time
          example: '2025-09-17T02:26:10.898Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-09-17T02:26:10.898Z'
        expire_at:
          type: string
          format: date-time
          example: '2025-09-17T02:26:10.898Z'
        project_id:
          type: integer
          format: int64
        build_id:
          type: integer
          format: int64
        status:
          type: string
          example: success
        predicate_kind:
          type: string
          example: provenance
        predicate_type:
          type: string
          example: https://slsa.dev/provenance/v1
        subject_digest:
          type: string
          example: 5db1fee4b5703808c48078a76768b155b421b210c0761cd6a5d223f4d99f1eaa
        download_url:
          type: string
  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