User API

The User API allows you to get information about:

• Your license information: View name, API key, remaining credit count, expiry date;
• Your authorizations: which categories, fields & functions you can use;
• Which APIs are included in your license;
• List of scanned ports, both TCP & UDP;
• List of scanned CVEs in vulnscan category.

Using curl

You can use curl in the following way to call the User API:

curl -H 'Content-Type: application/json' -H 'Authorization: bearer YOUR_APIKEY' -XGET 'https://www.onyphe.io/api/v2/user'

Output:

{
  "count": 1,
  "error": 0,
  "max_page": 1,
  "myip": "<redacted>",
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "@category": "user",
      "@timestamp": "2021-11-20T16:59:21.000Z",
[..]
  ],
  "status": "ok",
  "text": "Success",
  "took": 0.032,
  "total": 1
}