Update Request Capture

PUT /v1/endpoints/{uuid}/settings/capture

Turn request logging on or off for one endpoint. With capture on (the default) the edge records the endpoint's requests in the traffic logs. With capture off no request details are stored for it — the Traffic Inspector, List Logs and the endpoint's cache hit rate have nothing new to show — but its traffic still counts toward your usage and plan quotas. Requests logged before you turned it off stay.

This is a full write, not a patch: capture_enabled is stored on every call and an omitted capture_enabled means false, so always send it. The endpoint's current values are capture_enabled and capture_level on Get Endpoint.

Requires the endpoints:update permission in the active account.

Path parameters

uuid string (uuid) Req
The endpoint's uuid from List Endpoints.

Request body

Strict JSON: an unknown field returns 400.

capture_enabled boolean Req
true to log the endpoint's requests, false to stop. This is the switch the edge reads. false when omitted.
capture_level string
An advisory label stored with the switch: full, metadata or off. Only capture_enabled decides whether requests are logged — except that off also sets capture_enabled to false. Omitted or empty clears the stored level.

Response (200 OK)

Empty body on success.

Errors

400 Bad Request
Invalid JSON or an unknown field (Invalid request body), or a capture_level other than full, metadata, off or empty (Invalid capture_level. Supported: full, metadata, off).
401 Unauthorized
Missing or invalid auth.
403 Forbidden
Your role lacks endpoints:update, you are not a member of the active account, or the account is suspended (account_suspended).
404 Not Found
Endpoint not found — the endpoint belongs to another account.
409 Conflict
quota_paused: the endpoint is paused over your plan's limits and is read-only.
415 Unsupported Media Type
The request has no Content-Type: application/json header.
Request — stop logging requests
curl -X PUT "https://api.ngris.com/v1/endpoints/019ba0a5-abcc-7a95-af8e-2f8559f823cd/settings/capture" \ -H "X-API-KEY: <your_api_key>" \ -H "Content-Type: application/json" \ -d '{"capture_enabled": false, "capture_level": "off"}'
Request — log requests again
curl -X PUT "https://api.ngris.com/v1/endpoints/019ba0a5-abcc-7a95-af8e-2f8559f823cd/settings/capture" \ -H "X-API-KEY: <your_api_key>" \ -H "Content-Type: application/json" \ -d '{"capture_enabled": true, "capture_level": "full"}'
Response — 200 OK
(empty body)
On this page
Update Request Capture