Skip to main content
GET
/
api
/
search
Global Search
curl --request GET \
  --url https://api.example.com/api/search \
  --header 'Authorization: Bearer <token>'
{
  "query": "<string>",
  "took_ms": 123,
  "datasets": [
    {
      "id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "type": "<string>",
      "status": "<string>",
      "severity": "<string>",
      "vulnerabilities": 123
    }
  ],
  "projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "scans": [
    {
      "id": "<string>",
      "scan_type": "<string>",
      "status": "<string>",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "dataset_dir": "<string>",
      "created_at": "<string>"
    }
  ],
  "results": [
    {
      "id": "<string>",
      "scan_id": "<string>",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "filepath": "<string>",
      "vulnerability_type": "<string>",
      "severity": "<string>"
    }
  ],
  "users": [
    {
      "id": 123,
      "email": "<string>",
      "name": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Query Parameters

q
string
default:""

Search query

limit
integer
default:10

Max results per type

Required range: 1 <= x <= 50
type[]
enum<string>[] | null
Available options:
dataset,
project,
scan,
result,
user
include_results
boolean
default:false

Include scan results in the search

Cookies

antidote_session
string | null

Response

Successful Response

query
string
required
took_ms
integer
required
datasets
SearchDatasetItem · object[]
projects
SearchProjectItem · object[]
scans
SearchScanItem · object[]
results
SearchResultItem · object[]
users
SearchUserItem · object[]