Snyk

Snyk Collection API

The Collection API from Snyk — 3 operation(s) for collection.

GitHub OpenAPI

Operations 8

GET /orgs/{org_id}/collections Get collections #
POST /orgs/{org_id}/collections Create a collection #
DELETE /orgs/{org_id}/collections/{collection_id} Delete a collection #
GET /orgs/{org_id}/collections/{collection_id} Get a collection #
PATCH /orgs/{org_id}/collections/{collection_id} Edit a collection #
DELETE /orgs/{org_id}/collections/{collection_id}/relationships/projects Remove projects from a collection #
GET /orgs/{org_id}/collections/{collection_id}/relationships/projects Get projects from the specified collection #
POST /orgs/{org_id}/collections/{collection_id}/relationships/projects Add projects to a collection #

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-collection-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/overlays/snyk-collection-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-collection-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-collection-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snyk AccessRequests Collection API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: Collection
paths:
  /orgs/{org_id}/collections:
    get:
      description: 'Return a list of organization''s collections with issues counts  and projects count.


        #### Required permissions


        - `View Collections (org.collection.read)`


        - `View Project history (org.project.snapshot.read)`'
      operationId: getCollections
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - description: Return collections sorted by the specified attributes
        in: query
        name: sort
        schema:
          enum:
          - name
          - projectsCount
          - issues
          type: string
      - description: Return collections sorted in the specified direction
        in: query
        name: direction
        schema:
          default: DESC
          enum:
          - ASC
          - DESC
          type: string
      - allowEmptyValue: true
        description: Return collections which names include the provided string
        in: query
        name: name
        schema:
          maxLength: 255
          type: string
      - allowEmptyValue: true
        description: Return collections where is_generated matches the provided boolean
        in: query
        name: is_generated
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/CollectionResponse'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/PaginatedLinks'
                type: object
          description: Returns a list of collections
          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'
        '500':
          $ref: '#/components/responses/500'
      summary: Get collections
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
    post:
      description: 'Create a collection


        #### Required permissions


        - `Create Collections (org.collection.create)`'
      operationId: createCollection
      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:
              $ref: '#/components/schemas/CreateCollectionRequest'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: collection resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/CollectionAttributes'
                      id:
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/CollectionRelationships'
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - attributes
                    - relationships
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Returned collection
          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 a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
  /orgs/{org_id}/collections/{collection_id}:
    delete:
      description: 'Delete a collection


        #### Required permissions


        - `Delete Collections (org.collection.delete)`'
      operationId: deleteCollection
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      responses:
        '204':
          description: Collection was deleted 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: Delete a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
    get:
      description: 'Get a collection


        #### Required permissions


        - `View Collections (org.collection.read)`'
      operationId: getCollection
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: collection resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/CollectionAttributes'
                      id:
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/CollectionRelationships'
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - attributes
                    - relationships
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Returned collection
          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: Get a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
    patch:
      description: 'Edit a collection


        #### Required permissions


        - `Edit Collections (org.collection.edit)`'
      operationId: updateCollection
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateCollectionRequest'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    additionalProperties: false
                    description: collection resource object
                    properties:
                      attributes:
                        $ref: '#/components/schemas/CollectionAttributes'
                      id:
                        format: uuid
                        type: string
                      relationships:
                        $ref: '#/components/schemas/CollectionRelationships'
                      type:
                        $ref: '#/components/schemas/Types'
                    required:
                    - id
                    - attributes
                    - relationships
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/SelfLink'
                type: object
          description: Returned collection
          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: Edit a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
  /orgs/{org_id}/collections/{collection_id}/relationships/projects:
    delete:
      description: 'Remove projects from a collection by specifying an array of project ids


        #### Required permissions


        - `Edit Collections (org.collection.edit)`'
      operationId: deleteProjectsCollection
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/DeleteProjectsFromCollectionRequest'
      responses:
        '204':
          description: successfully removing projects from a collection
          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: Remove projects from a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
    get:
      description: 'Return a list of organization''s projects that are from the specified collection.


        #### Required permissions


        - `View Collections (org.collection.read)`


        - `View Projects (org.project.read)`


        - `View Project history (org.project.snapshot.read)`'
      operationId: getProjectsOfCollection
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - description: Return projects sorted by the specified attributes
        in: query
        name: sort
        schema:
          enum:
          - imported
          - last_tested_at
          - issues
          type: string
      - description: Return projects sorted in the specified direction
        in: query
        name: direction
        schema:
          default: DESC
          enum:
          - ASC
          - DESC
          type: string
      - description: Return projects that belong to the provided targets
        in: query
        name: target_id
        schema:
          items:
            format: uuid
            type: string
          maxItems: 25
          type: array
      - description: Return projects that are with or without issues
        in: query
        name: show
        schema:
          items:
            enum:
            - vuln-groups
            - clean-groups
            type: string
          type: array
      - description: Return projects that match the provided integration types
        in: query
        name: integration
        schema:
          items:
            enum:
            - acr
            - api
            - artifactory-cr
            - aws-lambda
            - azure-functions
            - azure-repos
            - bitbucket-cloud
            - bitbucket-connect-app
            - bitbucket-server
            - cli
            - cloud-foundry
            - digitalocean-cr
            - docker-hub
            - ecr
            - gcr
            - github-cr
            - github-enterprise
            - github
            - gitlab-cr
            - gitlab
            - google-artifact-cr
            - harbor-cr
            - heroku
            - ibm-cloud
            - kubernetes
            - nexus-cr
            - pivotal
            - quay-cr
            - terraform-cloud
            type: string
          type: array
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetProjectsOfCollectionResponse'
          description: Returns a list of projects from the specified collection
          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'
        '500':
          $ref: '#/components/responses/500'
      summary: Get projects from the specified collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
    post:
      description: 'Add projects to a collection by specifying an array of project ids


        #### Required permissions


        - `Edit Collections (org.collection.edit)`'
      operationId: updateCollectionWithProjects
      parameters:
      - $ref: '#/components/parameters/Version'
      - description: Org ID
        in: path
        name: org_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/CollectionId'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateCollectionWithProjectsRequest'
      responses:
        '204':
          description: successfully adding projects to a collection
          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: Add projects to a collection
      tags:
      - Collection
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2023-06-01~beta
      - '2023-09-12'
      x-snyk-api-resource: collections
      x-snyk-api-stability: ga
      x-snyk-api-version: '2023-09-12'
      x-stability-level: stable
