Snyk

Snyk SBOM API

The SBOM API from Snyk — 4 operation(s) for sbom.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /orgs/{org_id}/projects/{project_id}/sbom Get a project's SBOM document · Get a project’s SBOM document #
Ask an LLM
“Can I download a software bill of materials for one of my Snyk projects?”
“Which SBOM formats are supported, like CycloneDX 1.6 or SPDX 2.3?”
Tell an agent
Get the SBOM for project {project_id} in org {org_id}.
Export project {project_id} in org {org_id} as an SBOM in {format} format.
POST /orgs/{org_id}/sbom_tests Test an SBOM document for vulnerabilities · Create an SBOM test run (Early Access) #
Ask an LLM
“Can I upload an SBOM and have its components checked for known vulnerabilities?”
“Why were some components skipped when I tested my SBOM?”
Tell an agent
Start a vulnerability test of this CycloneDX SBOM in org {org_id}.
Submit this SPDX 2.3 JSON document for an SBOM test run in org {org_id}.
GET /orgs/{org_id}/sbom_tests/{job_id} Check an SBOM test run's status · Gets an SBOM test run status (Early Access) #
Ask an LLM
“Has my SBOM test run finished yet?”
“Can I poll the progress of an SBOM vulnerability test?”
Tell an agent
Check the status of SBOM test job {job_id} in org {org_id}.
Tell me whether SBOM test {job_id} in org {org_id} is done.
GET /orgs/{org_id}/sbom_tests/{job_id}/results Get the findings of an SBOM test run · Gets an SBOM test run result (Early Access) #
Ask an LLM
“What vulnerabilities did my SBOM test find?”
“Can I page through the results of a completed SBOM test?”
Tell an agent
Get the results of SBOM test job {job_id} in org {org_id}.
Show the first {limit} findings from SBOM test {job_id} in org {org_id}.

Documentation

📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Projects
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Targets
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-links-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-resource-reference-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-json-api-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-sbom-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-sbom-test-create-attributes-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-types-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/overlays/snyk-sbom-api-overlay.yaml

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/snyk:snyk-sbom-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

