openapi: 3.2.0
info:
  title: CTIA Vulnerability API
  version: 4178275a824512c2fd3a2acdb0e8277233919054 v2.71.0
  license:
    name: All Rights Reserved
    url: ''
  contact:
    name: 'Cisco Security Business Group -- Advanced Threat '
    url: http://github.com/threatgrid/ctia
    email: cisco-intel-api-support@cisco.com
  description: "A Threat Intelligence API service\n\n  This API provides a mechanism for making Judgements on the Disposition\n  of Observables, which are then distilled into a final Verdict.  A\n  Disposition is a statement regarding the malicious, or otherwise,\n  nature of an Observable.\n\n  The Judgements can be grouped into Indicators, which can be associated\n  with Campaigns, Actors and TTPs.  Feedback can be given on specific\n  Judgements, indicating agreement or disagreement, or clarification.\n\n  When an Observable with a malicious Verdict is seen, it can be recorded as\n  a Sighting, and the Relations that Observable had with other Observables can\n  be recorded as well.\n\n  We support a pre-defined set of Observable Types.  Each Observable Type has a\n  specific form of natural identifier, its ID, which is almost always\n  the default way it is represented when observed in the wild.\n\n  * Ipv4/IPv6  -- 192.168.1.1\n  * Domain/Hostname -- foo.com, www.bar.com\n  * SHA256  -- the sha256 checksum of a file, or other data blob\n  * MD5 -- the md5 checksum of a file, or other data blob\n  * SHA1 -- the sha1 checksum of a file, or other data blob\n  * URL -- A minimal form of the URL\n\n  The Verdict is derived from all of the Judgements on that Observable which\n  have not yet expired.  The highest priority Judgement becomes the\n  active verdict.  If there is more than one Judgement with that\n  priority, than Clean disposition has priority over all others, then\n  Malicious disposition, and so on down to Unknown.\n\n  <a href='/doc/README.md'>CTIA Documentation</a>"
  x-provenance:
    method: harvested
    authored_by: Cisco XDR (CTIA)
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://private.intel.amp.cisco.com/index.html
  - type: raw
    url: https://private.intel.amp.cisco.com/swagger.json
servers:
- url: /
security:
- JWT: []
- oauth2:
  - private-intel
  - private-intel:read
  - private-intel:write
  - casebook
  - casebook:read
  - casebook:write
