Note: <psc-hostname>
is the parent URL for your PSC instance.
This endpoint does a simple health check.
GET <psc-hostname>/threathunter/feedsearch/v1/health_check
Code | Description | Content Type | Content |
---|---|---|---|
200 | OK | : | None |
This endpoint provides free form search capability for feed reports.
GET <psc-hostname>/threathunter/feedsearch/v1/orgs/{org_key}/search
Parameter | Required | Default | Description |
---|---|---|---|
query | Yes | N/A | Query to run (syntax) |
start | No | 0 | Offset of first record |
rows | No | 10 | Number of records to retrieve |
sort | No | N/A | Comma separated list of sort fields with optional asc/desc after each |
facet.field | No | N/A | Comma separated list of fields to compute facets for |
This is an example response for a successful /search
request.
{
"facets": {},
"hits": {
"total" : 1,
"hits": [
{
"_id": "someid",
"_source": {
"access": "public",
"description": "Report description.",
"feed": {
"feed_category": "Partner",
"feed_id": "somefeedid",
"feed_name": "Carbon Black Feed",
"feed_provider_url": "https://somefeedlink.com",
"feed_summary": "This is a feed summary."
},
"iocs": [
{
"field": "netconn_domain",
"id": "someiocid",
"match_type": "equality",
"link": "https://someioclink.com",
"values": [
"something.com",
"something.else.com"
]
}
],
"link": "https://somereportlink.com",
"severity": 4,
"telemetry": {
"global_hit_rate_1d": 0.1,
"global_hit_rate_1w": 0.2
},
"timestamp": 1541217832,
"title": "This is the report title."
}
}
]
}
}
This endpoint returns field name suggestions based on a partial field substring with more likely field names weighted higher.
GET <psc-hostname>/threathunter/feedsearch/v1/orgs/{org_key}/suggest?suggest.query=test
Parameter | Required | Default | Description |
---|---|---|---|
suggest.query | Yes | N/A | A substring of any field name |
suggest.count | No | N/A | The max number of suggestions to return |
This is an example response for a successful /suggest
request.
{
"suggest": [
{ "term": "severity", "weight": 97 },
{ "term": "feed_provider_url", "weight": 89 }
]
}