snyk-sbom-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snyk SBOM API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: SBOM
paths:
  /orgs/{org_id}/projects/{project_id}/sbom:
    get:
      description: 'This endpoint lets you retrieve the SBOM document of a software project.

        It supports the following formats:

        * CycloneDX version 1.6 in JSON (set `format` to `cyclonedx1.6+json`).

        * CycloneDX version 1.6 in XML (set `format` to `cyclonedx1.6+xml`).

        * CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).

        * CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).

        * CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).

        * CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).

        * SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).


        By default it will respond with an empty JSON:API response.


        #### Required permissions


        - `View Project history (org.project.snapshot.read)`'
      operationId: getSbom
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Unique identifier for an organization
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - description: Unique identifier for a project
        in: path
        name: project_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/Exclude'
      - $ref: '#/components/parameters/GoModuleLevel'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SbomDocument'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SbomResponse'
            application/vnd.cyclonedx+json:
              schema:
                $ref: '#/components/schemas/SbomDocument'
            application/vnd.cyclonedx+xml:
              schema:
                $ref: '#/components/schemas/SbomDocument'
          description: Returns the SBOM document of a project
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Get a project’s SBOM document
      tags:
      - SBOM
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-03-31~experimental
      - 2022-12-06~beta
      - '2023-03-20'
      - 2024-03-12~experimental
      - 2024-08-15~beta
      - '2024-08-22'
      x-snyk-api-resource: sboms
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-22'
      x-stability-level: stable
  /orgs/{org_id}/sbom_tests:
    post:
      description: 'Create an SBOM test run by supplying an SBOM document. The components contained in the given document will get analyzed for known vulnerabilities. In order for component identification to be successful, they must have a PackageURL (purl) of a supported purl type assigned. Analysis will be skipped for any component that does not fulfill this requirement.

        Supported SBOM formats: CycloneDX 1.4 JSON, CycloneDX 1.5 JSON, CycloneDX 1.6 JSON, SPDX 2.3 JSON

        Supported purl types: apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, swift


        #### Required permissions


        - `Test Projects (org.project.test)`'
      operationId: createSbomTestRun
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  additionalProperties: false
                  properties:
                    attributes:
                      $ref: '#/components/schemas/SbomTestCreateAttributes'
                    type:
                      $ref: '#/components/schemas/Types'
                  required:
                  - type
                  type: object
              required:
              - data
              type: object
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: SBOM test resource object
                    properties:
                      id:
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - type
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
          description: Created SBOM test successfully
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Create an SBOM test run (Early Access)
      tags:
      - SBOM
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-02~experimental
      - 2023-08-31~beta
      - 2024-04-22~beta
      - 2024-07-10~beta
      x-snyk-api-resource: sbom_tests
      x-snyk-api-stability: beta
      x-snyk-api-version: 2024-07-10~beta
      x-stability-level: beta
  /orgs/{org_id}/sbom_tests/{job_id}:
    get:
      description: 'Get an SBOM test run status


        #### Required permissions


        - `Test Projects (org.project.test)`'
      operationId: getSbomTestStatus
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    description: SBOM test resource object
                    properties:
                      attributes:
                        properties:
                          status:
                            enum:
                            - processing
                            - error
                            - finished
                            type: string
                        type: object
                      id:
                        format: uuid
                        type: string
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - type
                    - attributes
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
          description: SBOM test run status
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Gets an SBOM test run status (Early Access)
      tags:
      - SBOM
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-02~experimental
      - 2023-08-31~beta
      - 2024-04-22~beta
      - 2024-07-10~beta
      x-snyk-api-resource: sbom_tests
      x-snyk-api-stability: beta
      x-snyk-api-version: 2024-07-10~beta
      x-stability-level: beta
  /orgs/{org_id}/sbom_tests/{job_id}/results:
    get:
      description: 'Get an SBOM test run result


        #### Required permissions


        - `Test Projects (org.project.test)`'
      operationId: getSbomTestResult
      parameters:
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/JobId'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: SBOM test resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/SbomTestResultsAttributes'
                      id:
                        example: d5b640e5-d88c-4c17-9bf0-93597b7a1ce2
                        format: uuid
                        type: string
                      relationships:
                        properties:
                          affected_packages:
                            properties:
                              data:
                                items:
                                  $ref: '#/components/schemas/ResourceReference'
                                type: array
                            type: object
                        type: object
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - type
                    type: object
                  included:
                    items:
                      additionalProperties: true
                      type: object
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
          description: SBOM test results
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
      summary: Gets an SBOM test run result (Early Access)
      tags:
      - SBOM
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-02~experimental
      - 2023-08-31~beta
      - 2024-04-22~beta
      - 2024-07-10~beta
      x-snyk-api-resource: sbom_tests
      x-snyk-api-stability: beta
      x-snyk-api-version: 2024-07-10~beta
      x-stability-level: beta
