Delete an annotation

DELETE /annotations/{id}

Scope annotations:write
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Deleting a wilting-point line disables its alert.

Path parameters

id string uuid required

Headers

Idempotency-Key string

Replays the same 2xx response (24 h)

Response

200

Deleted

success boolean always present

Errors

400
Invalid body
401
Not authenticated
403
Insufficient scope/role, or outside your company
404
Annotation not found

not_found

DELETE /annotations/{id}

curl -X DELETE https://api.hub.akuasense.com/v1/annotations/00000000-0000-0000-0000-000000000000 \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/annotations/00000000-0000-0000-0000-000000000000',
  {
    method: 'DELETE',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.delete(
    "https://api.hub.akuasense.com/v1/annotations/00000000-0000-0000-0000-000000000000",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "success": true
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "code": "not_found"
}

application/problem+json · example generated from the schema