> ## Documentation Index
> Fetch the complete documentation index at: https://docs.godiligent.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Deactivate Monitoring

> Deactivate a monitoring configuration for a customer. Idempotent and safe to repeat.

## Overview

Deactivate a monitoring configuration for the authenticated customer. This operation is idempotent: if the monitoring is already inactive, the request will still succeed.

## Request

* **Method**: `DELETE`
* **Path**: `/monitorings/{id}/deactivate`
* **Path Parameters**:
  * `id` (string, required): The monitoring ID to deactivate
* **Authentication**: Requires valid customer authentication

### Example Request

```http theme={null}
DELETE /monitorings/123e4567-e89b-12d3-a456-426614174000/deactivate
```

## Responses

* **204 No Content**
  * Monitoring was successfully deactivated
* **200 OK**
  * Monitoring was already inactive (no response body)
* **404 Not Found**
  * Monitoring with the specified ID was not found for the customer
  * Example:
    ```json theme={null}
    { "error": "Monitoring not found" }
    ```
* **500 Internal Server Error**
  * Unexpected server error during deactivation
  * Example:
    ```json theme={null}
    { "error": "<error message>" }
    ```

## Error Handling

* Returns `404` if the monitoring does not exist for the customer
* Returns `500` with error details if an unexpected error occurs

## Notes

* This endpoint is safe to call multiple times; deactivating an already inactive monitoring is not an error
* Only the owner (customer) of the monitoring may deactivate it


## OpenAPI

````yaml DELETE /monitorings/{id}/deactivate
openapi: 3.0.1
info:
  version: 1.5.0
  title: Diligent
  description: >
    Download Postman collection
    [here](https://docs.godiligent.ai/files/postman_collection.json).
servers:
  - url: https://api.godiligent.ai
    description: Production
  - url: https://api.sandbox.godiligent.ai
    description: Sandbox
security:
  - xApiKey: []
tags:
  - name: CDD
    description: Customer Due Diligence
  - name: Company
    description: Company Information
  - name: Blocked Companies
    description: Manage blocked companies
  - name: Monitorings
    description: Website monitoring and alerts for changes and risks
  - name: Webhooks
    description: >

      ## How to Secure Webhook Deliveries

      To ensure that webhook payloads are securely transmitted and verified.
      This guide explains how to configure and validate

      webhook deliveries using a shared secret.


      ### How It Works


      When setting up a webhook, a secret is configured on both the sender (our
      system) and the receiver (your endpoint). Each

      webhook payload is signed using this secret, allowing the receiver to
      verify its authenticity.


      #### Step 1: Configuring Your Webhook Secret


      1. When creating a webhook in our system, specify a unique secret key.
      This secret should be a strong, randomly

      generated string.

      2. Store this secret securely on your server; it should never be exposed
      publicly.


      #### Step 2: Receiving Webhook Payloads


      When your server receives a webhook event, the request will include an
      `X-Signature` header containing a HMAC signature

      of the payload.


      Example header:


      ```

      X-Signature: sha256=abcdef1234567890...

      ```


      #### Step 3: Validating the Webhook Signature


      To verify the webhook payload:


      1. Retrieve the `X-Signature` value from the request headers.

      2. Compute the HMAC SHA-256 signature of the request payload using your
      webhook secret.

      3. Compare the computed signature with the one in the `X-Signature`
      header.

      4. If they match, the webhook is valid.


      #### (Python)


      ```python

      import hashlib

      import hmac

      import json


      def verify_webhook_signature(secret, payload, signature):
        computed_signature = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()
        expected_signature = f"sha256={computed_signature}"
        return hmac.compare_digest(expected_signature, signature)

      # Example usage:

      secret = "your_webhook_secret"

      payload = json.dumps({"event": "example"})

      received_signature = "sha256=abcdef1234567890..."


      if verify_webhook_signature(secret, payload, received_signature):
        print("Valid webhook received!")
      else:
        print("Invalid webhook signature!")
      ```


      #### (JavaScript)


      ```javascript

      const crypto = require('crypto');


      function verifyWebhookSignature (secret, payload, signature) {

      const computedSignature = `sha256=${crypto.createHmac('sha256', secret)

      .update(payload)

      .digest('hex')}`;

      return crypto.timingSafeEqual(Buffer.from(computedSignature),
      Buffer.from(signature));

      }


      // Example usage:

      const secret = "your_webhook_secret";

      const payload = JSON.stringify({ event: "example" });

      const receivedSignature = "sha256=abcdef1234567890...";


      if (verifyWebhookSignature(secret, payload, receivedSignature)) {

      console.log("Valid webhook received!");

      } else {

      console.log("Invalid webhook signature!");

      }

      ```


      #### Security Considerations


      - Always use HTTPS to prevent interception of webhook payloads.

      - Reject webhook requests that fail signature validation.

      - Rotate secrets periodically to enhance security.


      By following this guide, you ensure that webhook deliveries are secure and
      trusted.
  - name: Instant Screening (experimental)
    description: Instant Website Screening API
  - name: Name Screening
    description: Name screening search, alert management and remediation
paths:
  /monitorings/{id}/deactivate:
    delete:
      tags:
        - Monitorings
      summary: Deactivate a monitoring
      description: Deactivate a monitoring by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      security:
        - xApiKey: []
components:
  securitySchemes:
    xApiKey:
      type: apiKey
      name: X-API-KEY
      in: header

````