Skip to main content
DELETE
/
monitorings
/
{id}
/
deactivate
Deactivate a monitoring
curl --request DELETE \
  --url https://api.godiligent.ai/monitorings/{id}/deactivate \
  --header 'X-API-KEY: <api-key>'

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.

​
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

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: 
      { "error": "Monitoring not found" }
  • 500 Internal Server Error
    • Unexpected server error during deactivation
    • Example: 
      { "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

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required
Example:

"d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4"

Response

No Content