Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

warning: in early dev, probably contact us if you want to test, provide feedback, request changes

Get an API key

...

Note

The VINCE API is still under development, but we are making this documentation available for folks who might want to try it out in the meantime. Please let us know what changes you'd like by submitting feedback through VINCE.

Table of Contents

Getting an Authentication Token

  1. Log in to the VINCE COMM UI
  2. Go to your user profile page
  3. Generate an API key
  4. Copy they API key to a safe place, you will not be able to access it again. (If lost, you need to regenerate a new one.)

Using the token

Code Block
headers={'Authorization': "Token {}".format(token)}

API Reference

List cases

Code Block
# get a list of your cases
api = 'https://[VINCE_URL]/comm/api/cases/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)

Retrieve a specific case

Code Block
# get information about VU#701852
api = 'https://[VINCE_URL]/comm/api/case/701852/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)

Retrieve posts for a case

Code Block
# get all posts for case VU#701852
api = 'https://[VINCE_URL]/comm/api/case/posts/701852/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)

Retrieve original report for a case

Code Block
# get the original report for VU#701852
api = 'https://[VINCE_URL]/comm/api/case/report/701852/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)

Retrieve vuls for a case

Code Block
# get the vuls for VU#701852
api = 'https://[VINCE_URL]/comm/api/case/vuls/701852/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)

Retrieve vendors for a case

Code Block
# get all the vendors involved in VU#701582 (also gets their status and statements)
api = 'https://[VINCE_URL]/comm/api/case/vendors/701852/'
r = requests.get(api, headers=headers, stream=True)
print(r.text)