components:
  schemas:
    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
    CollectionRelationships:
      additionalProperties: false
      properties:
        created_by_user:
          properties:
            data:
              properties:
                id:
                  description: ID of the user that created the collection. Null for auto-collections.
                  example: 331ede0a-de94-456f-b788-166caeca58bf
                  format: uuid
                  type:
                  - string
                  - 'null'
                type:
                  enum:
                  - user
              required:
              - type
              - id
              type: object
          required:
          - data
          type: object
        org:
          properties:
            data:
              properties:
                id:
                  description: ID of the org that this collection belongs to
                  example: 331ede0a-de94-456f-b788-166caeca58bf
                  format: uuid
                  type: string
                type:
                  enum:
                  - org
              required:
              - type
              - id
              type: object
          required:
          - data
          type: object
      required:
      - org
      - created_by_user
      type: object
    CollectionMeta:
      additionalProperties: false
      properties:
        issues_critical_count:
          description: The sum of critical severity issues of the collection's projects
          example: 10
          type: number
        issues_high_count:
          description: The sum of high severity issues of the collection's projects
          example: 10
          type: number
        issues_low_count:
          description: The sum of low severity issues of the collection's projects
          example: 10
          type: number
        issues_medium_count:
          description: The sum of medium severity issues of the collection's projects
          example: 10
          type: number
        projects_count:
          description: The amount of projects belonging to this collection
          example: 7
          type: number
      required:
      - projects_count
      - issues_critical_count
      - issues_high_count
      - issues_medium_count
      - issues_low_count
      type: object
    GetProjectsOfCollectionResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ProjectOfCollection'
          type: array
        jsonapi:
          $ref: '#/components/schemas/JsonApi'
        links:
          $ref: '#/components/schemas/PaginatedLinks'
      type: object
    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
    UpdateCollectionRequest:
      properties:
        data:
          additionalProperties: false
          properties:
            attributes:
              additionalProperties: false
              properties:
                name:
                  $ref: '#/components/schemas/name'
              required:
              - name
              type: object
            id:
              format: uuid
              type: string
            type:
              $ref: '#/components/schemas/Types'
          required:
          - type
          - attributes
          type: object
      required:
      - data
      type: object
    CollectionResponse:
      additionalProperties: false
      properties:
        attributes:
          $ref: '#/components/schemas/CollectionAttributes'
        id:
          format: uuid
          type: string
        meta:
          $ref: '#/components/schemas/CollectionMeta'
        relationships:
          $ref: '#/components/schemas/CollectionRelationships'
        type:
          $ref: '#/components/schemas/Types'
      required:
      - id
      - type
      - meta
      - attributes
      - relationships
      type: object
    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
    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
   

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