Skip to main content
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,
  "userId": "<string>",
  "showUnmanagedEndpoints": true,
  "operatingSystemCategories": [
    "Windows"
  ],
  "onlyLive": true,
  "integrationIds": [
    "<string>"
  ],
  "groupIds": [
    "<string>"
  ],
  "groupFilterOperator": "and",
  "searchAttributeKey": "<string>"
}
'
{
  "data": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "teamId": "<string>",
      "hva": true,
      "createdAt": "<string>",
      "integrationId": {},
      "contained": true,
      "workstation": true,
      "server": true,
      "mobile": true,
      "domainController": true,
      "groups": [
        {
          "id": "<string>",
          "endpointId": "<string>",
          "group": "<string>",
          "teamId": "<string>",
          "enabled": true,
          "createdAt": "<string>",
          "overriddenByUser": true,
          "groupId": "<string>",
          "overriddenByUserId": "<string>",
          "overriddenByUserIdentifier": "<string>",
          "groupName": "<string>",
          "groupSlug": "<string>",
          "groupContainmentEnabled": true,
          "groupChatOpsEnabled": true,
          "groupSourceSystemUpdates": true,
          "groupRuleSearch": "<string>",
          "groupRuleSearchField": "<string>"
        }
      ],
      "groupContainmentEnabled": true,
      "groupChatOpsEnabled": true,
      "groupSourceSystemUpdates": true,
      "groupsSynced": true,
      "integrationPlatform": "<string>",
      "edrSourceId": "<string>",
      "mdmSourceId": "<string>",
      "name": "<string>",
      "hvaOverriddenByUser": true,
      "privateIpAddress": "<string>",
      "live": true,
      "operatingSystem": "<string>",
      "operatingSystemCategory": "Windows",
      "managed": true,
      "publicIpAddress": "<string>",
      "lastSeenAt": "<string>",
      "updatedAt": "<string>",
      "raw": {},
      "teamName": {}
    }
  ],
  "totalCount": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.wirespeed.co/llms.txt

Use this file to discover all available pages before exploring further.

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 Critical Asset automation by

Available options:
name,
OS,
ip,
edr_id,
mdm_id,
integration_source_id,
custom_attribute
​
search
string
​
orderBy
string
​
orderDir
enum<string>
Available options:
asc,
desc
​
hvaOnly
boolean

Only return Critical Assets

​
onlyContained
boolean

Only return currently contained endpoints

​
userId
string

Filter by specific user ID

​
showUnmanagedEndpoints
boolean

Include unmanaged endpoints in results

​
operatingSystemCategories
enum<string>[]

Filter by OS categories (supports multiple)

Available options:
Windows,
Windows Server,
macOS,
Linux,
iOS,
Android,
ChromeOS,
Network Device,
Other
​
onlyLive
boolean

Only return live/online endpoints

​
integrationIds
string[]

Filter by integration IDs (supports multiple)

​
groupIds
string[]

Filter by group IDs (supports multiple)

​
groupFilterOperator
enum<string>

Operator for combining multiple group filters. "and" = must be in ALL groups, "or" = must be in ANY group. Defaults to "or".

Available options:
and,
or
​
searchAttributeKey
string

Custom attribute key to match when filter is custom_attribute (dot-separated path e.g. "labels")

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