/v2/client

https://us-east1-org01.analytics.controld.com

GET

/v2/client

Returns the metadata for an endpoint, and/or a set of ClientIds.

The last activity data is computed based on the last observed DNS record.

For endpoints, this value is based on the latest value from any of the clients.
It is possible for the last activity date of an endpoint that is newer than any
of the visible clients. This can occur when a client was deleted, or was expired out.

For clients, it's possible to have no (null) last activity date if the underlying Analytics
data was deleted (or expired).

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🔴500InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://us-east1-org01.analytics.controld.com/v2/client?endpointId=undefined&clientId[]=undefined' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "items": {
        "property1": {
            "lastActivityTime": "2025-02-07T13:20:47.214Z",
            "clients": {
                "property1": {
                    "lastActivityTime": "2025-02-07T13:20:47.214Z",
                    "alias": "string",
                    "host": "string",
                    "mac": "string",
                    "ip": "10.10.10.11",
                    "os": {
                        "type": "linux",
                        "arch": "amd64",
                        "version": "42069"
                    },
                    "vendor": "string"
                },
                "property2": {
                    "lastActivityTime": "2025-02-07T13:20:47.214Z",
                    "alias": "string",
                    "host": "string",
                    "mac": "string",
                    "ip": "10.10.10.11",
                    "os": {
                        "type": "linux",
                        "arch": "amd64",
                        "version": "42069"
                    },
                    "vendor": "string"
                }
            }
        },
        "property2": {
            "lastActivityTime": "2025-02-07T13:20:47.214Z",
            "clients": {
                "property1": {
                    "lastActivityTime": "2025-02-07T13:20:47.214Z",
                    "alias": "string",
                    "host": "string",
                    "mac": "string",
                    "ip": "10.10.10.11",
                    "os": {
                        "type": "linux",
                        "arch": "amd64",
                        "version": "42069"
                    },
                    "vendor": "string"
                },
                "property2": {
                    "lastActivityTime": "2025-02-07T13:20:47.214Z",
                    "alias": "string",
                    "host": "string",
                    "mac": "string",
                    "ip": "10.10.10.11",
                    "os": {
                        "type": "linux",
                        "arch": "amd64",
                        "version": "42069"
                    },
                    "vendor": "string"
                }
            }
        }
    }
}

Modified at 2026-03-31 19:19:32

/v2/admin-action

/v2/client