> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Vulnerability by ID

> Retrieve a vulnerability by its ID (Leen's UUID)



## OpenAPI

````yaml get /vms/vulnerabilities/{vuln_id}
openapi: 3.1.0
info:
  title: Leen Security API
  version: 0.0.1
servers:
  - description: Production API (US)
    url: https://api.leen.dev/v1
  - description: Production API (EU)
    url: https://api.eu-c1.leen.dev/v1
  - description: Production API (APAC)
    url: https://api.ap-se2.leen.dev/v1
security: []
paths:
  /vms/vulnerabilities/{vuln_id}:
    get:
      tags:
        - vms
      summary: Get Vulnerability by ID
      description: Retrieve a vulnerability by its ID (Leen's UUID)
      operationId: get_vulnerability_by_id
      parameters:
        - in: path
          name: vuln_id
          required: true
          schema:
            format: uuid
            title: Vuln Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VulnerabilityRespModel'
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorException'
          description: Vulnerability not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - API-Key: []
          Connection-ID: []
components:
  schemas:
    VulnerabilityRespModel:
      properties:
        category:
          anyOf:
            - $ref: '#/components/schemas/VulnerabilityCategory'
            - type: 'null'
          description: Vulnerability category
        cert_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Corresponds to an identifier in the vulnerability database provided
            by the US Computer Emergency Readiness Team (US-CERT)
          title: Cert Id
        cve:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: List of CVEs associated with the vulnerability
          title: Cve
        cvss_base_score:
          anyOf:
            - type: number
            - type: 'null'
          description: CVSS base score
          title: Cvss Base Score
        cvss_temporal_score:
          anyOf:
            - type: number
            - type: 'null'
          description: CVSS temporal score
          title: Cvss Temporal Score
        cvss_temporal_vector:
          anyOf:
            - type: string
            - type: 'null'
          description: CVSS temporal vector
          title: Cvss Temporal Vector
        cvss_vector:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            CVSS vector uses cvss3 when available, provided by the upstream
            vendor
          title: Cvss Vector
        cvss_version:
          anyOf:
            - type: string
            - type: 'null'
          description: CVSS version
          title: Cvss Version
        description:
          description: Description of vulnerability, provided by the upstream vendor
          title: Description
          type: string
        device:
          anyOf:
            - $ref: '#/components/schemas/DeviceRespModel'
            - $ref: '#/components/schemas/DeviceWithGroupsRespModel'
            - type: 'null'
          description: >-
            Device attached to the vulnerability, include device groups with
            includeDeviceGroups query parameter
          title: Device
        exploitable:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether the vendor asserts this vulnerability is exploitable. `null`
            means the vendor provided no signal, which is not the same as
            `false`.
          title: Exploitable
        first_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: First detection date
          title: First Seen
        id:
          description: Leen's UUID for the vulnerability
          format: uuid
          title: Id
          type: string
        last_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: Last detection date
          title: Last Seen
        name:
          description: Name of vulnerability, provided by the upstream vendor
          title: Name
          type: string
        patchable:
          anyOf:
            - type: boolean
            - type: 'null'
          description: A patch is available
          title: Patchable
        port:
          anyOf:
            - type: integer
            - type: 'null'
          description: Port number of the vulnerability that was detected
          title: Port
        protocol:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Protocol of the vulnerability that was detected, example: tcp'
          title: Protocol
        reachability:
          anyOf:
            - $ref: '#/components/schemas/VulnerabilityReachability'
            - type: 'null'
          description: >-
            Whether the vulnerable code is actually reached in the scanned
            target. One of `reachable`, `potentially_reachable`, `unreachable`,
            `unknown`. `null` means the vendor performs no reachability
            analysis; `unknown` means it ran but reached no conclusion.
        resource:
          anyOf:
            - $ref: '#/components/schemas/ResourceRespModel'
            - type: 'null'
          description: Resource attached to the vulnerability
        scan_output:
          anyOf:
            - type: string
            - type: 'null'
          description: Scan output that was provided when detected on the device
          title: Scan Output
        service:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Service of the vulnerability that was detected, example: http'
          title: Service
        severity:
          $ref: '#/components/schemas/VulnerabilitySeverity'
          default: none
        solution:
          anyOf:
            - type: string
            - type: 'null'
          description: Solution for the vulnerability, provided by upstream vendor
          title: Solution
        state:
          $ref: '#/components/schemas/VulnerabilityState'
          default: open
        state_updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The last time the state was updated
          title: State Updated At
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The last time the vulnerability was updated
          title: Updated At
        vendor:
          $ref: '#/components/schemas/VulnerabilityVendor'
          description: Source vendor
        vendor_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Vendor specific pass through data, values can vary based on vendor
          title: Vendor Data
        vendor_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Vendor's ID of the vulnerability
          title: Vendor Id
        vendor_scan_id:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Vendor''s ID of the scan that detected the '
          title: Vendor Scan Id
        vendor_severity:
          anyOf:
            - type: string
            - type: 'null'
          description: Passthrough value of severity
          title: Vendor Severity
        vulnerability_url:
          anyOf:
            - type: string
            - type: 'null'
          description: URL to the vulnerability details, provided by the upstream vendor
          title: Vulnerability Url
      required:
        - id
        - name
        - description
        - scan_output
        - cve
        - cvss_version
        - cvss_base_score
        - cvss_vector
        - cvss_temporal_score
        - cvss_temporal_vector
        - cert_id
        - port
        - protocol
        - service
        - first_seen
        - last_seen
        - updated_at
        - state_updated_at
        - patchable
        - solution
        - category
        - vendor
        - vendor_id
        - vendor_severity
        - vendor_scan_id
      title: Vulnerability
      type: object
    ErrorException:
      properties:
        detail:
          description: Error message
          title: Detail
          type: string
      required:
        - detail
      title: ErrorException
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    VulnerabilityCategory:
      enum:
        - web
        - network
        - database
        - application
        - os
        - other
        - general
        - attack_vector
      title: VulnerabilityCategory
      type: string
    DeviceRespModel:
      properties:
        ad_info:
          anyOf:
            - $ref: '#/components/schemas/DeviceADInfo'
            - type: 'null'
          description: >-
            Active Directory placement -- organisational unit and site -- where
            the tool reports it.
        cloud_metadata:
          anyOf:
            - $ref: '#/components/schemas/AWSMetadata'
            - type: 'null'
          description: CloudMetadata, currently only AWS is supported
        first_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the tool first registered this device. The tool's own
            timestamp, not when Leen synced it.
          title: First Seen
        fqdns:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Fully qualified domain names for this device.
          title: Fqdns
        hostnames:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Hostnames the tool knows this device by. A device can have several.
          title: Hostnames
        id:
          description: Leen's identifier for this device.
          format: uuid
          title: Id
          type: string
        identities:
          anyOf:
            - items:
                $ref: '#/components/schemas/DeviceIdentity'
              type: array
            - type: 'null'
          description: >-
            Accounts associated with the device, such as its last logged-in
            user.
          title: Identities
        installed_software:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Software the tool reported as installed.
          title: Installed Software
        ipv4s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv4 addresses the tool last observed. Not necessarily current.
          title: Ipv4S
        ipv6s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv6 addresses the tool last observed.
          title: Ipv6S
        last_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the tool last had contact with the device. Use it to tell a
            decommissioned machine from one that simply has no findings.
          title: Last Seen
        mac_addresses:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: MAC addresses of the device's interfaces.
          title: Mac Addresses
        os_major_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Major version, split out of `os_version` so it can be filtered on.
          title: Os Major Version
        os_minor_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Minor version, split out of `os_version`.
          title: Os Minor Version
        os_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Full operating system version string, as the tool reports it.
          title: Os Version
        platform:
          anyOf:
            - $ref: '#/components/schemas/DevicePlatform'
            - type: 'null'
          description: Operating system family, normalised across tools.
        source_vendors:
          description: >-
            The tool this device came from, and that tool's identifier for it. A
            list because the shape allows several; today a device carries
            exactly one.
          items:
            $ref: '#/components/schemas/DeviceVendor'
          title: Source Vendors
          type: array
        status:
          $ref: '#/components/schemas/DeviceStatus'
          description: >-
            Device state as the tool reports it. `quarantined` means the tool
            has isolated it; `deleted` means the tool no longer returns it.
        tags:
          anyOf:
            - items:
                $ref: '#/components/schemas/DeviceTags'
              type: array
            - type: 'null'
          description: Tags the tool carries for this device.
          title: Tags
        vendor_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Vendor specific pass through data, values can vary based on vendor
          title: Vendor Data
      required:
        - id
        - status
        - last_seen
        - first_seen
        - source_vendors
        - installed_software
        - ad_info
      title: Device
      type: object
    DeviceWithGroupsRespModel:
      properties:
        ad_info:
          anyOf:
            - $ref: '#/components/schemas/DeviceADInfo'
            - type: 'null'
          description: >-
            Active Directory placement -- organisational unit and site -- where
            the tool reports it.
        cloud_metadata:
          anyOf:
            - $ref: '#/components/schemas/AWSMetadata'
            - type: 'null'
          description: CloudMetadata, currently only AWS is supported
        device_groups:
          default: []
          description: >-
            Pass in the includeDeviceGroups query parameter to include device
            group information.
          items:
            $ref: '#/components/schemas/DeviceGroupsBase'
          title: Device Groups
          type: array
        first_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the tool first registered this device. The tool's own
            timestamp, not when Leen synced it.
          title: First Seen
        fqdns:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Fully qualified domain names for this device.
          title: Fqdns
        hostnames:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Hostnames the tool knows this device by. A device can have several.
          title: Hostnames
        id:
          description: Leen's identifier for this device.
          format: uuid
          title: Id
          type: string
        identities:
          anyOf:
            - items:
                $ref: '#/components/schemas/DeviceIdentity'
              type: array
            - type: 'null'
          description: >-
            Accounts associated with the device, such as its last logged-in
            user.
          title: Identities
        installed_software:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Software the tool reported as installed.
          title: Installed Software
        ipv4s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv4 addresses the tool last observed. Not necessarily current.
          title: Ipv4S
        ipv6s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv6 addresses the tool last observed.
          title: Ipv6S
        last_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the tool last had contact with the device. Use it to tell a
            decommissioned machine from one that simply has no findings.
          title: Last Seen
        mac_addresses:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: MAC addresses of the device's interfaces.
          title: Mac Addresses
        os_major_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Major version, split out of `os_version` so it can be filtered on.
          title: Os Major Version
        os_minor_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Minor version, split out of `os_version`.
          title: Os Minor Version
        os_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Full operating system version string, as the tool reports it.
          title: Os Version
        platform:
          anyOf:
            - $ref: '#/components/schemas/DevicePlatform'
            - type: 'null'
          description: Operating system family, normalised across tools.
        source_vendors:
          description: >-
            The tool this device came from, and that tool's identifier for it. A
            list because the shape allows several; today a device carries
            exactly one.
          items:
            $ref: '#/components/schemas/DeviceVendor'
          title: Source Vendors
          type: array
        status:
          $ref: '#/components/schemas/DeviceStatus'
          description: >-
            Device state as the tool reports it. `quarantined` means the tool
            has isolated it; `deleted` means the tool no longer returns it.
        tags:
          anyOf:
            - items:
                $ref: '#/components/schemas/DeviceTags'
              type: array
            - type: 'null'
          description: Tags the tool carries for this device.
          title: Tags
        vendor_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Vendor specific pass through data, values can vary based on vendor
          title: Vendor Data
      required:
        - id
        - status
        - last_seen
        - first_seen
        - source_vendors
        - installed_software
        - ad_info
      title: DeviceWithGroups
      type: object
    VulnerabilityReachability:
      description: >-
        Reachability as this API surface renders it.


        Lowercase values, like every other enum in this module: the VMS v1
        response

        has always emitted `"state": "open"` / `"severity": "high"`, and a
        single

        uppercase field would be an odd one out for clients parsing it. The
        stored

        vocabulary is uppercase, so both read paths convert by member name.


        Filters stay case-insensitive --
        `VulnerabilityFilters.uppercase_reachability`

        normalizes before validating -- so `?reachability=reachable` and

        `?reachability=REACHABLE` both work.
      enum:
        - reachable
        - potentially_reachable
        - unreachable
        - unknown
      title: VulnerabilityReachability
      type: string
    ResourceRespModel:
      description: Response model for returning resource details via an API endpoint.
      properties:
        cloud_metadata:
          anyOf:
            - $ref: '#/components/schemas/ResourceCloudMetadata'
            - type: 'null'
          description: Cloud metadata for the resource
        data:
          anyOf:
            - $ref: '#/components/schemas/ResourceContainer'
            - $ref: '#/components/schemas/ResourceHost'
            - $ref: '#/components/schemas/ResourceImage'
            - $ref: '#/components/schemas/ResourceBranch'
            - type: 'null'
          description: Additional data or properties about the resource
          title: Data
        first_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: Timestamp when the resource was first seen
          title: First Seen
        groups:
          anyOf:
            - items:
                $ref: '#/components/schemas/ResourceGroup'
              type: array
            - type: 'null'
          description: Groups associated with the resource
          title: Groups
        id:
          description: Leen's UUID for the resource
          format: uuid
          title: Id
          type: string
        last_seen:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: Timestamp when the resource was last seen
          title: Last Seen
        name:
          description: Resource name
          title: Name
          type: string
        state:
          $ref: '#/components/schemas/ResourceStateEnum'
          description: State of the resource
        tags:
          anyOf:
            - items:
                $ref: '#/components/schemas/ResourceTag'
              type: array
            - type: 'null'
          description: List of arbitrary tags/metadata for the resource
          title: Tags
        type:
          $ref: '#/components/schemas/ResourceTypeEnum'
          description: Type of the resource
        url:
          anyOf:
            - type: string
            - type: 'null'
          description: URL associated with the resource
          title: Url
        vendor:
          description: The source vendor of the resource
          title: Vendor
          type: string
        vendor_attributes:
          $ref: '#/components/schemas/ResourceVendorAttributes'
          description: Vendor-specific attributes like IDs
      required:
        - id
        - name
        - type
        - state
        - vendor
        - vendor_attributes
      title: Resource
      type: object
    VulnerabilitySeverity:
      enum:
        - critical
        - high
        - medium
        - low
        - info
        - none
      title: VulnerabilitySeverity
      type: string
    VulnerabilityState:
      enum:
        - open
        - closed
        - reopened
        - ignored
        - deleted
      title: VulnerabilityState
      type: string
    VulnerabilityVendor:
      enum:
        - tenable
        - qualys
        - snyk
        - insightvm
        - crowdstrike_spotlight
        - sentinelone_vms
        - MS_DEFENDER_VMS
        - WIZ_VMS
        - AWS_INSPECTOR2
      title: VulnerabilityVendor
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    DeviceADInfo:
      properties:
        device_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Device Id
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        org_unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Org Unit
        site_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Site Name
      title: DeviceADInfo
      type: object
    AWSMetadata:
      properties:
        account_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Id
        availability_zone:
          anyOf:
            - type: string
            - type: 'null'
          title: Availability Zone
        cloud_provider:
          $ref: '#/components/schemas/CloudProvider'
          default: aws
        image_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Id
        instance_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Id
        instance_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance Type
        kernel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Kernel Id
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
        subnet_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Subnet Id
        vpc_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Vpc Id
      title: AWSMetadata
      type: object
    DeviceIdentity:
      properties:
        user_sid:
          anyOf:
            - type: string
            - type: 'null'
          title: User Sid
        username:
          title: Username
          type: string
      required:
        - username
      title: DeviceIdentity
      type: object
    DevicePlatform:
      enum:
        - mac
        - windows
        - linux
        - unknown
      title: DevicePlatform
      type: string
    DeviceVendor:
      properties:
        agent_info:
          anyOf:
            - $ref: '#/components/schemas/DeviceAgentInfo'
            - type: 'null'
        vendor:
          title: Vendor
          type: string
        vendor_id:
          title: Vendor Id
          type: string
      required:
        - vendor
        - vendor_id
      title: DeviceVendor
      type: object
    DeviceStatus:
      enum:
        - active
        - offline
        - quarantined
        - unknown
        - deleted
      title: DeviceStatus
      type: string
    DeviceTags:
      properties:
        key:
          title: Key
          type: string
        source:
          $ref: '#/components/schemas/DeviceTagSource'
        value:
          title: Value
          type: string
      required:
        - key
        - value
        - source
      title: DeviceTags
      type: object
    DeviceGroupsBase:
      properties:
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          description: Who created the group in the tool.
          title: Created By
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Group description, where the tool has one.
          title: Description
        id:
          description: Leen's identifier for this group.
          format: uuid
          title: Id
          type: string
        name:
          description: Group name, as the tool names it.
          title: Name
          type: string
        vendor:
          description: Connector that produced this group.
          title: Vendor
          type: string
        vendor_created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the group was created in the tool, where the tool reports it.
          title: Vendor Created At
        vendor_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Vendor specific pass through data, values can vary based on vendor
          title: Vendor Data
        vendor_id:
          description: The tool's own identifier for the group.
          title: Vendor Id
          type: string
      required:
        - id
        - name
        - vendor_id
        - vendor
      title: DeviceGroupsBase
      type: object
    ResourceCloudMetadata:
      description: ORM model representing cloud metadata in a resource.
      properties:
        account_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud account identifier
          title: Account Id
        account_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud account name
          title: Account Name
        cloud_provider:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud service provider
          title: Cloud Provider
        image_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud image identifier
          title: Image Id
        instance_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud instance identifier
          title: Instance Id
        instance_type:
          anyOf:
            - type: string
            - type: 'null'
          description: Type of cloud instance
          title: Instance Type
        region:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud region
          title: Region
        subnet_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud subnet identifier
          title: Subnet Id
        vpc_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Cloud VPC identifier
          title: Vpc Id
      title: ResourceCloudMetadata
      type: object
    ResourceContainer:
      description: ORM model representing a container in a resource.
      properties:
        hostnames:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: List of hostnames for the container
          title: Hostnames
        image:
          anyOf:
            - type: string
            - type: 'null'
          description: Container image identifier
          title: Image
      title: ResourceContainer
      type: object
    ResourceHost:
      description: ORM model representing a host in a resource.
      properties:
        ad_device_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Active Directory device ID
          title: Ad Device Id
        ad_domain:
          anyOf:
            - type: string
            - type: 'null'
          description: Active Directory domain
          title: Ad Domain
        ad_org_unit:
          anyOf:
            - type: string
            - type: 'null'
          description: Active Directory organizational unit
          title: Ad Org Unit
        ad_site_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Active Directory site name
          title: Ad Site Name
        agents:
          anyOf:
            - items:
                $ref: '#/components/schemas/ResourceHostAgent'
              type: array
            - type: 'null'
          description: Agent information for the host
          title: Agents
        deleted_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the host was deleted
          title: Deleted At
        fqdns:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Fully qualified domain names of the host
          title: Fqdns
        hostnames:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: List of hostnames for the host
          title: Hostnames
        image:
          anyOf:
            - type: string
            - type: 'null'
          description: Host image identifier
          title: Image
        installed_software:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Installed software on the host
          title: Installed Software
        ipv4s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv4 addresses associated with the host
          title: Ipv4S
        ipv6s:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: IPv6 addresses associated with the host
          title: Ipv6S
        is_deleted:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the host is deleted
          title: Is Deleted
        mac_addresses:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: MAC addresses associated with the host
          title: Mac Addresses
        os_major_version:
          anyOf:
            - type: integer
            - type: 'null'
          description: Major version of the host's operating system
          title: Os Major Version
        os_minor_version:
          anyOf:
            - type: integer
            - type: 'null'
          description: Minor version of the host's operating system
          title: Os Minor Version
        os_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Full operating system version of the host
          title: Os Version
        platform:
          anyOf:
            - $ref: '#/components/schemas/ResourcePlatformEnum'
            - type: 'null'
          description: Platform on which the host is running
      title: ResourceHost
      type: object
    ResourceImage:
      description: ORM model representing an image in a resource.
      properties:
        hash:
          anyOf:
            - $ref: '#/components/schemas/ResourceHash'
            - type: 'null'
          description: Image hash
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Image labels
          title: Labels
      title: ResourceImage
      type: object
    ResourceBranch:
      description: ORM model representing a branch in a resource.
      properties:
        code_repo:
          anyOf:
            - type: string
            - type: 'null'
          description: Code repository name
          title: Code Repo
        repo_branch_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Repository branch name
          title: Repo Branch Name
      title: ResourceBranch
      type: object
    ResourceGroup:
      description: ORM model representing a groups in a resource.
      properties:
        name:
          description: The name of the group.
          title: Name
          type: string
        uid:
          description: The unique identifier of the group.
          title: Uid
          type: string
      required:
        - name
        - uid
      title: ResourceGroup
      type: object
    ResourceStateEnum:
      enum:
        - ACTIVE
        - IGNORED
        - DELETED
        - INACTIVE
        - QUARANTINED
        - UNKNOWN
      title: ResourceStateEnum
      type: string
    ResourceTag:
      properties:
        key:
          title: Key
          type: string
        source:
          $ref: '#/components/schemas/ResourceTagSourceEnum'
        value:
          title: Value
          type: string
      required:
        - key
        - value
        - source
      title: ResourceTag
      type: object
    ResourceTypeEnum:
      description: Enumeration for resource types.
      enum:
        - BRANCH
        - HOST
        - CONTAINER
        - DEPENDENCY
        - IMAGE
        - REPOSITORY
        - VENDOR
        - KUBERNETES
        - UNKNOWN
      title: ResourceTypeEnum
      type: string
    ResourceVendorAttributes:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/QualysDeviceVendorData'
            - $ref: '#/components/schemas/TenableDeviceVendorData'
            - $ref: '#/components/schemas/OrcaResourceVendorAttributesData'
            - $ref: '#/components/schemas/UpwindResourceVendorAttributesData'
            - $ref: '#/components/schemas/CheckmarxResourceVendorAttributesData'
            - $ref: '#/components/schemas/SocketResourceVendorAttributesData'
            - type: 'null'
          description: Vendor specific data
          title: Data
        id:
          description: Vendor specific ID
          title: Id
          type: string
      required:
        - id
      title: ResourceVendorAttributes
      type: object
    CloudProvider:
      enum:
        - aws
      title: CloudProvider
      type: string
    DeviceAgentInfo:
      properties:
        agent_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Version
        policies:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Policies
        signature_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature Version
      title: DeviceAgentInfo
      type: object
    DeviceTagSource:
      enum:
        - aws
        - qualys
        - wiz_vms
        - insight_vm
      title: DeviceTagSource
      type: string
    ResourceHostAgent:
      description: ORM model representing agent information in a resource.
      properties:
        product:
          description: Product name of the agent
          title: Product
          type: string
        signature_version:
          anyOf:
            - type: string
            - type: 'null'
          description: Signature version of the agent, usually related to EDR agents
          title: Signature Version
        vendor:
          description: Vendor of the agent
          title: Vendor
          type: string
        vendor_attributes:
          anyOf:
            - $ref: '#/components/schemas/ResourceHostAgentVendorAttributes'
            - type: 'null'
          description: Vendor-specific attributes of the agent
        version:
          anyOf:
            - type: string
            - type: 'null'
          description: Version of the agent
          title: Version
      required:
        - vendor
        - product
      title: ResourceHostAgent
      type: object
    ResourcePlatformEnum:
      description: Enumeration for resource platforms.
      enum:
        - WINDOWS
        - LINUX
        - MAC
        - UNKNOWN
      title: ResourcePlatformEnum
      type: string
    ResourceHash:
      properties:
        algorithm:
          anyOf:
            - type: string
            - type: 'null'
          title: Algorithm
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
      title: ResourceHash
      type: object
    ResourceTagSourceEnum:
      description: >-
        Which integration contributed a resource tag.


        Named rather than an inline ``Literal`` so the OpenAPI document carries
        a reusable

        ``ResourceTagSourceEnum`` component. An inline literal generates an
        anonymous,

        differently-named enum type in every SDK language.
      enum:
        - wiz_vms
        - gitlab
        - checkmarx
        - mend
        - qualys
        - aws
        - insight_vm
        - orca
        - blackkite
      title: ResourceTagSourceEnum
      type: string
    QualysDeviceVendorData:
      properties:
        asset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Id
        host_id:
          title: Host Id
          type: string
        tracking_method:
          anyOf:
            - type: string
            - type: 'null'
          title: Tracking Method
        vendor:
          const: qualys
          title: Vendor
          type: string
      required:
        - vendor
        - host_id
      title: QualysDeviceVendorData
      type: object
    TenableDeviceVendorData:
      properties:
        first_seen:
          anyOf:
            - type: string
            - type: 'null'
          title: First Seen
        is_licensed:
          title: Is Licensed
          type: boolean
        last_seen:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Seen
        operating_systems:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Operating Systems
        vendor:
          const: tenable
          default: tenable
          title: Vendor
          type: string
      required:
        - is_licensed
      title: TenableDeviceVendorData
      type: object
    OrcaResourceVendorAttributesData:
      properties:
        category:
          title: Category
          type: string
        subcategory:
          title: Subcategory
          type: string
        type:
          title: Type
          type: string
        vendor:
          const: ORCA
          default: ORCA
          title: Vendor
          type: string
      required:
        - category
        - subcategory
        - type
      title: OrcaResourceVendorAttributesData
      type: object
    UpwindResourceVendorAttributesData:
      properties:
        type:
          title: Type
          type: string
        vendor:
          const: UPWIND
          default: UPWIND
          title: Vendor
          type: string
      required:
        - type
      title: UpwindResourceVendorAttributesData
      type: object
    CheckmarxResourceVendorAttributesData:
      properties:
        repo_url_inferred:
          title: Repo Url Inferred
          type: boolean
        vendor:
          const: CHECKMARX
          default: CHECKMARX
          title: Vendor
          type: string
      required:
        - repo_url_inferred
      title: CheckmarxResourceVendorAttributesData
      type: object
    SocketResourceVendorAttributesData:
      properties:
        default_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Branch
        slug:
          title: Slug
          type: string
        vendor:
          const: SOCKET
          default: SOCKET
          title: Vendor
          type: string
        workspace:
          anyOf:
            - type: string
            - type: 'null'
          title: Workspace
      required:
        - slug
      title: SocketResourceVendorAttributesData
      type: object
    ResourceHostAgentVendorAttributes:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          description: Vendor ID of the agent
          title: Id
        policies:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Policies associated with the agent
          title: Policies
      title: ResourceHostAgentVendorAttributes
      type: object
  securitySchemes:
    API-Key:
      in: header
      name: X-API-KEY
      type: apiKey
    Connection-ID:
      in: header
      name: X-CONNECTION-ID
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.