Binarly

Binarly Image API

The Image API from Binarly — 15 operation(s) for image.

GitHub OpenAPI

Operations 16

POST /api/v4/products/{productId}/images:upload Upload Image #
GET /api/v4/products/{productId}/images/{imageId} Get Image by ID #
PATCH /api/v4/products/{productId}/images/{imageId} Update Image by ID #
GET /api/v4/products/{productId}/images List Images #
POST /api/v4/products/{productId}/images:bulkArchive Bulk Archive Images #
POST /api/v4/products/{productId}/images:bulkUnarchive Bulk Unarchive Images #
GET /api/v4/products/{productId}/images/{imageId}/sbomReport:cycloneDX CycloneDX SBOM Report for an Image #
GET /api/v4/products/{productId}/images/{imageId}/sbomReport:SPDX SPDX SBOM Report for an Image #
GET /api/v4/products/{productId}/images/{imageId}/cbomReport:cycloneDX CBOM Report for an Image #
GET /api/v4/products/{productId}/images/{imageId}/vexReport:openVEX VEX Report for an Image in OpenVEX format #
GET /api/v4/products/{productId}/images/{imageId}/vexReport:cycloneDX VEX Report for an Image in CycloneDX format #
GET /api/v4/products/{productId}/images/{imageId}/findingsReport:pdf Image Findings PDF Report #
POST /api/v4/products/{productId}/images/{imageId}/findingsReport:download Download Image Report #
GET /api/v4/products/{productId}/images/{imageId}/cryptographicMaterialsReport Download Cryptographic Materials Report #
POST /api/v4/products/{productId}/images/{imageId}/advisoryReport Advisory Report #
POST /api/v4/products/{productId}/images/{imageId}/findingsReport:json Image Findings JSON Report #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/authentication/binarly-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/openapi/binarly-image-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/conventions/binarly-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/errors/binarly-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/lifecycle/binarly-lifecycle.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/data-model/binarly-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/conformance/binarly-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/agentic-access/binarly-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/binarly-image-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

binarly-image-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Binarly Assistant Image API
  version: 4.275.2
