POST
/
endpoint
Search endpoints
curl --request POST \
  --url https://api.wirespeed.co/endpoint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "size": 123,
  "page": 123,
  "filter": "name",
  "search": "<string>",
  "orderBy": "<string>",
  "orderDir": "asc",
  "hvaOnly": true,
  "onlyContained": true,
  "ipId": "<string>",
  "userId": "<string>",
  "showUnmanagedEndpoints": true
}'
{
  "data": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "teamId": "<string>",
      "edrSourceId": "<string>",
      "mdmSourceId": "<string>",
      "name": "<string>",
      "hva": true,
      "hvaOverriddenByUser": true,
      "createdAt": "<string>",
      "privateIpAddress": "<string>",
      "live": true,
      "operatingSystem": "<string>",
      "integrationId": {},
      "contained": true,
      "managed": true,
      "publicIPs": [
        {
          "ipv4": "<string>",
          "ipv6": "<string>",
          "metadata": {
            "ip": "<string>",
            "hostname": "<string>",
            "city": "<string>",
            "region": "<string>",
            "country": "<string>",
            "loc": "<string>",
            "postal": "<string>",
            "timezone": "<string>",
            "org": "<string>",
            "asn": {
              "asn": "<string>",
              "name": "<string>",
              "domain": "<string>",
              "route": "<string>",
              "type": "<string>"
            },
            "company": {
              "name": "<string>",
              "domain": "<string>",
              "type": "<string>"
            },
            "privacy": {
              "vpn": true,
              "proxy": true,
              "tor": true,
              "relay": true,
              "hosting": true,
              "service": "<string>"
            },
            "abuse": {
              "address": "<string>",
              "country": "<string>",
              "email": "<string>",
              "name": "<string>",
              "network": "<string>",
              "phone": "<string>",
              "ofac": true,
              "adversarial": true
            },
            "domains": {
              "ip": "<string>",
              "total": 123,
              "domains": [
                "<string>"
              ]
            },
            "ofac": true,
            "adversarial": true
          },
          "displayName": "<string>",
          "id": "<string>",
          "teamId": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "locationId": "<string>",
          "metadataLastFetchedAt": "<string>",
          "known": true,
          "safe": true,
          "detectionSid": "<string>"
        }
      ],
      "workstation": true,
      "server": true,
      "mobile": true,
      "updatedAt": "<string>",
      "raw": {},
      "integrationPlatform": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

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

Body

application/json
size
number
page
number
filter
enum<string>

Field to filter HVA automation by

Available options:
name,
ip
orderBy
string
orderDir
enum<string>
Available options:
asc,
desc
hvaOnly
boolean

Only return High Value Assets

onlyContained
boolean

Only return currently contained endpoints

ipId
string

Filter by specific IP address ID

userId
string

Filter by specific user ID

showUnmanagedEndpoints
boolean

Include unmanaged endpoints in results

Response

Paginated list of endpoints matching search criteria

data
object[]
required

Array of endpoint search results

totalCount
number
required

Total number of endpoints matching the search criteria