/v2/client

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

DELETE

/v2/client

Deletes the client's metadata (host/mac/ip/os) without deleting the client's queries or last activity time.

The client will no longer appear in calls to GET /v2/client.

Queries associated with this client remain and will still appear when viewing all queries for the account or endpoint.

The client's last activity data will continue to be used to compute the lastActivityTime of the endpoint.

If the same client becomes active again, it will be re-created with the same deterministic ClientId, and old queries will re-associate with it.

To also delete associated query data and last activity, use DELETE /v2/activity-log.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json

Examples

Responses

🟢200

application/json

Body

🟠400BadRequest

🟠401Unauthorized

🔴500InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://us-east1-org01.analytics.controld.com/v2/client' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "endpointIds": [
        "endpoint1",
        "endpoint2"
    ],
    "clientIds": [
        "client1",
        "client2"
    ],
    "endTime": "2025-02-07T13:20:47.214Z"
}'

Response Example

200 - Example 1

{
    "deletedCount": 0,
    "deletedClients": [
        {
            "endpointId": "string",
            "clientId": "string"
        }
    ]
}

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

/v2/client

/v2/client/alias/{endpointId}/{clientId}