Admin Control Panel v2.0

✎ Editing: vulnerabilities.yaml ← Back

vulnerabilities file list:
  return_type: VulnerabilitiesListAgentResponse
  help: Show the list of vulnerabilities files
  type: dict
  cli:
    users:
      - root
  schema:
    since:
      type: integer
      coerce: int
      default: 0
      help: Show files found after this unix timestamp.
    to:
      type: integer
      coerce: int
      default_setter: now
      help: Show files found before this unix timestamp.
    limit:
      type: integer
      coerce: int
      default: 50
      help: Page size
    offset:
      type: integer
      coerce: int
      default: 0
      help: Page offset
    search:
      type: string
      nullable: true
      help: |
        Search by file path and owner username.
    by_scan_id:
      type: string
      nullable: true
      help: |
        Search by scan id.
        Can be obtained via `malware on-demand list` or `malware on-demand list-user`.
    user:
      type: string
      nullable: true
      help: |
        Admins can filter results by user.
        Users can only see their own files.
    by_status:
      type: list
      schema:
        type: string
      nullable: true
      help: |
        Filter by status.
        Possible values: `vulnerable`, `patched`, `vulnerable_patch_reverted`.
    ids:
      type: list
      schema:
        type: integer
        coerce: int
      nullable: true
      help: |
        List specific files by ID.
        IDs be obtained via `vulnerabilities file list`.
        Conflicts with other filters and `order_by`.
    order_by:
      type: list
      schema:
        type: order_by
        coerce: order_by
      nullable: true
      help: |
        List of fields to order by, each followed by a `+` (ascending) or `-` (descending).
        E.g. `["status+","scanid.started-"]` would order by `status` ascending and `scanid.started` descending.

vulnerabilities file patch:
  return_type: NullAgentResponse
  help: Patch vulnerable files
  type: dict
  cli:
    users:
      - root
  schema:
    paths:
      type: list
      schema:
        type: string
        is_absolute_path: true
      required: true
      positional: true
      help: Paths to apply a patch
    user:
      type: string
      nullable: true
      help: (internal)

vulnerabilities file revert:
  return_type: SucceededFailedAgentResponse
  help: Restore the original copy that was created before a patch attempt
  type: dict
  cli:
    users:
      - root
  schema:
    paths:
      type: list
      schema:
        type: string
        is_absolute_path: true
      required: true
      positional: true
      help: Paths to revert patches
    user:
      type: string
      nullable: true
      help: (internal)

vulnerabilities user list:
  help: Show the list of users with summary vulnerabilities info
  type: dict
  cli:
    users:
      - root
  schema:
    search:
      type: string
      nullable: true
      help: Search by user name.
    limit:
      type: integer
      coerce: int
      default: 100
      help: Page size
    offset:
      type: integer
      coerce: int
      default: 0
      help: Page offset
    user:
      type: string
      nullable: true

Cancel