components:
  parameters:
    StartingAfter:
      description: Return the page of results immediately after this cursor
      example: v1.eyJpZCI6IjEwMDAifQo=
      in: query
      name: starting_after
      schema:
        type: string
    Exclude:
      description: An array of features to be excluded from the generated SBOM.
      in: query
      name: exclude
      schema:
        items:
          enum:
          - licenses
          type: string
        type: array
    Accept:
      in: header
      name: Accept
      schema:
        type: string
    Version:
      description: The requested version of the endpoint to process the request
      example: '2026-03-25'
      in: query
      name: version
      required: true
      schema:
        $ref: '#/components/schemas/QueryVersion'
    GoModuleLevel:
      description: When true, consolidate Go package-level dependencies into module-level components in the SBOM. Only applies to gomodules graphs; default is false.
      in: query
      name: go_module_level
      schema:
        default: false
        type: boolean
    EndingBefore:
      description: Return the page of results immediately before this cursor
      example: v1.eyJpZCI6IjExMDAifQo=
      in: query
      name: ending_before
      schema:
        type: string
    Limit:
      description: Number of results to return per page
      example: 10
      in: query
      name: limit
      schema:
        default: 10
        format: int32
        maximum: 100
        minimum: 10
        multipleOf: 10
        type: integer
    Format:
      description: The desired SBOM format of the response.
      in: query
      name: format
      schema:
        enum:
        - cyclonedx1.6+json
        - cyclonedx1.6+xml
        - cyclonedx1.5+json
        - cyclonedx1.5+xml
        - cyclonedx1.4+json
        - cyclonedx1.4+xml
        - spdx2.3+json
        example: cyclonedx1.6+json
        type: string
    JobId:
      description: Job ID
      in: path
      name: job_id
      required: true
      schema:
        format: uuid
        type: string
  headers:
    VersionStageResponseHeader:
      description: 'A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.

        '
      schema:
        enum:
        - wip
        - experimental
        - beta
        - ga
        - deprecated
        - sunset
        example: ga
        type: string
    VersionServedResponseHeader:
      description: A header containing the version of the endpoint that was served by the API.
      example: '2026-03-25'
      schema:
        $ref: '#/components/schemas/ActualVersion'
    VersionRequestedResponseHeader:
      description: A header containing the version of the endpoint requested by the caller.
      example: '2026-03-25'
      schema:
        $ref: '#/components/schemas/QueryVersion'
    LocationHeader:
      description: 'A header providing a URL for the location of a resource

        '
      example: https://example.com/resource/4
      schema:
        format: url
        type: string
    SunsetHeader:
      description: 'A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD'
      example: '2021-08-02'
      schema:
        format: date
        type: string
    DeprecationHeader:
      description: 'A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:

        https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html

        '
      example: '2021-07-01T00:00:00Z'
      schema:
        format: date-time
        type: string
    RequestIdResponseHeader:
      description: 'A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it''s very helpful to provide this ID.

        '
      example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef
      schema:
        format: uuid
        type: string
  responses:
    '409':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Conflict: The requested operation conflicts with the current state of the resource in some way.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '500':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Internal Server Error: An error was encountered while attempting to process the request.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '403':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Forbidden: the request requires an authentication token with more or different permissions.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '400':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Bad Request: A parameter provided as a part of the request was invalid.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '404':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Not Found: The resource being operated on could not be found.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
    '401':
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
      description: 'Unauthorized: the request requires an authentication token.'
      headers:
        deprecation:
          $ref: '#/components/headers/DeprecationHeader'
        snyk-request-id:
          $ref: '#/components/headers/RequestIdResponseHeader'
        snyk-version-lifecycle-stage:
          $ref: '#/components/headers/VersionStageResponseHeader'
        snyk-version-requested:
          $ref: '#/components/headers/VersionRequestedResponseHeader'
        snyk-version-served:
          $ref: '#/components/headers/VersionServedResponseHeader'
        sunset:
          $ref: '#/components/headers/SunsetHeader'
  schemas:
    SbomTestResultsAttributes:
      additionalProperties: true
      type: object
    LinkProperty:
      example: https://example.com/api/resource
      oneOf:
      - description: A string containing the link’s URL.
        example: https://example.com/api/resource
        type: string
      - additionalProperties: false
        example:
          href: https://example.com/api/resource
        properties:
          href:
            description: A string containing the link’s URL.
            example: https://example.com/api/resource
            type: string
          meta:
            additionalProperties: true
            description: Free-form object that may contain non-standard information.
            example:
              key1: value1
              key2:
                sub_key: sub_value
              key3:
              - array_value1
              - array_value2
            type: object
        required:
        - href
        type: object
    QueryVersion:
      description: Requested API version
      example: '2026-03-25'
      pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
      type: string
    ErrorDocument:
      additionalProperties: false
      example:
        errors:
        - detail: Permission denied for this resource
          status: '403'
        jsonapi:
          version: '1.0'
      properties:
        errors:
          example:
          - detail: Permission denied for this resource
            status: '403'
          items:
            additionalProperties: false
            example:
              detail: Not Found
              status: '404'
            properties:
              code:
                description: An application-specific error code, expressed as a string value.
                example: entity-not-found
                type: string
              detail:
                description: A human-readable explanation specific to this occurrence of the problem.
                example: 'The request was missing these required fields: ...'
                type: string
              id:
                description: A unique identifier for this particular occurrence of the problem.
                example: f16c31b5-6129-4571-add8-d589da9be524
                format: uuid
                type: string
              links:
                additionalProperties: false
                description: A link that leads to further details about this particular occurrance of the problem.
                example:
                  about: https://example.com/about_this_error
                properties:
                  about:
                    example: https://example.com/api/resource
                    oneOf:
                    - description: A string containing the link’s URL.
                      example: https://example.com/api/resource
                      type: string
                    - additionalProperties: false
                      example:
                        href: https://example.com/api/resource
                      properties:
                        href:
                          description: A string containing the link’s URL.
                          example: https://example.com/api/resource
                          type: string
                        meta:
                          additionalProperties: true
                          description: Free-form object that may contain non-standard information.
                          example:
                            key1: value1
                            key2:
                              sub_key: sub_value
                            key3:
                            - array_value1
                            - array_value2
                          type: object
                      required:
                      - href
                      type: object
                type: object
              meta:
                additionalProperties: true
                example:
                  key: value
                type: object
              source:
                additionalProperties: false
                example:
                  pointer: /data/attributes
                properties:
                  parameter:
                    description: A string indicating which URI query parameter caused the error.
                    example: param1
                    type: string
                  pointer:
                    description: A JSON Pointer [RFC6901] to the associated entity in the request document.
                    example: /data/attributes
                    type: string
                type: object
              status:
                description: The HTTP status code applicable to this problem, expressed as a string value.
                example: '400'
                pattern: ^[45]\d\d$
                type: string
              title:
                description: A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                example: Bad request
                type: string
            required:
            - status
            - detail
            type: object
          minItems: 1
          type: array
        jsonapi:
          additionalProperties: false
          example:
            version: '1.0'
          properties:
            version:
              description: Version of the JSON API specification this server supports.
              example: '1.0'
              pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
              type: string
          required:
          - version
          type: object
      required:
      - jsonapi
      - errors
      type: object
    ResourceReference:
      additionalProperties: false
      properties:
        id:
          example: 4a72d1db-b465-4764-99e1-ecedad03b06a
          format: uuid
          type: string
        type:
          description: Type of the related resource
          example: resource
          pattern: ^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$
          type: string
      required:
      - type
      - id
      type: object
    SbomDocument:
      additionalProperties: true
      type: object
    Types:
      example: resource
      pattern: ^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$
      type: string
    ActualVersion:
      description: Resolved API version
      example: '2026-03-25'
      pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$
      type: string
    JsonApi:
      additionalProperties: false
      example:
        version: '1.0'
      properties:
        version:
          description: Version of the JSON API specification this server supports.
          example: '1.0'
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
          type: string
      required:
      - version
      type: object
    SbomResponse:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/SbomResource'
        jsonapi:
          $ref: '#/components/schemas/JsonApi'
      required:
      - jsonapi
      - data
      type: object
    SbomTestCreateAttributes:
      properties:
        format:
          type: string
        sbom:
          additionalProperties: true
          type: object
      required:
      - sbom
      type: object
    SbomResource:
      additionalProperties: false
      properties:
        id:
          example: b68b0b85-d039-4c05-abc0-04eb50ca0fe9
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/Types'
      required:
      - id
      - type
      type: object
    Links:
      additionalProperties: false
      properties:
        first:
          $ref: '#/components/schemas/LinkProperty'
        last:
          $ref: '#/components/schemas/LinkProperty'
        next:
          $ref: '#/components/schemas/LinkProperty'
        prev:
          $ref: '#/components/schemas/LinkProperty'
        related:
          $ref: '#/components/schemas/LinkProperty'
        self:
          $ref: '#/components/schemas/LinkProperty'
      type: object
  securitySchemes:
    APIToken:
      description: API key value must be prefixed with \"Token \".
      in: header
      name: Authorization
      type: apiKey
    BearerAuth:
      scheme: bearer
      type: http
x-snyk-api-version: '2024-10-15'