Stop profile monitoring

1 min

POST

https://api.detected.app/api/v2/public/profiles/{uuid}/monitoring/{action}

Stops ongoing monitoring for a profile. The scope in the request body controls how much is stopped:

all: company-level alert monitoring and every screening, including representatives
alerts: company-level alert monitoring only
screenings: the profile's own screenings only

Each stop is confirmed with the underlying data provider before the change is saved. If a request returns a 502 response, the response lists which targets failed. You can safely retry the request, because targets that have already stopped are skipped.

uuidstringThe UUID of the profile.

actionstringThe monitoring action to perform.

bodyobject

200OK. Monitoring has been stopped and confirmed with all providers.

401Unauthorized. The access token is missing, invalid or has expired.

404Not Found. The requested resource does not exist, or is not available to your account.

422Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.

429Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.

502Bad Gateway. Monitoring could not be stopped for one or more targets, and the response body lists which. It is safe to retry, because targets that have already stopped are skipped.

curl --request POST \
     --url https://api.detected.app/api/v2/public/profiles/{uuid}/monitoring/{action} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "scope": "all"
     }'

Have a question?

Our knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.