Tank Monitor

The tank monitor resource.

Base/tankMonitor

GET/tankMonitor

List tank monitors

Retrieve a paginated list of tank monitors. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/tankMonitor

curl --request GET \
  --url '<your-host>/tankMonitor?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "tankId": "xyz789",
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "model": "string",
    "installedAt": "2026-01-01T00:00:00Z"
  }
]

GET/tankMonitor

Retrieve a tank monitor

Fetch a single tank monitor by filtering on `id`.

Query parameters

idstring

Match on the tank monitor's `id`, e.g. `eq.{id}`.

GET/tankMonitor

curl --request GET \
  --url '<your-host>/tankMonitor?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "model": "string",
  "installedAt": "2026-01-01T00:00:00Z"
}

POST/tankMonitor

Create a tank monitor

Create a new tank monitor.

Body parameters

companyIdstringrequired

References company.id

tankIdstringrequired

References tank.id

modelstring

installedAttimestamp

removedAttimestamp

activebooleanrequired

providerstring

reportIntervalSecondsnumber

POST/tankMonitor

curl --request POST \
  --url <your-host>/tankMonitor \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","tankId":"xyz789","active":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "model": "string",
  "installedAt": "2026-01-01T00:00:00Z"
}

PATCH/tankMonitor

Update a tank monitor

Update an existing tank monitor, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

tankIdstringrequired

References tank.id

modelstring

installedAttimestamp

removedAttimestamp

activebooleanrequired

providerstring

reportIntervalSecondsnumber

PATCH/tankMonitor

curl --request PATCH \
  --url '<your-host>/tankMonitor?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "model": "string",
  "installedAt": "2026-01-01T00:00:00Z"
}

DELETE/tankMonitor

Delete a tank monitor

Delete a tank monitor, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the tank monitor to delete, e.g. `eq.{id}`.

DELETE/tankMonitor

curl --request DELETE \
  --url '<your-host>/tankMonitor?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content