tags:
- name: Vulnerability
paths:
  /ctia/vulnerability/cpe_match_strings:
    get:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/x-yaml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/edn:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+msgpack:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
      parameters:
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: from
        description: ''
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: fields
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - schema_version
            - revision
            - source
            - title
            - source_uri
            - language
            - id
            - tlp
            - timestamp
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: limit
        description: Pagination Limit
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: cpe23_match_strings
        description: CPE 2.3 match strings to search by
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
      summary: List Vulnerabilities with configurations matching CPE 2.3 match strings
      description: Requires capability search-vulnerability.
  /ctia/vulnerability:
    post:
      tags:
      - Vulnerability
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/edn:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/Vulnerability'
      parameters:
      - in: query
        name: wait_for
        description: wait for entity to be available for search
        required: false
        schema:
          type: boolean
      summary: Adds a new Vulnerability
      description: Requires capability create-vulnerability.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/x-yaml:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/edn:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/transit+json:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/transit+msgpack:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
        description: a new Vulnerability
        required: true
  /ctia/vulnerability/{id}:
    put:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/edn:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/Vulnerability'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/Vulnerability'
      parameters:
      - in: query
        name: wait_for
        description: wait for updated entity to be available for search
        required: false
        schema:
          type: boolean
      - in: path
        name: id
        description: ''
        required: true
        schema:
          type: string
      summary: Update an existing Vulnerability
      description: Requires capability create-vulnerability.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/x-yaml:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/edn:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/transit+json:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
          application/transit+msgpack:
            schema:
              $ref: '#/components/schemas/NewVulnerability'
        description: an updated Vulnerability
        required: true
    get:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartialVulnerability'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/PartialVulnerability'
            application/edn:
              schema:
                $ref: '#/components/schemas/PartialVulnerability'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/PartialVulnerability'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/PartialVulnerability'
      summary: Get one Vulnerability by ID
      parameters:
      - in: path
        name: id
        description: ''
        required: true
        schema:
          type: string
      - in: query
        name: fields
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - schema_version
            - revision
            - source
            - title
            - source_uri
            - language
            - id
            - tlp
            - timestamp
      description: Requires capability read-vulnerability.
    delete:
      tags:
      - Vulnerability
      responses:
        '204':
          description: ''
      x-no-doc: false
      parameters:
      - in: path
        name: id
        description: ''
        required: true
        schema:
          type: string
      - in: query
        name: wait_for
        description: wait for deleted entity to no more be available for search
        required: false
        schema:
          type: boolean
      summary: Delete one Vulnerability
      description: Requires capability delete-vulnerability.
  /ctia/vulnerability/external_id/{external_id}:
    get:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/x-yaml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/edn:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+msgpack:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
      parameters:
      - in: query
        name: sort_by
        description: Sort results on a field
        required: false
        schema:
          type: string
          enum:
          - schema_version
          - revision
          - source
          - title
          - source_uri
          - language
          - id
          - tlp
          - timestamp
      - in: query
        name: sort_order
        description: Sort direction
        required: false
        schema:
          type: string
          enum:
          - desc
          - asc
      - in: query
        name: offset
        description: Pagination Offset
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: limit
        description: Pagination Limit
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: fields
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - schema_version
            - revision
            - source
            - title
            - source_uri
            - language
            - id
            - tlp
            - timestamp
      - in: path
        name: external_id
        description: ''
        required: true
        schema:
          type: string
      summary: List Vulnerability by external id
      description: Requires capability read-vulnerability.
  /ctia/vulnerability/search:
    get:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/x-yaml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/edn:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
            application/transit+msgpack:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartialVulnerability'
      summary: Search for Vulnerability entities using a ES query syntax and field filters
      description: Requires capability search-vulnerability.
      parameters:
      - in: query
        name: sort_order
        description: Sort direction
        required: false
        schema:
          type: string
          enum:
          - desc
          - asc
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: from
        description: ''
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: sort_by
        description: 'Sort result on fields.


          The following fields are supported: id, language, revision, schema_version, source, source_uri, timestamp, title, tlp


          Fields can be combined with '','' and sort order can be specified by '':asc'' and '':desc''. For example:


          -  id       # sort by id ascending

          -  id:desc  # sort by id descending

          -  id,language:desc  # sort by id ascending, then language descending'
        required: false
        schema:
          type: string
      - in: query
        name: fields
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - schema_version
            - revision
            - source
            - title
            - source_uri
            - language
            - id
            - tlp
            - timestamp
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: limit
        description: Pagination Limit
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: search_fields
        description: '''fields'' key of Elasticsearch Fulltext Query.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - short_description
            - title
            - source
            - description
      - in: query
        name: offset
        description: Pagination Offset
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
    delete:
      tags:
      - Vulnerability
      description: Requires capabilities delete-vulnerability, search-vulnerability.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
            application/x-yaml:
              schema:
                type: integer
                format: int64
            application/edn:
              schema:
                type: integer
                format: int64
            application/transit+json:
              schema:
                type: integer
                format: int64
            application/transit+msgpack:
              schema:
                type: integer
                format: int64
      summary: Delete Vulnerability entities matching given Lucene/ES query string or/and field filters
      parameters:
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: from
        description: ''
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: REALLY_DELETE_ALL_THESE_ENTITIES
        description: ' If you do not set this value or set it to false this route will perform a dry run. Set this value to true to perform the deletion. You MUST confirm you will fix the mess after the inevitable disaster that will occur after you perform that operation. DO NOT FORGET TO SET THAT TO FALSE AFTER EACH DELETION IF YOU INTEND TO USE THAT ROUTE MULTIPLE TIMES.'
        required: false
        schema:
          type: boolean
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: wait_for
        description: wait for matched entity to be deleted
        required: false
        schema:
          type: boolean
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
  /ctia/vulnerability/search/count:
    get:
      tags:
      - Vulnerability
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
            application/x-yaml:
              schema:
                type: integer
                format: int64
            application/edn:
              schema:
                type: integer
                format: int64
            application/transit+json:
              schema:
                type: integer
                format: int64
            application/transit+msgpack:
              schema:
                type: integer
                format: int64
      summary: Count Vulnerability matching a Lucene/ES query string and field filters
      description: Requires capability search-vulnerability.
      parameters:
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: from
        description: ''
        required: false
        schema:
          type: string
          format: date-time
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
  /ctia/vulnerability/metric/histogram:
    get:
      tags:
      - Vulnerability
      description: Requires capability search-vulnerability.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/edn:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/MetricResult'
      summary: Histogram for some Vulnerability field
      parameters:
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: granularity
        description: ''
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
      - in: query
        name: from
        description: Start date of the histogram. Filters the value of selected aggregated-on field.
        required: true
        schema:
          type: string
          format: date-time
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: aggregate-on
        description: ''
        required: true
        schema:
          type: string
          enum:
          - timestamp
      - in: query
        name: agg-key
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: timezone
        description: ''
        required: false
        schema:
          type: string
          enum:
          - -05:00
          - +02:00
          - +01:00
          - -09:00
          - -01:00
          - +03:00
          - +08:00
          - +04:00
          - +00:00
          - '+11:00'
          - '-10:00'
          - +05:00
          - -03:00
          - -04:00
          - -02:00
          - -07:00
          - '-11:00'
          - -06:00
          - '+10:00'
          - +09:00
          - +07:00
          - -08:00
          - +06:00
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: End date of the histogram. Filters the value of selected aggregated-on field.
        required: false
        schema:
          type: string
          format: date-time
  /ctia/vulnerability/metric/topn:
    get:
      tags:
      - Vulnerability
      description: Requires capability search-vulnerability.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/edn:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/MetricResult'
      summary: Topn for some Vulnerability field
      parameters:
      - in: query
        name: sort_order
        description: ''
        required: false
        schema:
          type: string
          enum:
          - desc
          - asc
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: limit
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: from
        description: ''
        required: true
        schema:
          type: string
          format: date-time
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: aggregate-on
        description: ''
        required: true
        schema:
          type: string
          enum:
          - source
      - in: query
        name: agg-key
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
  /ctia/vulnerability/metric/cardinality:
    get:
      tags:
      - Vulnerability
      description: Requires capability search-vulnerability.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/x-yaml:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/edn:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+json:
              schema:
                $ref: '#/components/schemas/MetricResult'
            application/transit+msgpack:
              schema:
                $ref: '#/components/schemas/MetricResult'
      summary: Cardinality for some Vulnerability field
      parameters:
      - in: query
        name: tlp
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: search_after
        description: Pagination stateless cursor
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: language
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: id
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: from
        description: ''
        required: true
        schema:
          type: string
          format: date-time
      - in: query
        name: source
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: aggregate-on
        description: ''
        required: true
        schema:
          type: string
          enum:
          - source
      - in: query
        name: query
        description: ''
        required: false
        schema:
          type: string
      - in: query
        name: simple_query
        description: Query String with simple query format
        required: false
        schema:
          type: string
      - in: query
        name: revision
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: to
        description: ''
        required: false
        schema:
          type: string
          format: date-time
components:
  schemas:
    CPEMatch:
      example:
        vulnerable: true
        cpe23Uri: string
        versionStartIncluding: string
        versionEndIncluding: string
        versionStartExcluding: string
        versionEndExcluding: string
      type: object
      properties:
        vulnerable:
          example: true
          type: boolean
        cpe23Uri:
          example: string
          description: A text representation of a software or hardware platform.
          type: string
        versionStartIncluding:
          example: string
          description: A string representing the lower bound(inclusive) of version in the CPE.
          type: string
        versionEndIncluding:
          example: string
          description: A string representing the upper bound(inclusive) of version in the CPE.
          type: string
        versionStartExcluding:
          example: string
          description: A string representing the lower bound(exclusive) of version in the CPE.
          type: string
        versionEndExcluding:
          example: string
          description: A string representing the upper bound(exclusive) of version in the CPE.
          type: string
      additionalProperties: false
      required:
      - vulnerable
      - cpe23Uri
    CPELeafNode:
      example:
        operator: AND
        cpe_match:
        - vulnerable: true
          cpe23Uri: string
          versionStartIncluding: string
          versionEndIncluding: string
          versionStartExcluding: string
          versionEndExcluding: string
        negate: true
      type: object
      properties:
        operator:
          example: AND
          description: The operator string influences how seqs of cpe matches are related to one another.
          type: string
          enum:
          - AND
          - OR
        cpe_match:
          example:
          - vulnerable: true
            cpe23Uri: string
            versionStartIncluding: string
            versionEndIncluding: string
            versionStartExcluding: string
            versionEndExcluding: string
          type: array
          items:
            $ref: '#/components/schemas/CPEMatch'
        negate:
          example: true
          description: Negates operator when true.
          type: boolean
      additionalProperties: false
      required:
      - operator
      - cpe_match
    MetricResultData:
      type: object
      additionalProperties: {}
    CVSSv3:
      example:
        integrity_impact: high
        modified_user_interaction: none
        modified_scope: not_defined
        availability_requirement: high
        user_interaction: none
        modified_integrity_impact: not_defined
        privileges_required: high
        exploitability_score: 10.0
        impact_score: 10.0
        environmental_severity: critical
        modified_availability_impact: not_defined
        availability_impact: high
        scope: changed
        exploit_code_maturity: functional
        modified_attack_complexity: not_defined
        base_severity: critical
        confidentiality_impact: high
        temporal_severity: critical
        modified_confidentiality_impact: not_defined
        confidentiality_requirement: high
        report_confidence: confirmed
        temporal_score: 10.0
        modified_privileges_required: not_defined
        modified_attack_vector: not_defined
        base_score: 10.0
        environmental_score: 10.0
        remediation_level: high
        vector_string: string
        integrity_requirement: high
        attack_vector: adjacent_network
        attack_complexity: high
      type: object
      properties:
        integrity_impact:
          example: high
          description: measures the impact to integrity of a successfully exploited vulnerability
          type: string
          enum:
          - low
          - none
          - high
        modified_user_interaction:
          example: none
          description: modified user interaction
          type: string
          enum:
          - none
          - required
          - not_defined
        modified_scope:
          example: not_defined
          description: modified scope
          type: string
          enum:
          - changed
          - unchanged
          - not_defined
        availability_requirement:
          example: high
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a user''s organization, measured in terms of Confidentiality, Integrity, and Availability. That is, if an IT asset supports a business function for which Availability is most important, the analyst can assign a greater value to Availability relative to Confidentiality and Integrity. Each security requirement has three possible values: Low, Medium, or High. The full effect on the environmental score is determined by the corresponding Modified Base Impact metrics. That is, these metrics modify the environmental score by reweighting the Modified Confidentiality, Integrity, and Availability impact metrics. For example, the Modified Confidentialityimpact (MC) metric has increased weight if the Confidentiality Requirement (CR) is High. Likewise, the Modified Confidentiality impact metric has decreased weight if the Confidentiality Requirement is Low. The Modified Confidentiality impact metric weighting is neutral if the Confidentiality Requirement is Medium. This same process is applied to the Integrity and Availability requirements.Note that the Confidentiality Requirement will not affect the Environmental score if the (Modified Base) confidentiality impact is set to None. Also, increasing the Confidentiality Requirement from Medium to Highwill not change the Environmental score when the (Modified Base) impact metrics are set to High. This is because the modified impact sub score (part of the Modified Base score that calculates impact) is already at a maximum value of 10. The list of possible values is: `not_defined`: Assigning this value to the metric will not influence the score. It is a signal to the equation to skip this metric. `high`: Loss of [Confidentiality / Integrity / Availability] is likely to have a catastrophic adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). `medium`: Loss of [Confidentiality / Integrity / Availability] is likely to have a serious adverse effect on the organization or individuals associated with the organization (e.g., employees, customers).`low`: Loss of [Confidentiality / Integrity / Availability] is likely to have only a limited adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). For brevity, the same table is used for all three metrics. The greater the Security Requirement, the higher the score (recall that Medium is considered the default).'
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        user_interaction:
          example: none
          description: captures the requirement for a user, other than the attacker, to participate in the successful compromise of the vulnerable component
          type: string
          enum:
          - none
          - required
        modified_integrity_impact:
          example: not_defined
          description: modified integrity impact
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        privileges_required:
          example: high
          description: describes the level of privileges an attacker must possess before successfully exploiting the vulnerability
          type: string
          enum:
          - low
          - none
          - high
        exploitability_score:
          example: 10.0
          description: a Score number from 0 to 10
          type: number
          format: double
        impact_score:
          example: 10.0
          description: a Score number from 0 to 10
          type: number
          format: double
        environmental_severity:
          example: critical
          type: string
          enum:
          - low
          - none
          - high
          - medium
          - critical
        modified_availability_impact:
          example: not_defined
          description: modified availability impact
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        availability_impact:
          example: high
          description: measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability
          type: string
          enum:
          - low
          - none
          - high
        scope:
          example: changed
          description: the ability for a vulnerability in one software component to impact resources beyond its means, or privileges
          type: string
          enum:
          - changed
          - unchanged
        exploit_code_maturity:
          example: functional
          description: measures the likelihood of the vulnerability being attacked
          type: string
          enum:
          - high
          - unproven
          - functional
          - proof_of_concept
          - not_defined
        modified_attack_complexity:
          example: not_defined
          description: modified attack complexity
          type: string
          enum:
          - low
          - high
          - not_defined
        base_severity:
          example: critical
          type: string
          enum:
          - low
          - none
          - high
          - medium
          - critical
        confidentiality_impact:
          example: high
          description: measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability
          type: string
          enum:
          - low
          - none
          - high
        temporal_severity:
          example: critical
          description: temporal severity
          type: string
          enum:
          - low
          - none
          - high
          - medium
          - critical
        modified_confidentiality_impact:
          example: not_defined
          description: modified confidentiality impact
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        confidentiality_requirement:
          example: high
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a user''s organization, measured in terms of Confidentiality, Integrity, and Availability. That is, if an IT asset supports a business function for which Availability is most important, the analyst can assign a greater value to Availability relative to Confidentiality and Integrity. Each security requirement has three possible values: Low, Medium, or High. The full effect on the environmental score is determined by the corresponding Modified Base Impact metrics. That is, these metrics modify the environmental score by reweighting the Modified Confidentiality, Integrity, and Availability impact metrics. For example, the Modified Confidentialityimpact (MC) metric has increased weight if the Confidentiality Requirement (CR) is High. Likewise, the Modified Confidentiality impact metric has decreased weight if the Confidentiality Requirement is Low. The Modified Confidentiality impact metric weighting is neutral if the Confidentiality Requirement is Medium. This same process is applied to the Integrity and Availability requirements.Note that the Confidentiality Requirement will not affect the Environmental score if the (Modified Base) confidentiality impact is set to None. Also, increasing the Confidentiality Requirement from Medium to Highwill not change the Environmental score when the (Modified Base) impact metrics are set to High. This is because the modified impact sub score (part of the Modified Base score that calculates impact) is already at a maximum value of 10. The list of possible values is: `not_defined`: Assigning this value to the metric will not influence the score. It is a signal to the equation to skip this metric. `high`: Loss of [Confidentiality / Integrity / Availability] is likely to have a catastrophic adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). `medium`: Loss of [Confidentiality / Integrity / Availability] is likely to have a serious adverse effect on the organization or individuals associated with the organization (e.g., employees, customers).`low`: Loss of [Confidentiality / Integrity / Availability] is likely to have only a limited adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). For brevity, the same table is used for all three metrics. The greater the Security Requirement, the higher the score (recall that Medium is considered the default).'
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        report_confidence:
          example: confirmed
          description: measures the degree of confidence in the existence of the vulnerability and the credibility of the known technical details
          type: string
          enum:
          - unknown
          - reasonable
          - confirmed
        temporal_score:
          example: 10.0
          description: Round up(CVSSv3BaseScore × CVSSv3ExploitCodeMaturity × CVSSv3RemediationLevel × CVSSv3ReportConfidence)
          type: number
          format: double
        modified_privileges_required:
          example: not_defined
          description: modified privileges required
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        modified_attack_vector:
          example: not_defined
          description: modified attack vector
          type: string
          enum:
          - network
          - adjacent_network
          - local
          - physical
          - not_defined
        base_score:
          example: 10.0
          description: 'The base score is a key metric in CVSS, which uses a scoring system to determine the level of severity of a vulnerability. see: https://www.first.org/cvss/v3-1'
          type: number
          format: double
        environmental_score:
          example: 10.0
          description: a Score number from 0 to 10
          type: number
          format: double
        remediation_level:
          example: high
          description: Remediation Level of a vulnerability is an important factor for prioritization
          type: string
          enum:
          - temporary_fix
          - offical_fix
          - high
          - workaround
          - unavailable
          - not_defined
        vector_string:
          example: string
          description: a text representation of a set of CVSSv3 metrics. It is commonly used to record or transfer CVSSv3 metric information in a concise form
          type: string
        integrity_requirement:
          example: high
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a user''s organization, measured in terms of Confidentiality, Integrity, and Availability. That is, if an IT asset supports a business function for which Availability is most important, the analyst can assign a greater value to Availability relative to Confidentiality and Integrity. Each security requirement has three possible values: Low, Medium, or High. The full effect on the environmental score is determined by the corresponding Modified Base Impact metrics. That is, these metrics modify the environmental score by reweighting the Modified Confidentiality, Integrity, and Availability impact metrics. For example, the Modified Confidentialityimpact (MC) metric has increased weight if the Confidentiality Requirement (CR) is High. Likewise, the Modified Confidentiality impact metric has decreased weight if the Confidentiality Requirement is Low. The Modified Confidentiality impact metric weighting is neutral if the Confidentiality Requirement is Medium. This same process is applied to the Integrity and Availability requirements.Note that the Confidentiality Requirement will not affect the Environmental score if the (Modified Base) confidentiality impact is set to None. Also, increasing the Confidentiality Requirement from Medium to Highwill not change the Environmental score when the (Modified Base) impact metrics are set to High. This is because the modified impact sub score (part of the Modified Base score that calculates impact) is already at a maximum value of 10. The list of possible values is: `not_defined`: Assigning this value to the metric will not influence the score. It is a signal to the equation to skip this metric. `high`: Loss of [Confidentiality / Integrity / Availability] is likely to have a catastrophic adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). `medium`: Loss of [Confidentiality / Integrity / Availability] is likely to have a serious adverse effect on the organization or individuals associated with the organization (e.g., employees, customers).`low`: Loss of [Confidentiality / Integrity / Availability] is likely to have only a limited adverse effect on the organization or individuals associated with the organization (e.g., employees, customers). For brevity, the same table is used for all three metrics. The greater the Security Requirement, the higher the score (recall that Medium is considered the default).'
          type: string
          enum:
          - low
          - none
          - high
          - not_defined
        attack_vector:
          example: adjacent_network
          description: Reflects the context by which vulnerability exploitation is possible
          type: string
          enum:
          - network
          - adjacent_network
          - local
          - physical
        attack_complexity:
          example: high
          description: describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability
          type: string
          enum:
          - low
          - high
      additionalProperties: false
      required:
      - base_severity
      - base_score
      - vector_string
    VulnerabilityImpact:
      example:
        cvss_v2:
          integrity_impact: complete
          target_distribution: not_defined
          availability_requirement: not_defined
          exploitability: not_defined
          access_complexity: low
          temporal_vector_string: string
          exploitability_score: 10.0
          impact_score: 10.0
          user_interaction_required: true
          environmental_vector_string: string
          obtain_other_privilege: true
          availability_impact: complete
          access_vector: network
          base_severity: High
          confidentiality_impact: complete
          confidentiality_requirement: not_defined
          report_confidence: not_defined
          authentication: none
          base_score: 10.0
          obtain_user_privilege: true
          obtain_all_privilege: true
          collateral_damage_potential: not_defined
          remediation_level: not_defined
          vector_string: string
          integrity_requirement: not_defined
        cvss_v3:
          integrity_impact: high
          modified_user_interaction: none
          modified_scope: not_defined
          availability_requirement: high
          user_interaction: none
          modified_integrity_impact: not_defined
          privileges_required: high
          exploitability_score: 10.0
          impact_score: 10.0
          environmental_severity: critical
          modified_availability_impact: not_defined
          availability_impact: high
          scope: changed
          exploit_code_maturity: functional
          modified_attack_complexity: not_defined
          base_severity: critical
          confidentiality_impact: high
          temporal_severity: critical
          modified_confidentiality_impact: not_defined
          confidentiality_requirement: high
          report_confidence: confirmed
          temporal_score: 10.0
          modified_privileges_required: not_defined
          modified_attack_vector: not_defined
          base_score: 10.0
          environmental_score: 10.0
          remediation_level: high
          vector_string: string
          integrity_requirement: high
          attack_vector: adjacent_network
          attack_complexity: high
      description: "Describes the potential impact of a vulnerability that is being tracked in the system. Provides information on the extent of damage that a vulnerability can cause and how serious the consequences could be if it is exploited. \n\nMay contain granular information about the vulnerability severity using the CVSS system, versions 2 and 3.\n\nCVSSv2 and CVSSv3 have different methods of calculating base scores, but both are designed to provide an indication of the level of risk that a vulnerability poses. The base score ranges from 0 to 10, with 10 being the most severe. Additionally, both CVSSv2 and CVSSv3 define severity levels, such as low, medium, high, and critical, based on the base score."
      type: object
      properties:
        cvss_v2:
          $ref: '#/components/schemas/CVSSv2'
        cvss_v3:
          $ref: '#/components/schemas/CVSSv3'
      additionalProperties: false
    CPENode:
      example:
        operator: AND
        cpe_match:
        - vulnerable: true
          cpe23Uri: string
          versionStartIncluding: string
          versionEndIncluding: string
          versionStartExcluding: string
          versionEndExcluding: string
        children:
        - operator: AND
          cpe_match:
          - vulnerable: true
            cpe23Uri: string
            versionStartIncluding: string
            versionEndIncluding: string
            versionStartExcluding: string
            versionEndExcluding: string
          negate: true
        negate: true
      type: object
      properties:
        operator:
          example: AND
          description: The operator string influences how seqs of cpe matches are related to one another.
          type: string
          enum:
          - AND
          - OR
        cpe_match:
          example:
          - vulnerable: true
            cpe23Uri: string
            versionStartIncluding: string
            versionEndIncluding: string
            versionStartExcluding: string
            versionEndExcluding: string
          type: array
          items:
            $ref: '#/components/schemas/CPEMatch'
        children:
          example:
          - operator: AND
            cpe_match:
            - vulnerable: true
              cpe23Uri: string
              versionStartIncluding: string
              versionEndIncluding: string
              versionStartExcluding: string
              versionEndExcluding: string
            negate: true
          type: array
          items:
            $ref: '#/components/schemas/CPELeafNode'
        negate:
          example: true
          description: Negates operator when true.
          type: boolean
      additionalProperties: false
      required:
      - operator
    CVSSv2:
      example:
        integrity_impact: complete
        target_distribution: not_defined
        availability_requirement: not_defined
        exploitability: not_defined
        access_complexity: low
        temporal_vector_string: string
        exploitability_score: 10.0
        impact_score: 10.0
        user_interaction_required: true
        environmental_vector_string: string
        obtain_other_privilege: true
        availability_impact: complete
        access_vector: network
        base_severity: High
        confidentiality_impact: complete
        confidentiality_requirement: not_defined
        report_confidence: not_defined
        authentication: none
        base_score: 10.0
        obtain_user_privilege: true
        obtain_all_privilege: true
        collateral_damage_potential: not_defined
        remediation_level: not_defined
        vector_string: string
        integrity_requirement: not_defined
      type: object
      properties:
        integrity_impact:
          example: complete
          description: This metric measures the impact to integrity of a successfully exploited vulnerability. Integrity refers to the trustworthiness and guaranteed veracity of information. Increased integrity impact increases the vulnerability score.
          type: string
          enum:
          - partial
          - none
          - complete
        target_distribution:
          example: not_defined
          description: This metric measures the proportion of vulnerable systems. It is meant as an environment-specific indicator in order to approximate the percentage of systems that could be affected by the vulnerability. The greater the proportion of vulnerable systems, the higher the score.
          type: string
          enum:
          - low
          - none
          - high
          - medium
          - not_defined
        availability_requirement:
          example: not_defined
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a users organization, measured in terms of confidentiality, integrity, and availability, That is, if an IT asset supports a business function for which availability is most important, the analyst can assign a greater value to availability, relative to confidentiality and integrity. Each security requirement has three possible values: low, medium, or high.'
          type: string
          enum:
          - low
          - high
          - medium
          - not_defined
        exploitability:
          example: not_defined
          description: This metric measures the current state of exploit techniques or code availability. Public availability of easy-to-use exploit code increases the number of potential attackers by including those who are unskilled thereby increasing the severity of the vulnerability.
          type: string
          enum:
          - high
          - unproven
          - functional
          - proof_of_concept
          - not_defined
        access_complexity:
          example: low
          description: 'This metric measures the complexity of the attack required to exploit the vulnerability once an attacker has gained access to the target system. For example, consider a buffer overflow in an Internet service: once the target system is located, the attacker can launch an exploit at will.'
          type: string
          enum:
          - low
          - high
          - medium
        temporal_vector_string:
          example: string
          description: A text representation of a set of CVSSv2 temporal metrics. Temporal metrics allow analysists to calculate threat severity based on temporal factors such as reliability of vulnerability reports, availability of mitigations, and the ease or difficulty of conducting the exploit. It is commonly used to record or transfer CVSSv2 metric information in a concise form
          type: string
        exploitability_score:
          example: 10.0
          description: a Score number from 0 to 10
          type: number
          format: double
        impact_score:
          example: 10.0
          description: a Score number from 0 to 10
          type: number
          format: double
        user_interaction_required:
          example: true
          type: boolean
        environmental_vector_string:
          example: string
          description: A text representation of a set of CVSSv2 environmental metrics. Environmental metrics allow analysists to calculate threat scores in relation to environmental security requirements, collateral damage potential, and target availability. It is commonly used to record or transfer CVSSv2 metric information in a concise form
          type: string
        obtain_other_privilege:
          example: true
          type: boolean
        availability_impact:
          example: complete
          description: This metric measures the impact to availability of a successfully exploited vulnerability. Availability refers to the accessibility of information resources. Attacks that consume network bandwidth, processor cycles, or disk space all impact the availability of a system. Increased availability impact increases the vulnerability score.
          type: string
          enum:
          - partial
          - none
          - complete
        access_vector:
          example: network
          description: This metric reflects how the vulnerability is exploited.The more remote an attacker can be to attack a host, the greater the vulnerability score.
          type: string
          enum:
          - network
          - adjacent network
          - local
        base_severity:
          example: High
          type: string
          enum:
          - Medium
          - Info
          - Unknown
          - None
          - High
          - Low
        confidentiality_impact:
          example: complete
          description: This metric measures the impact on confidentiality of a successfully exploited vulnerability. Confidentiality refers to limiting information access and disclosure to only authorized users, as well as preventing access by, or disclosure to, unauthorized ones. Increasedconfidentiality impact increases the vulnerability score.
          type: string
          enum:
          - partial
          - none
          - complete
        confidentiality_requirement:
          example: not_defined
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a users organization, measured in terms of confidentiality, integrity, and availability, That is, if an IT asset supports a business function for which availability is most important, the analyst can assign a greater value to availability, relative to confidentiality and integrity. Each security requirement has three possible values: low, medium, or high.'
          type: string
          enum:
          - low
          - high
          - medium
          - not_defined
        report_confidence:
          example: not_defined
          description: This metric measures the degree of confidence in the existence of the vulnerability and the credibility of the known technical details. Sometimes, only the existence of vulnerabilities are publicized, but without specific details. The vulnerability may later be corroborated and then confirmed through acknowledgement by the author or vendor of the affected technology. The urgency of a vulnerability is higher when a vulnerability is known to exist with certainty. This metric also suggests the level of technical knowledge available to would-be attackers. The more a vulnerability is validated by the vendor or other reputable sources, the higher the score.
          type: string
          enum:
          - uncorroborated
          - unconfirmed
          - confirmed
          - not_defined
        authentication:
          example: none
          description: This metric measures the number of times an attacker must authenticate to a target in order to exploit a vulnerability. This metric does not gauge the strength or complexity of the authentication process, only that an attacker is required to provide credentials before an exploit may occur. The fewer authentication instances that are required, the higher the vulnerability score.
          type: string
          enum:
          - none
          - single
          - multiple
        base_score:
          example: 10.0
          description: 'The base score is a key metric in CVSS, which uses a scoring system to determine the level of severity of a vulnerability. see: https://www.first.org/cvss/v2/guide'
          type: number
          format: double
        obtain_user_privilege:
          example: true
          type: boolean
        obtain_all_privilege:
          example: true
          type: boolean
        collateral_damage_potential:
          example: not_defined
          description: This metric measures the potential for loss of life or physical assets through damage or theft of property or equipment.  The metric may also measure economic loss of productivity or revenue. Naturally, the greater the damage potential, the higher the vulnerability score.
          type: string
          enum:
          - low
          - none
          - high
          - medium_high
          - low_medium
          - not_defined
        remediation_level:
          example: not_defined
          description: The remediation level of a vulnerability is an important factor for prioritization. The typical vulnerability is unpatched when initially published. Workarounds or hotfixes may offer interim remediation until an official patch or upgrade is issued. Each of these respective stages adjusts the temporal score downwards, reflecting the decreasing urgency as remediation becomes final. The less official and permanent a fix, the higher the vulnerability score is.
          type: string
          enum:
          - temporary_fix
          - workaround
          - official_fix
          - unavailable
          - not_defined
        vector_string:
          example: string
          description: a text representation of a set of CVSSv2 metrics. It is commonly used to record or transfer CVSSv2 metric information in a concise form
          type: string
        integrity_requirement:
          example: not_defined
          description: 'These metrics enable the analyst to customize the CVSS score depending on the importance of the affected IT asset to a users organization, measured in terms of confidentiality, integrity, and availability, That is, if an IT asset supports a business function for which availability is most important, the analyst can assign a greater value to availability, relative to confidentiality and integrity. Each security requirement has three possible values: low, medium, or high.'
          type: string
          enum:
          - low
          - high
          - medium
          - not_defined
      additionalProperties: false
      required:
      - base_severity
      - base_score
      - vector_string
    CVE:
      example:
        cve_data_meta:
          id: string
          assigner: string
      type: object
      properties:
        cve_data_meta:
          $ref: '#/components/schemas/CVEDataMeta'
      additionalProperties: false
      required:
      - cve_data_meta
    PartialVulnerability:
      example:
        description: string
        schema_version: 1.3.30
        revision: 10
        published_date: '2016-01-01T01:01:01.000Z'
        cve:
          cve_data_meta:
            id: string
            assigner: string
        configurations:
          CVE_data_version: string
          nodes:
          - operator: AND
            cpe_match:
            - vulnerable: true
              cpe23Uri: string
              versionStartIncluding: string
              versionEndIncluding: string
              versionStartExcluding: string
              versionEndExcluding: string
            children:
            - operator: AND
              cpe_match:
              - vulnerable: true
                cpe23Uri: string
                versionStartIncluding: string
                versionEndIncluding: string
                versionStartExcluding: string
                versionEndExcluding: string
              negate: true
            negate: true
        type: vulnerability
        source: string
        external_ids:
        - string
        short_description: string
        title: string
        external_references:
        - source_name: string
          description: string
          url: string
          hashes:
          - string
          external_id: string
        source_uri: string
        language: string
        id: string
        tlp: green
        timestamp: '2016-01-01T01:01:01.000Z'
        last_modified_date: '2016-01-01T01:01:01.000Z'
        impact:
          cvss_v2:
            integrity_impact: complete
            target_distribution: not_defined
            availability_requirement: not_defined
            exploitability: not_defined
            access_complexity: low
            temporal_vector_string: string
            exploitability_score: 10.0
            impact_score: 10.0
            user_interaction_required: true
            environmental_vector_string: string
            obtain_other_privilege: true
            availability_impact: complete
            access_vector: network
            base_severity: High
            confidentiality_impact: complete
            confidentiality_requirement: not_defined
            report_confidence: not_defined
            authentication: none
            base_score: 10.0
            obtain_user_privilege: true
            obtain_all_privilege: true
            collateral_damage_potential: not_defined
            remediation_level: not_defined
            vector_string: string
            integrity_requirement: not_defined
          cvss_v3:
            integrity_impact: high
            modified_user_interaction: none
            modified_scope: not_defined
            availability_requirement: high
            user_interaction: none
            modified_integrity_impact: not_defined
            privileges_required: high
            exploitability_score: 10.0
            impact_score: 10.0
            environmental_severity: critical
            modified_availability_impact: not_defined
            availability_impact: high
            scope: changed
            exploit_code_maturity: functional
            modified_attack_complexity: not_defined
            base_severity: critical
            confidentiality_impact: high
            temporal_severity: critical
            modified_confidentiality_impact: not_defined
            confidentiality_requirement: high
            report_confidence: confirmed
            temporal_score: 10.0
            modified_privileges_required: not_defined
            modified_attack_vector: not_defined
            base_score: 10.0
            environmental_score: 10.0
            remediation_level: high
            vector_string: string
            integrity_requirement: high
            attack_vector: adjacent_network
            attack_complexity: high
      description: Indicates weakness or flaw in the system that can be exploited by an attacker to gain unauthorized access or cause harm to the system. Vulnerabilities can exist in various components of the system, such as the operating system, applications, network devices, and databases.
      type: object
      properties:
        description:
          example: string
          description: A description of object, which may be detailed.
          type: string
        authorized_groups:
          type: array
          items:
            type: string
        schema_version:
          type: string
        revision:
          example: 10
          description: A monotonically increasing revision, incremented each time the object is changed.
          type: integer
          format: int64
        published_date:
          example: '2016-01-01T01:01:01.000Z'
          description: "Represents the date when a vulnerability was publicly disclosed or made available to the general public. \n\nImportant for tracking the age of a vulnerability, as well as for determining when a particular vulnerability was first introduced into a system. The published date can be used to identify the time window during which a system may have been vulnerable to a particular exploit.\n\nFor example, if an organization discovers that a vulnerability was published before their system's installation date, but they did not apply the necessary security updates in a timely manner, it can be concluded that their system was vulnerable for the period between the installation date and the date when the necessary security updates were applied."
          type: string
          format: date-time
        cve:
          $ref: '#/components/schemas/CVE'
        configurations:
          $ref: '#/components/schemas/Configurations'
        authorized_users:
          type: array
          items:
            type: string
        type:
          example: vulnerability
          description: The fixed value vulnerability
          type: string
          enum:
          - vulnerability
        created:
          type: string
          format: date-time
        source:
          example: string
          description: Represents the source of the intelligence that led to the creation of the entity.
          type: string
        external_ids:
          example:
          - string
          description: "It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners."
          type: array
          items:
            type: string
        modified:
          type: string
          format: date-time
        short_description:
          example: string
          description: A single line, short summary of the object.
          type: string
        title:
          example: string
          description: A short title for this object, used as primary display and reference value.
          type: string
        external_references:
          example:
          - source_name: string
            description: string
            url: string
            hashes:
            - string
            external_id: string
          description: "Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier."
          type: array
          items:
            $ref: '#/components/schemas/ExternalReference'
        source_uri:
          example: string
          description: URI of the source of the intelligence that led to the creation of the entity.
          type: string
        language:
          example: string
          description: 'The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.


            For example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.'
          type: string
        id:
          example: string
          description: Globally unique URI identifying this object.
          type: string
        tlp:
          example: green
          description: 'TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.


            It is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.


            For example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.'
          type: string
          enum:
          - white
          - green
          - red
          - amber
        client_id:
          type: string
        groups:
          type: array
          items:
            type: string
        timestamp:
          example: '2016-01-01T01:01:01.000Z'
          description: The time this object was created at, or last modified.
          type: string
          format: date-time
        last_modified_date:
          example: '2016-01-01T01:01:01.000Z'
          description: 'Represents the date when the vulnerability metadata was last updated in the internal database.

            It can be used to track the freshness of the vulnerability information. If the `last_modified_date` is more recent than the `published_date`, it can indicate that there has been some new information or updates related to the vulnerability, such as new patch releases or changes in the severity or impact rating.'
          type: string
          format: date-time
        impact:
          $ref: '#/components/schemas/VulnerabilityImpact'
        owner:
          type: string
      additionalProperties: false
    MetricResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MetricResultData'
        type:
          type: string
          enum:
          - histogram
          - topn
          - avg
          - cardinality
        filters:
          $ref: '#/components/schemas/MetricResultFilters'
      additionalProperties: false
      required:
      - data
      - type
      - filters
    ExternalReference:
      example:
        source_name: string
        description: string
        url: string
        hashes:
        - string
        external_id: string
      description: External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to indicate an ID for that malware in an external database or a report could use references to represent source material.
      type: object
      properties:
        source_name:
          example: string
          description: The source within which the external-reference is defined (system, registry, organization, etc.)
          type: string
        description:
          example: string
          description: Markdown string with at most 5000 characters.
          type: string
        url:
          example: string
          description: A URL reference to an external resource.
          type: string
        hashes:
          example:
          - string
          description: Specifies a dictionary of hashes for the contents of the url.
          type: array
          items:
            type: string
        external_id:
          example: string
          description: An identifier for the external reference content.
          type: string
      additionalProperties: false
      required:
      - source_name
    CVEDataMeta:
      example:
        id: string
        assigner: string
      type: object
      properties:
        id:
          example: string
          description: String with at most 1024 characters.
          type: string
        assigner:
          example: string
          description: String with at most 1024 characters.
          type: string
      additionalProperties: false
    NewVulnerability:
      description: a new Vulnerability
      type: object
      properties:
        description:
          example: string
          description: "Various sources of vulnerability information can be used, including third-party  resources like the National Vulnerability Database (NVD) and the Common  Vulnerabilities and Exposures (CVE) database. The platform then analyzes this  data and provides the user with relevant details such as the severity of the  vulnerability, the affected systems, and remediation recommendations. \n\n Based on this information, the user can prioritize patching and other mitigation  strategies to reduce the risk of potential attacks."
          type: string
        authorized_groups:
          type: array
          items:
            type: string
        schema_version:
          type: string
        revision:
          example: 10
          description: A monotonically increasing revision, incremented each time the object is changed.
          type: integer
          format: int64
        published_date:
          example: '2016-01-01T01:01:01.000Z'
          description: "Represents the date when a vulnerability was publicly disclosed or made available to the general public. \n\nImportant for tracking the age of a vulnerability, as well as for determining when a particular vulnerability was first introduced into a system. The published date can be used to identify the time window during which a system may have been vulnerable to a particular exploit.\n\nFor example, if an organization discovers that a vulnerability was published before their system's installation date, but they did not apply the necessary security updates in a timely manner, it can be concluded that their system was vulnerable for the period between the installation date and the date when the necessary security updates were applied."
          type: string
          format: date-time
        cve:
          $ref: '#/components/schemas/CVE'
        configurations:
          $ref: '#/components/schemas/Configurations'
        authorized_users:
          type: array
          items:
            type: string
        type:
          example: vulnerability
          description: The fixed value "vulnerability"
          type: string
          enum:
          - vulnerability
        created:
          type: string
          format: date-time
        source:
          example: string
          description: Represents the source of the intelligence that led to the creation of the entity.
          type: string
        external_ids:
          example:
          - string
          description: "It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners."
          type: array
          items:
            type: string
        modified:
          type: string
          format: date-time
        short_description:
          example: string
          description: A single line, short summary of the object.
          type: string
        title:
          example: string
          description: A short title for this object, used as primary display and reference value.
          type: string
        external_references:
          example:
          - source_name: string
            description: string
            url: string
            hashes:
            - string
            external_id: string
          description: "Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier."
          type: array
          items:
            $ref: '#/components/schemas/ExternalReference'
        source_uri:
          example: string
          description: URI of the source of the intelligence that led to the creation of the entity.
          type: string
        language:
          example: string
          description: 'The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.


            For example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.'
          type: string
        id:
          example: string
          description: IDs are URIs, for example `https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014` for a [Judgement](judgement.md). This _ID_ type compares to the STIX _id_ field. The optional STIX _idref_ field is not used.
          type: string
        tlp:
          example: green
          description: 'TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.


            It is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.


            For example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.'
          type: string
          enum:
          - white
          - green
          - red
          - amber
        client_id:
          type: string
        groups:
          type: array
          items:
            type: string
        timestamp:
          example: '2016-01-01T01:01:01.000Z'
          description: The time this object was created at, or last modified.
          type: string
          format: date-time
        last_modified_date:
          example: '2016-01-01T01:01:01.000Z'
          description: 'Represents the date when the vulnerability metadata was last updated in the internal database.

            It can be used to track the freshness of the vulnerability information. If the `last_modified_date` is more recent than the `published_date`, it can indicate that there has been some new information or updates related to the vulnerability, such as new patch releases or changes in the severity or impact rating.'
          type: string
          format: date-time
        impact:
          $ref: '#/components/schemas/VulnerabilityImpact'
        owner:
          type: string
      additionalProperties: false
      required:
      - description
    MetricResultFilters:
      type: object
      properties:
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
      additionalProperties: {}
      required:
      - from
      - to
    Configurations:
      example:
        CVE_data_version: string
        nodes:
        - operator: AND
          cpe_match:
          - vulnerable: true
            cpe23Uri: string
            versionStartIncluding: string
            versionEndIncluding: string
            versionStartExcluding: string
            versionEndExcluding: string
          children:
          - operator: AND
            cpe_match:
            - vulnerable: true
              cpe23Uri: string
              versionStartIncluding: string
              versionEndIncluding: string
              versionStartExcluding: string
              versionEndExcluding: string
            negate: true
          negate: true
      description: "Represents a list of affected versions or configurations of a software component that is impacted by a vulnerability. \nBy tracking the affected software components and versions, defenders can identify which systems are potentially exposed to an attack, and apply appropriate mitigations."
      type: object
      properties:
        CVE_data_version:
          example: string
          description: Specifies the version of the CVE (Common Vulnerabilities and Exposures) dictionary used by the vulnerability information provider.
          type: string
        nodes:
          example:
          - operator: AND
            cpe_match:
            - vulnerable: true
              cpe23Uri: string
              versionStartIncluding: string
              versionEndIncluding: string
              versionStartExcluding: string
              versionEndExcluding: string
            children:
            - operator: AND
              cpe_match:
              - vulnerable: true
                cpe23Uri: string
                versionStartIncluding: string
                versionEndIncluding: string
                versionStartExcluding: string
                versionEndExcluding: string
              negate: true
            negate: true
          description: Each `node` in the CTIM standard configuration includes information such as the `operator` (such as "less than", or "greater than or equal to"), and the `cpe` (Common Platform Enumeration) string which identifies the specific software, `CPE` is a structured naming scheme for IT systems, platforms, and software packages, and it is instrumental in enabling data exchange between different systems.
          type: array
          items:
            $ref: '#/components/schemas/CPENode'
      additionalProperties: false
      required:
      - CVE_data_version
      - nodes
    Vulnerability:
      example:
        description: string
        schema_version: 1.3.30
        revision: 10
        published_date: '2016-01-01T01:01:01.000Z'
        cve:
          cve_data_meta:
            id: string
            assigner: string
        configurations:
          CVE_data_version: string
          nodes:
          - operator: AND
            cpe_match:
            - vulnerable: true
              cpe23Uri: string
              versionStartIncluding: string
              versionEndIncluding: string
              versionStartExcluding: string
              versionEndExcluding: string
            children:
            - operator: AND
              cpe_match:
              - vulnerable: true
                cpe23Uri: string
                versionStartIncluding: string
                versionEndIncluding: string
                versionStartExcluding: string
                versionEndExcluding: string
              negate: true
            negate: true
        type: vulnerability
        source: string
        external_ids:
        - string
        short_description: string
        title: string
        external_references:
        - source_name: string
          description: string
          url: string
          hashes:
          - string
          external_id: string
        source_uri: string
        language: string
        id: string
        tlp: green
        timestamp: '2016-01-01T01:01:01.000Z'
        last_modified_date: '2016-01-01T01:01:01.000Z'
        impact:
          cvss_v2:
            integrity_impact: complete
            target_distribution: not_defined
            availability_requirement: not_defined
            exploitability: not_defined
            access_complexity: low
            temporal_vector_string: string
            exploitability_score: 10.0
            impact_score: 10.0
            user_interaction_required: true
            environmental_vector_string: string
            obtain_other_privilege: true
            availability_impact: complete
            access_vector: network
            base_severity: High
            confidentiality_impact: complete
            confidentiality_requirement: not_defined
            report_confidence: not_defined
            authentication: none
            base_score: 10.0
            obtain_user_privilege: true
            obtain_all_privilege: true
            collateral_damage_potential: not_defined
            remediation_level: not_defined
            vector_string: string
            integrity_requirement: not_defined
          cvss_v3:
            integrity_impact: high
            modified_user_interaction: none
            modified_scope: not_defined
            availability_requirement: high
            user_interaction: none
            modified_integrity_impact: not_defined
            privileges_required: high
            exploitability_score: 10.0
            impact_score: 10.0
            environmental_severity: critical
            modified_availability_impact: not_defined
            availability_impact: high
            scope: changed
            exploit_code_maturity: functional
            modified_attack_complexity: not_defined
            base_severity: critical
            confidentiality_impact: high
            temporal_severity: critical
            modified_confidentiality_impact: not_defined
            confidentiality_requirement: high
            report_confidence: confirmed
            temporal_score: 10.0
            modified_privileges_required: not_defined
            modified_attack_vector: not_defined
            base_score: 10.0
            environmental_score: 10.0
            remediation_level: high
            vector_string: string
            integrity_requirement: high
            attack_vector: adjacent_network
            attack_complexity: high
      description: Indicates weakness or flaw in the system that can be exploited by an attacker to gain unauthorized access or cause harm to the system. Vulnerabilities can exist in various components of the system, such as the operating system, applications, network devices, and databases.
      type: object
      properties:
        description:
          example: string
          description: A description of object, which may be detailed.
          type: string
        schema_version:
          type: string
        revision:
          example: 10
          description: A monotonically increasing revision, incremented each time the object is changed.
          type: integer
          format: int64
        published_date:
          example: '2016-01-01T01:01:01.000Z'
          description: "Represents the date when a vulnerability was publicly disclosed or made available to the general public. \n\nImportant for tracking the age of a vulnerability, as well as for determining when a particular vulnerability was first introduced into a system. The published date can be used to identify the time window during which a system may have been vulnerable to a particular exploit.\n\nFor example, if an organization discovers that a vulnerability was published before their system's installation date, but they did not apply the necessary security updates in a timely manner, it can be concluded that their system was vulnerable for the period between the installation date and the date when the necessary security updates were applied."
          type: string
          format: date-time
        cve:
          $ref: '#/components/schemas/CVE'
        configurations:
          $ref: '#/components/schemas/Configurations'
        type:
          example: vulnerability
          description: The fixed value vulnerability
          type: string
          enum:
          - vulnerability
        source:
          example: string
          description: Represents the source of the intelligence that led to the creation of the entity.
          type: string
        external_ids:
          example:
          - string
          description: "It is used to store a list of external identifiers that can be linked to the incident, providing a reliable and manageable way to correlate and group related events across multiple data sources. It is especially useful in larger organizations that rely on multiple security information and event management (SIEM) systems to detect security incidents. For instance, it can be used to track events across different network sensors, intrusion detection and prevention systems (IDPS), or log management platforms. \n The field can also be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. It can be used to cross-reference with other external tools such as threat intelligence feeds and vulnerability scanners."
          type: array
          items:
            type: string
        short_description:
          example: string
          description: A single line, short summary of the object.
          type: string
        title:
          example: string
          description: A short title for this object, used as primary display and reference value.
          type: string
        external_references:
          example:
          - source_name: string
            description: string
            url: string
            hashes:
            - string
            external_id: string
          description: "Specifies a list of external references which refers to non-CTIM information.\n\nSimilar to `external_ids` field with major differences:\n\n- `external_ids` field is used to store a list of external identifiers that can be used to link entities across different data sources. These identifiers are typically standardized and well-known, such as CVE IDs, US-CERT advisories, or other industry-standard threat intelligence feeds. The `external_ids` field can be used to facilitate automation and orchestration workflows, where additional information can be shared among incident management systems. \n\n- `external_references` field, on the other hand, is used to provide a more general mechanism for linking entities to external sources of information. The `external_references` field can include references to blog posts, articles, external documents, threat intelligence reports, and other sources of information that may not have a standardized format or identifier."
          type: array
          items:
            $ref: '#/components/schemas/ExternalReference'
        source_uri:
          example: string
          description: URI of the source of the intelligence that led to the creation of the entity.
          type: string
        language:
          example: string
          description: 'The `language` field is used to specify the primary language of the affected system or the target of an attack. It can be used to provide additional context and information about the entity. The primary purpose of this field is to help analysts filter and prioritize entities based on their knowledge and expertise of different languages.


            For example, if an incident involves an attack on a system in a country where a specific language is predominant, the `language` field can be used to indicate that language, which can help analysts to quickly identify and respond to incidents that may be geographically or culturally relevant. This information can be used to prioritize incidents based on their potential impact. The `language` field can also be used to help with correlation of incidents across different systems and regions, as well as to help with data analysis and reporting.'
          type: string
        id:
          example: string
          description: Globally unique URI identifying this object.
          type: string
        tlp:
          example: green
          description: 'TLP stands for [Traffic Light Protocol](https://www.us-cert.gov/tlp), which indicates precisely how a resource is intended to be shared, replicated, copied, etc.


            It is used to indicate the sensitivity of the information contained within the message. This allows recipients to determine the appropriate handling and dissemination of the information based on their clearance level and need-to-know.


            For example, an entity containing information about a critical vulnerability in a widely-used software might be marked as `red`, indicating that it should only be shared with a small group of highly trusted individuals who need to know in order to take appropriate action. On the other hand, a message containing more general information about security threats might be marked as `amber` or `green`, indicating that it can be shared more broadly within an organization.'
          type: string
          enum:
          - white
          - green
          - red
          - amber
        timestamp:
          example: '2016-01-01T01:01:01.000Z'
          description: The time this object was created at, or last modified.
          type: string
          format: date-time
        last_modified_date:
          example: '2016-01-01T01:01:01.000Z'
          description: 'Represents the date when the vulnerability metadata was last updated in the internal database.

            It can be used to track the freshness of the vulnerability information. If the `last_modified_date` is more recent than the `published_date`, it can indicate that there has been some new information or updates related to the vulnerability, such as new patch releases or changes in the severity or impact rating.'
          type: string
          format: date-time
        impact:
          $ref: '#/components/schemas/VulnerabilityImpact'
      additionalProperties: false
  securitySchemes:
    JWT:
      type: apiKey
      in: header
      name: Authorization
      description: 'Ex: Bearer \<token\>'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            private-intel: Private Intelligence Full Access
            private-intel:read: Private Intelligence Read Access
            private-intel:write: Private Intelligence Write Access
            casebook: Casebook Full Access
            casebook:read: Casebook Read Access
            casebook:write: Casebook Write Access
          authorizationUrl: https://visibility.amp.cisco.com/iroh/oauth2/authorize
          tokenUrl: https://visibility.amp.cisco.com/iroh/oauth2/token