search

avidml / avidtools

Developer tools for AVID
Apache License 2.0
6 stars 1 forks source link

How to search the database? #8

Open emigre459 opened 2 months ago

emigre459 commented 2 months ago

I apologize for what is almost certainly going to be read as a dumb question, but we have a use case in which we want to be able to search AVID vulnerability entries via free text search to find vulnerabilities that are most similar to what we are seeing in our system. The goal is to associate one or more vulnerabilities (and thus hopefully also mitigations the community has identified - are these tracked in AVID?) to the system events we're seeing that the vulnerabilities map to. However, I can't figure out how to get a list of all the current AVID vulnerabilities tracked let alone do this kind of free text search.

So my question is ultimately three-fold:

  1. What is the basic pattern to get a listing of vulnerabilities (e.g. a RESTful endpoint I could ping with python requests)?
  2. Do vulnerabilities track mitigations as well?
  3. Is there a way to do free text search or some other search functionality of vulnerabilities in the database without knowing their ID in advance?
  4. Bonus question: is there a way to see the dates/datetimes when a vulnerability was first submitted/started being tracked by AVID?

Thanks for any help you can provide! I'd be happy to submit a PR to the docs after I square all of this away.

emigre459 commented 2 months ago

Also, I did see the API Tutorial notebook (and frankly it seems like it answers a lot of my questions), but it makes reference to an AVID API endpoint URL and API key, but I don't know how to request those.