security:
- auth: []
tags:
- name: Image
paths:
  /api/v4/products/{productId}/images:upload:
    post:
      summary: Upload Image
      operationId: UploadImage
      x-permission: images.create
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - name: createScan
        in: query
        description: Create a Scan for the Image
        schema:
          type: boolean
          default: true
      - name: tempFileId
        in: query
        description: Temporary File ID of uploaded file
        required: false
        schema:
          $ref: '#/components/schemas/ULID'
      - name: imageName
        in: query
        description: Uploaded image name when body is empty
        required: false
        schema:
          type: string
      - name: version
        in: query
        description: Uploaded image version when body is empty
        required: false
        schema:
          type: string
      - name: filename
        in: query
        description: Uploaded image filename when body is empty
        required: false
        schema:
          type: string
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImageUpload'
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}:
    get:
      summary: Get Image by ID
      operationId: GetImage
      x-permission: products.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - name: withCounts
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    patch:
      summary: Update Image by ID
      operationId: UpdateImage
      x-permission: images.update
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateImagePayload'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images:
    get:
      summary: List Images
      operationId: ListImages
      x-permission: products.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithImages'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images:bulkArchive:
    post:
      summary: Bulk Archive Images
      operationId: BulkArchiveImages
      x-permission: images.archive
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkIds'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkIds'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images:bulkUnarchive:
    post:
      summary: Bulk Unarchive Images
      operationId: BulkUnarchiveImages
      x-permission: images.archive
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkIds'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkIds'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images/{imageId}/sbomReport:cycloneDX:
    get:
      summary: CycloneDX SBOM Report for an Image
      operationId: GetSbomReportCycloneDX
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - $ref: '#/components/parameters/QueryOptionalContentType'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomReport'
            application/xml:
              schema:
                $ref: '#/components/schemas/SbomReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/sbomReport:SPDX:
    get:
      summary: SPDX SBOM Report for an Image
      operationId: GetSbomReportSPDX
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/cbomReport:cycloneDX:
    get:
      summary: CBOM Report for an Image
      operationId: GetCbomReport
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/vexReport:openVEX:
    get:
      summary: VEX Report for an Image in OpenVEX format
      operationId: GetVexReportOpenVEX
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - $ref: '#/components/parameters/QueryOptionalFindingId'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VEXReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/vexReport:cycloneDX:
    get:
      summary: VEX Report for an Image in CycloneDX format
      operationId: GetVexReportCycloneDX
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - $ref: '#/components/parameters/QueryOptionalFindingId'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VEXReport'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/findingsReport:pdf:
    get:
      summary: Image Findings PDF Report
      operationId: ImageFindingsReportPdf
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - name: mode
        in: query
        schema:
          type: string
          enum:
          - summary
          - full
      responses:
        '200':
          description: detail report
          content:
            application/pdf:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images/{imageId}/findingsReport:download:
    post:
      summary: Download Image Report
      operationId: DownloadImageReport
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - name: mode
        in: query
        required: true
        schema:
          type: string
          enum:
          - summary
          - full
      - $ref: '#/components/parameters/QueryContentType'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GridQuery'
      responses:
        '200':
          description: detail report
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                $ref: '#/components/schemas/ReportImage'
          headers:
            Content-Disposition:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images/{imageId}/cryptographicMaterialsReport:
    get:
      summary: Download Cryptographic Materials Report
      operationId: CryptographicMaterialsReport
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - name: mode
        in: query
        required: true
        schema:
          type: string
          enum:
          - pqc-compliance
      - $ref: '#/components/parameters/QueryContentType'
      responses:
        '200':
          description: cryptographic materials report
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                $ref: '#/components/schemas/CryptographicMaterialsReportImage'
          headers:
            Content-Disposition:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /api/v4/products/{productId}/images/{imageId}/advisoryReport:
    post:
      summary: Advisory Report
      operationId: AdvisoryReport
      x-pass-resource-ids:
        resourceType: Product
        permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      - $ref: '#/components/parameters/QueryContentType'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GridQuery'
      responses:
        '200':
          description: advisory report
          content:
            text/markdown:
              schema:
                type: string
            application/pdf:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
  /api/v4/products/{productId}/images/{imageId}/findingsReport:json:
    post:
      summary: Image Findings JSON Report
      operationId: ImageFindingsReportJson
      x-permission: reports.view
      tags:
      - Image
      parameters:
      - $ref: '#/components/parameters/PathProductId'
      - $ref: '#/components/parameters/PathImageId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportQuery'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportImage'
          headers:
            Content-Disposition:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    FindingTypeCount:
      allOf:
      - $ref: '#/components/schemas/WithFindingType'
      - $ref: '#/components/schemas/WithCount'
    WithOptionalFindingsBySeverity:
      type: object
      properties:
        findingsBySeverity:
          $ref: '#/components/schemas/CountBySeverity'
    WithOptionalUserStatus:
      type: object
      properties:
        status:
          type: string
          x-go-type: string
          enum:
          - active
          - archived
    FindingEvidenceArtefact:
      type: object
      properties: {}
    CryptographicMaterialsReportFinding:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithFindingType'
      - $ref: '#/components/schemas/WithComponentName'
      - $ref: '#/components/schemas/WithComponent'
      - $ref: '#/components/schemas/WithSeverity'
      - $ref: '#/components/schemas/WithIsReachable'
      - $ref: '#/components/schemas/WithFindingStatus'
      - $ref: '#/components/schemas/WithDisplayName'
      - $ref: '#/components/schemas/WithOptionalCryptoAlgorithmName'
      - $ref: '#/components/schemas/WithOptionalCryptoAlgorithmPrimitive'
      - $ref: '#/components/schemas/WithOptionalCryptoProtocolName'
      - $ref: '#/components/schemas/WithOptionalIsNistIR8547Compliant'
      - $ref: '#/components/schemas/WithCompliance'
      - $ref: '#/components/schemas/WithEvidence'
    WithImages:
      type: object
      required:
      - images
      properties:
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
    File:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithOptionalParent'
      - $ref: '#/components/schemas/WithAuthor'
      - $ref: '#/components/schemas/WithFilename'
      - $ref: '#/components/schemas/WithIsAttachment'
      - $ref: '#/components/schemas/WithDownloadUrl'
      - $ref: '#/components/schemas/WithOptionalMetadata'
    WithUnsafeFunctionsCount:
      type: object
      required:
      - unsafeFunctionsCount
      properties:
        unsafeFunctionsCount:
          type: integer
    CountBySeverity:
      type: object
      readOnly: true
      properties:
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
        unspecified:
          type: integer
        total:
          type: integer
    ErrorResponse:
      required:
      - message
      type: object
      properties:
        message:
          type: string
          readOnly: true
          x-go-type-skip-optional-pointer: true
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
    WithOptionalReportFindings:
      type: object
      properties:
        findings:
          type: array
          items:
            $ref: '#/components/schemas/ReportFinding'
    WithParent:
      type: object
      required:
      - parent
      properties:
        parent:
          $ref: '#/components/schemas/Parent'
    WithExpiredCertificatesCount:
      type: object
      required:
      - expiredCertificatesCount
      properties:
        expiredCertificatesCount:
          type: integer
    ReportFinding:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithFindingType'
      - $ref: '#/components/schemas/WithFinding'
      - $ref: '#/components/schemas/WithComponent'
      - $ref: '#/components/schemas/WithSeverity'
      - $ref: '#/components/schemas/WithOptionalCvssLatestBaseScore'
      - $ref: '#/components/schemas/WithOptionalEpssProbability'
      - $ref: '#/components/schemas/WithIsEstimatedEpss'
      - $ref: '#/components/schemas/WithIsReachable'
      - $ref: '#/components/schemas/WithFindingStatus'
      - $ref: '#/components/schemas/WithDisplayName'
      - $ref: '#/components/schemas/WithOptionalSecret'
      - $ref: '#/components/schemas/WithOptionalSsvcDecision'
      - $ref: '#/components/schemas/WithIsSsvcParanoidDecision'
    WithDownloadUrl:
      type: object
      required:
      - downloadUrl
      properties:
        downloadUrl:
          type: string
          readOnly: true
    WithOptionalVersion:
      type: object
      properties:
        version:
          type: string
    WithOptionalFiles:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/File'
    WithFindingTypeCounts:
      type: object
      required:
      - findingTypeCounts
      properties:
        findingTypeCounts:
          type: array
          items:
            $ref: '#/components/schemas/FindingTypeCount'
    WithProductName:
      type: object
      required:
      - productName
      properties:
        productName:
          type: string
    NISTIR8547Recommendations:
      type: object
      properties:
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/NISTIR8547Recommendation'
    NISTIR8547KeyEstablishmentSecurity:
      type: object
      properties:
        keyEstablishment:
          $ref: '#/components/schemas/NISTIR8547KeyEstablishment'
      required:
      - keyEstablishment
    Component:
      allOf:
      - $ref: '#/components/schemas/WithPlatformId'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithPath'
      - $ref: '#/components/schemas/WithOptionalContainerPath'
      - $ref: '#/components/schemas/WithOptionalAttributes'
      - $ref: '#/components/schemas/WithOptionalKind'
      - $ref: '#/components/schemas/WithOptionalMd5'
      - $ref: '#/components/schemas/WithOptionalSha1'
      - $ref: '#/components/schemas/WithOptionalSha256'
    NISTIR8547HashAndXOF:
      type: object
      properties:
        collisionSecurityStrength:
          type: string
        collisionSecurityCategory:
          type: integer
        preimageSecurityStrength:
          type: string
        preimageSecurityCategory:
          type: integer
      required:
      - collisionSecurityStrength
      - collisionSecurityCategory
      - preimageSecurityStrength
      - preimageSecurityCategory
    WithOptionalCreateTime:
      type: object
      properties:
        createTime:
          type: string
          readOnly: true
          example: '2024-01-01T01:00:00Z'
    WithCreateTime:
      type: object
      required:
      - createTime
      properties:
        createTime:
          type: string
          readOnly: true
          example: '2024-01-01T01:00:00Z'
    WithOptionalSha1:
      type: object
      properties:
        sha1:
          type: string
    WithOptionalCryptoAlgorithmName:
      type: object
      properties:
        cryptoAlgorithmName:
          type: string
    WithOptionalAuthor:
      type: object
      properties:
        author:
          $ref: '#/components/schemas/User'
    ResourceType:
      type: string
      enum:
      - Org
      - Group
      - Product
      - User
      - Image
      - Finding
      - Occurrence
    NISTIR8547Transition:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/NISTIR8547ApprovalStatus'
        year:
          type: integer
    WithOptionalSsvcDecision:
      type: object
      properties:
        ssvcDecision:
          type: string
          enum:
          - track
          - trackStar
          - attend
          - act
    CryptographicMaterialsReportImage:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithParent'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithProductName'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithOptionalAuthorEmail'
      - $ref: '#/components/schemas/WithCryptographicMaterialsReportFindings'
    WithKevCount:
      type: object
      required:
      - kev
      properties:
        kev:
          type: integer
    WithOptionalContainerPath:
      type: object
      properties:
        containerPath:
          type: string
    ImageCounts:
      allOf:
      - $ref: '#/components/schemas/WithNewEscalationsCount'
      - $ref: '#/components/schemas/WithDependenciesCount'
      - $ref: '#/components/schemas/WithCryptographicAssetsCount'
      - $ref: '#/components/schemas/WithFindingTypeCounts'
      - $ref: '#/components/schemas/WithKevCount'
      - $ref: '#/components/schemas/WithExpiredCertificatesCount'
      - $ref: '#/components/schemas/WithUnsafeFunctionsCount'
    Image:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithVersion'
      - $ref: '#/components/schemas/WithOptionalParent'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithAuthor'
      - $ref: '#/components/schemas/WithOptionalFiles'
      - $ref: '#/components/schemas/WithOptionalScans'
      - $ref: '#/components/schemas/WithOptionalLatestScan'
      - $ref: '#/components/schemas/WithOptionalIsArchived'
      - $ref: '#/components/schemas/WithOptionalImageCounts'
    Scan:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithOptionalParent'
      - $ref: '#/components/schemas/WithAuthor'
      - $ref: '#/components/schemas/WithOptionalLatestScanState'
    WithUserId:
      type: object
      required:
      - userId
      properties:
        userId:
          type: string
          readOnly: true
          x-go-type-skip-optional-pointer: true
    ForbiddenErrorResponse:
      type: object
      required:
      - message
      - permission
      - resourceName
      properties:
        message:
          type: string
        permission:
          type: string
        resourceName:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
    NISTIR8547HashAndXOFSecurity:
      type: object
      properties:
        hashAndXOF:
          $ref: '#/components/schemas/NISTIR8547HashAndXOF'
      required:
      - hashAndXOF
    WithPlatformId:
      type: object
      required:
      - id
      properties:
        id:
          type: string
    ScanState:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithScanStateType'
      - $ref: '#/components/schemas/WithOptionalParent'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithOptionalAuthor'
      - $ref: '#/components/schemas/WithOptionalSource'
    WithCount:
      type: object
      required:
      - count
      properties:
        count:
          type: integer
    WithOptionalAttributes:
      type: object
      properties:
        attributes: {}
    WithNewEscalationsCount:
      type: object
      required:
      - newEscalationsCount
      properties:
        newEscalationsCount:
          type: integer
    WithFilename:
      type: object
      required:
      - filename
      properties:
        filename:
          type: string
    WithIds:
      type: object
      required:
      - ids
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/ULID'
    WithName:
      type: object
      required:
      - name
      properties:
        name:
          type: string
    WithSeverity:
      type: object
      required:
      - severity
      properties:
        severity:
          type: string
          enum:
          - unspecified
          - low
          - medium
          - high
          - critical
    WithIsReachable:
      type: object
      required:
      - isReachable
      properties:
        isReachable:
          type: boolean
    WithComponentName:
      type: object
      required:
      - componentName
      properties:
        componentName:
          type: string
    WithOptionalKind:
      type: object
      properties:
        kind:
          type: string
    SbomReport:
      type: object
      additionalProperties: {}
      x-go-type: string
    WithFindingStatus:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - new
          - in progress
          - rejected
          - remediated
    ImageUpload:
      type: object
      properties:
        imageName:
          type: string
        version:
          type: string
        file:
          type: string
          format: binary
    WithDisplayName:
      type: object
      required:
      - displayName
      properties:
        displayName:
          type: string
    Parent:
      type: string
      format: path
      description: URI path (path-noscheme) without the leading /
      readOnly: true
      x-go-type: string
      x-go-type-skip-optional-pointer: true
    ReportImage:
      allOf:
      - $ref: '#/components/schemas/WithId'
      - $ref: '#/components/schemas/WithParent'
      - $ref: '#/components/schemas/WithName'
      - $ref: '#/components/schemas/WithOptionalVersion'
      - $ref: '#/components/schemas/WithCreateTime'
      - $ref: '#/components/schemas/WithOptionalAuthorEmail'
      - $ref: '#/components/schemas/WithOptionalFindingsBySeverity'
      - $ref: '#/components/schemas/WithOptionalReportFindings'
    WithDependenciesCount:
      type: object
      required:
      - dependenciesCount
      properties:
        dependenciesCount:
          type: integer
    WithOptionalEpssProbability:
      type: object
      properties:
        epssProbability:
          type: number
          format: float
    WithCryptographicMaterialsReportFindings:
      type: object
      required:
      - findings
      properties:
        findings:
          type: array
          items:
            $ref: '#/components/schemas/CryptographicMaterialsReportFinding'
    NISTIR8547Recommendation:
      type: object
      properties:
        algorithm:
          type: string
        parameter:
          type: string
        security:
          $ref: '#/components/schemas/NISTIR8547Security'
    ReportQuery:
      type: object
      properties:
        page:
          type: object
          properties:
            num:
              type: integer
              minimum: 1
              maximum: 10000
              default: 0
            size:
              type: integer
              minimum: 10
              maximum: 100
              default: 10
        filters:
          type: array
          i

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/binarly/refs/heads/main/openapi/binarly-image-api-openapi.yml