IssuesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/snyk/main/json-schema/snyk-issues-response-schema.json",
  "title": "IssuesResponse",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snyk-issues-api-openapi.yml#/components/schemas/IssuesResponse",
  "additionalProperties": false,
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/CommonIssueModelVThree"
      },
      "type": "array"
    },
    "jsonapi": {
      "$ref": "#/$defs/JsonApi"
    },
    "links": {
      "$ref": "#/$defs/PaginatedLinks"
    },
    "meta": {
      "$ref": "#/$defs/IssuesMeta"
    }
  },
  "type": "object",
  "$defs": {
    "ChecksumValidationMeta": {
      "description": "Metadata about checksum validation when a checksum qualifier is provided in the PURL",
      "properties": {
        "description": {
          "description": "Human-readable explanation of the validation result",
          "type": "string"
        },
        "details": {
          "properties": {
            "checksum": {
              "description": "Whether the checksum matched (null if no checksum validation was requested)",
              "type": [
                "boolean",
                "null"
              ]
            },
            "name_version": {
              "description": "Whether the package name and version were found",
              "type": "boolean"
            }
          },
          "required": [
            "name_version",
            "checksum"
          ],
          "type": "object"
        },
        "input": {
          "properties": {
            "checksum": {
              "description": "The checksum value provided (null if none)",
              "type": [
                "string",
                "null"
              ]
            },
            "purl": {
              "description": "The original PURL provided",
              "type": "string"
            }
          },
          "required": [
            "purl",
            "checksum"
          ],
          "type": "object"
        },
        "type": {
          "description": "The type of match found: - `full`: Both package ID and checksum match - `partial`: Only one of package ID or checksum matches - `none`: Neither package ID nor checksum found",
          "enum": [
            "none",
            "partial",
            "full"
          ],
          "type": "string"
        }
      },
      "required": [
        "type",
        "details",
        "description",
        "input"
      ],
      "type": "object"
    },
    "CommonIssueModelVThree": {
      "properties": {
        "attributes": {
          "properties": {
            "coordinates": {
              "items": {
                "$ref": "#/$defs/Coordinate"
              },
              "type": "array"
            },
            "created_at": {
              "format": "date-time",
              "type": "string"
            },
            "description": {
              "description": "A description of the issue in Markdown format",
              "type": "string"
            },
            "effective_severity_level": {
              "description": "The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies.",
              "enum": [
                "info",
                "low",
                "medium",
                "high",
                "critical"
              ],
              "type": "string"
            },
            "problems": {
              "items": {
                "$ref": "#/$defs/Problem3"
              },
              "type": "array"
            },
            "severities": {
              "description": "An array of dictionaries containing all known data related to the vulnerability",
              "items": {
                "$ref": "#/$defs/Severity3"
              },
              "type": "array"
            },
            "slots": {
              "$ref": "#/$defs/Slots"
            },
            "title": {
              "description": "A human-readable title for this issue.",
              "type": "string"
            },
            "type": {
              "description": "The issue type",
              "type": "string"
            },
            "updated_at": {
              "description": "When the vulnerability information was last modified.",
              "format": "date-time",
              "type": "string"
            }
          },
          "type": "object"
        },
        "id": {
          "description": "The Snyk ID of the vulnerability.",
          "type": "string"
        },
        "type": {
          "description": "The type of the REST resource. Always ‘issue’.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Coordinate": {
      "properties": {
        "remedies": {
          "items": {
            "$ref": "#/$defs/Remedy3"
          },
          "type": "array"
        },
        "representations": {
          "description": "The affected versions of this vulnerability.",
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/ResourcePathRepresentation"
              },
              {
                "$ref": "#/$defs/PackageRepresentation"
              }
            ]
          },
          "type": "array"
        }
      },
      "required": [
        "representations"
      ],
      "type": "object"
    },
    "ExploitDetails": {
      "description": "Details about the exploits",
      "properties": {
        "maturity_levels": {
          "description": "List of maturity levels",
          "items": {
            "$ref": "#/$defs/MaturityLevel"
          },
          "type": "array"
        },
        "sources": {
          "description": "Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "IssuesMeta": {
      "properties": {
        "match": {
          "$ref": "#/$defs/ChecksumValidationMeta"
        },
        "package": {
          "$ref": "#/$defs/PackageMeta__0"
        }
      },
      "type": "object"
    },
    "JsonApi": {
      "additionalProperties": false,
      "properties": {
        "version": {
          "description": "Version of the JSON API specification this server supports.",
          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
          "type": "string"
        }
      },
      "required": [
        "version"
      ],
      "type": "object"
    },
    "LinkProperty": {
      "oneOf": [
        {
          "description": "A string containing the link’s URL.",
          "type": "string"
        },
        {
          "additionalProperties": false,
          "properties": {
            "href": {
              "description": "A string containing the link’s URL.",
              "type": "string"
            },
            "meta": {
              "additionalProperties": true,
              "description": "Free-form object that may contain non-standard information.",
              "type": "object"
            }
          },
          "required": [
            "href"
          ],
          "type": "object"
        }
      ]
    },
    "MaturityLevel": {
      "description": "Details about the maturity level",
      "properties": {
        "format": {
          "description": "The standard by which the “maturity” value is shown.",
          "type": "string"
        },
        "level": {
          "description": "Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked.",
          "type": "string"
        },
        "type": {
          "description": "Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PackageMeta": {
      "properties": {
        "name": {
          "description": "The package’s name",
          "type": "string"
        },
        "namespace": {
          "description": "A name prefix, such as a maven group id or docker image owner",
          "type": "string"
        },
        "type": {
          "description": "The package type or protocol",
          "type": "string"
        },
        "url": {
          "description": "The purl of the package",
          "type": "string"
        },
        "version": {
          "description": "The version of the package",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PackageMeta__0": {
      "properties": {
        "name": {
          "description": "The package’s name",
          "type": "string"
        },
        "namespace": {
          "description": "A name prefix, such as a maven group id or docker image owner",
          "type": "string"
        },
        "type": {
          "description": "The package type or protocol",
          "type": "string"
        },
        "url": {
          "description": "The purl of the package",
          "type": "string"
        },
        "version": {
          "description": "The version of the package",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PackageRepresentation": {
      "properties": {
        "package": {
          "$ref": "#/$defs/PackageMeta"
        }
      },
      "type": "object"
    },
    "PaginatedLinks": {
      "additionalProperties": false,
      "properties": {
        "first": {
          "$ref": "#/$defs/LinkProperty"
        },
        "last": {
          "$ref": "#/$defs/LinkProperty"
        },
        "next": {
          "$ref": "#/$defs/LinkProperty"
        },
        "prev": {
          "$ref": "#/$defs/LinkProperty"
        },
        "self": {
          "$ref": "#/$defs/LinkProperty"
        }
      },
      "type": "object"
    },
    "Problem3": {
      "properties": {
        "disclosed_at": {
          "description": "When this problem was disclosed to the public.",
          "format": "date-time",
          "type": "string"
        },
        "discovered_at": {
          "description": "When this problem was first discovered.",
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "maxLength": 1024,
          "minLength": 1,
          "type": "string"
        },
        "source": {
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "updated_at": {
          "description": "When this problem was last updated.",
          "format": "date-time",
          "type": "string"
        },
        "url": {
          "description": "An optional URL for this problem.",
          "format": "uri",
          "maxLength": 4096,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "id",
        "source"
      ],
      "type": "object"
    },
    "Remedy3": {
      "properties": {
        "description": {
          "description": "A markdown-formatted optional description of this remedy.",
          "type": "string"
        },
        "details": {
          "properties": {
            "upgrade_package": {
              "description": "A minimum version to upgrade to in order to remedy the issue.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": {
          "description": "The type of the remedy. Always ‘indeterminate’.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ResourcePath": {
      "maxLength": 2024,
      "minLength": 1,
      "type": "string"
    },
    "ResourcePathRepresentation": {
      "description": "An object that contains an opaque identifying string.",
      "properties": {
        "resource_path": {
          "$ref": "#/$defs/ResourcePath"
        }
      },
      "required": [
        "resource_path"
      ],
      "type": "object"
    },
    "Severity3": {
      "properties": {
        "level": {
          "description": "Level of severity calculated via vector",
          "type": "string"
        },
        "score": {
          "description": "The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10.",
          "type": [
            "number",
            "null"
          ]
        },
        "source": {
          "description": "The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application.",
          "type": "string"
        },
        "type": {
          "description": "Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.",
          "type": "string"
        },
        "vector": {
          "description": "CVSS vector string detailing the metrics of a vulnerability.",
          "type": [
            "string",
            "null"
          ]
        },
        "version": {
          "description": "CVSS version being described.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Slots": {
      "properties": {
        "disclosure_time": {
          "description": "The time at which this vulnerability was disclosed.",
          "format": "date-time",
          "type": "string"
        },
        "exploit_details": {
          "$ref": "#/$defs/ExploitDetails"
        },
        "publication_time": {
          "description": "The time at which this vulnerability was published.",
          "type": "string"
        },
        "references": {
          "items": {
            "properties": {
              "title": {
                "description": "Descriptor for an external reference to the issue",
                "type": "string"
              },
              "url": {
                "description": "URL for an external reference to the issue",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  }
}