> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-control.md).
# Monitoring Control
Turn monitoring on or off for subjects within groups.
## Start Monitoring
> Activates monitoring for a subject in one or more specified groups. Once enabled, Vcheck begins scanning configured data sources and delivers alerts via the registered webhook whenever a match is detected.\
> \
> \### Request body\
> \
> \| Field | Type | Required | Description |\
> \|-------|------|----------|-------------|\
> \| \`subject\_id\` | integer | Yes | The subject to activate monitoring for |\
> \| \`group\_id\` | array\[integer] | Yes | Group IDs in which to enable monitoring |\
> \
> \*\*Idempotent:\*\* if monitoring is already active for the subject in a given group, that group is silently skipped and included in \`turned\_on\_groups\_ids\` only once. Groups not listed in the request are not affected.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`subject\_id\` | integer | The subject ID |\
> \| \`turned\_on\_groups\_ids\` | array\[integer] | Group IDs where monitoring was turned on |\
> \| \`already\_on\_groups\_ids\` | array\[integer] | Group IDs where monitoring was already active |\
> \
> \### Example Request\
> \
> \`\`\`json\
> {\
> "subject\_id": 4413,\
> "group\_id": \[88214]\
> }\
> \`\`\`
````json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Control","description":"Turn monitoring on or off for subjects within groups."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/monitoring-on":{"patch":{"tags":["Monitoring Control"],"operationId":"turnMonitoringOn","summary":"Start Monitoring","description":"Activates monitoring for a subject in one or more specified groups. Once enabled, Vcheck begins scanning configured data sources and delivers alerts via the registered webhook whenever a match is detected.\n\n### Request body\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `subject_id` | integer | Yes | The subject to activate monitoring for |\n| `group_id` | array[integer] | Yes | Group IDs in which to enable monitoring |\n\n**Idempotent:** if monitoring is already active for the subject in a given group, that group is silently skipped and included in `turned_on_groups_ids` only once. Groups not listed in the request are not affected.\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `subject_id` | integer | The subject ID |\n| `turned_on_groups_ids` | array[integer] | Group IDs where monitoring was turned on |\n| `already_on_groups_ids` | array[integer] | Group IDs where monitoring was already active |\n\n### Example Request\n\n```json\n{\n \"subject_id\": 4413,\n \"group_id\": [88214]\n}\n```\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["subject_id","group_id"],"type":"object","properties":{"subject_id":{"description":"The subject to start or stop monitoring.","type":"integer"},"group_id":{"description":"Group IDs in which to enable or disable monitoring.","type":"array","items":{"type":"integer"}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Monitoring turned on.","content":{"application/json":{"schema":{"type":"object","properties":{"subject_id":{"description":"The subject ID.","type":"integer"},"turned_on_groups_ids":{"description":"Group IDs where monitoring was turned on.","type":"array","items":{"type":"integer"}},"message":{"description":"Success message.","type":"string"}}}}}},"400":{"description":"Request body or parameters failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string","format":"uuid"}}}}}}}},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"404":{"description":"Resource does not exist or is not owned by the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string","format":"uuid"}}}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}}
````
## Stop Monitoring
> Deactivates monitoring for a subject in one or more specified groups. After this call, no further alerts are generated for the subject in the listed groups. Monitoring in other groups the subject belongs to is not affected.\
> \
> \### Request body\
> \
> \| Field | Type | Required | Description |\
> \|-------|------|----------|-------------|\
> \| \`subject\_id\` | integer | Yes | The subject to deactivate monitoring for |\
> \| \`group\_id\` | array\[integer] | Yes | Group IDs in which to disable monitoring |\
> \
> \*\*Idempotent:\*\* if monitoring is already off for a given group, that group is included in \`turned\_off\` without error. The subject record itself is not deleted; only the active monitoring state changes.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`subject\_id\` | integer | The subject ID |\
> \| \`turned\_off\` | array\[integer] | Group IDs where monitoring was turned off |\
> \| \`already\_off\` | array\[integer] | Group IDs where monitoring was already inactive |\
> \
> \### Example Request\
> \
> \`\`\`json\
> {\
> "subject\_id": 4413,\
> "group\_id": \[88214]\
> }\
> \`\`\`
````json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Control","description":"Turn monitoring on or off for subjects within groups."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/monitoring-off":{"patch":{"tags":["Monitoring Control"],"operationId":"turnMonitoringOff","summary":"Stop Monitoring","description":"Deactivates monitoring for a subject in one or more specified groups. After this call, no further alerts are generated for the subject in the listed groups. Monitoring in other groups the subject belongs to is not affected.\n\n### Request body\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `subject_id` | integer | Yes | The subject to deactivate monitoring for |\n| `group_id` | array[integer] | Yes | Group IDs in which to disable monitoring |\n\n**Idempotent:** if monitoring is already off for a given group, that group is included in `turned_off` without error. The subject record itself is not deleted; only the active monitoring state changes.\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `subject_id` | integer | The subject ID |\n| `turned_off` | array[integer] | Group IDs where monitoring was turned off |\n| `already_off` | array[integer] | Group IDs where monitoring was already inactive |\n\n### Example Request\n\n```json\n{\n \"subject_id\": 4413,\n \"group_id\": [88214]\n}\n```\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["subject_id","group_id"],"type":"object","properties":{"subject_id":{"description":"The subject to start or stop monitoring.","type":"integer"},"group_id":{"description":"Group IDs in which to enable or disable monitoring.","type":"array","items":{"type":"integer"}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Monitoring turned off.","content":{"application/json":{"schema":{"type":"object","properties":{"subject_id":{"description":"The subject ID.","type":"integer"},"turned_off":{"description":"Group IDs where monitoring was turned off.","type":"array","items":{"type":"integer"}},"message":{"description":"Success message.","type":"string"}}}}}},"400":{"description":"Request body or parameters failed validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string","format":"uuid"}}}}}}}},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"404":{"description":"Resource does not exist or is not owned by the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string","format":"uuid"}}}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}}
````
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-control.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.