Entity Details
This API endpoint provides detailed information about a specific threat intelligence entity, including its attributes, metadata, geolocations, and latest associations.
Endpoint: https://intelligence.threatwinds.com/api/analytics/v1/entity/{id}/details
Parameters
Headers
Header | Type | Required | Description |
---|---|---|---|
Authorization | string | Optional* | Bearer token obtained from an active session |
api-key | string | Optional* | Your API key |
api-secret | string | Optional* | Your API secret |
Note: The
user-id
andgroups
headers are added automatically by the API gateway when required and shouldn’t be provided by the client.
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | string | Yes | The unique identifier of the entity you want to retrieve details for |
Note: You must use either the Authorization header OR the API key and secret combination.
Request
To get details for a specific entity, use a GET request, for example:
curl -X 'GET' \
'https://intelligence.threatwinds.com/api/analytics/v1/entity/ip-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2/details' \
-H 'accept: application/json' \
-H 'Authorization: Bearer fq6JoEFTsxiXAl1cVdPDnK4emIQCwaUBfq9JoEFTsxhXAl1cVxPDnK4emIQCwaUB'
Or using API key and secret:
curl -X 'GET' \
'https://intelligence.threatwinds.com/api/analytics/v1/entity/ip-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2/details' \
-H 'accept: application/json' \
-H 'api-key: your-api-key' \
-H 'api-secret: your-api-secret'
Response
A successful response returns a JSON object containing detailed information about the entity, including:
Field | Description |
---|---|
attributes | Core attributes of the entity (type, value, reputation, accuracy, etc.). Note that the value field only contains strings, numbers, or booleans, never maps, arrays, or other complex structures |
metadata | Additional metadata associated with the entity |
geolocations | Geolocation information if applicable (for IP addresses, domains, etc.) |
latest_associations | Recent entities associated with this entity |
extended_metadata | Additional detailed metadata |
Example response:
{
"attributes": {
"id": "ip-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
"type": "ip",
"value": "8.8.8.8",
"label": "Google Public DNS",
"description": "Google's public DNS server",
"reputation": "benign",
"reputation_score": 3,
"best_reputation": "benign",
"best_reputation_score": 3,
"worst_reputation": "benign",
"worst_reputation_score": 3,
"accuracy": "high",
"accuracy_score": 3,
"first_seen": "2021-01-01T00:00:00Z",
"last_seen": "2023-06-15T14:30:00Z",
"tags": ["dns", "google", "public"]
},
"metadata": {
"asn": 15169,
"aso": "Google LLC",
"country": "United States"
},
"geolocations": [
{
"city": "Mountain View",
"country": "United States",
"latitude": 37.4056,
"longitude": -122.0775,
"accuracy_radius": 1000,
"asn": 15169,
"aso": "Google LLC",
"object": "8.8.8.0/24"
}
],
"latest_associations": [
{
"id": "domain-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
"type": "domain",
"value": "dns.google",
"reputation": "benign",
"reputation_score": 3,
"accuracy": "high",
"accuracy_score": 3,
"first_seen": "2021-02-15T00:00:00Z",
"last_seen": "2023-06-10T12:00:00Z"
}
],
"extended_metadata": [
{
"id": "registrar-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
"type": "registrar",
"value": "Google LLC",
"reputation": "benign",
"reputation_score": 3,
"accuracy": "high",
"accuracy_score": 3,
"first_seen": "2021-02-15T00:00:00Z",
"last_seen": "2023-06-10T12:00:00Z"
}
]
}
Error Response Headers
For responses with status codes other than 200 and 202, the following headers are included:
Header | Description |
---|---|
x-error | Contains a description of the error that occurred |
x-error-id | Contains a unique identifier for the error for support |
Error Codes
Status Code | Description | Possible Cause |
---|---|---|
204 | No Content | Entity not found |
400 | Bad Request | Invalid request parameters or malformed JSON |
401 | Unauthorized | Missing or invalid authentication credentials |
403 | Forbidden | Authenticated user lacks permission for this operation |
500 | Internal Server Error | Server-side error; please contact support if persistent |