Stop monitoring an address list

DELETE/api/v1/address/monitors/{monitorId}

authentication: Secret API key as a bearer token
billing: Free.

Removes the monitor and its stored results; nothing further is scheduled. A run that is already queued finishes on its own and bills as usual. A monitor that belongs to another account answers 404.

Parameters

name	in	type	description
monitorIdrequired	path	integer	The monitor's id from the list endpoint.

Example request

curl -X DELETE https://spaw.co/api/v1/address/monitors/9 \
  -H "Authorization: Bearer sk_live_…"

const response = await fetch('https://spaw.co/api/v1/address/monitors/9', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer sk_live_…',
  },
});
const result = await response.json();

import requests

response = requests.delete(
    'https://spaw.co/api/v1/address/monitors/9',
    headers={'Authorization': 'Bearer sk_live_…'},
)
result = response.json()

$ch = curl_init('https://spaw.co/api/v1/address/monitors/9');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_live_…'],
]);
$result = json_decode(curl_exec($ch), true);

Responses

200The monitor was removed.

{
    "success": true
}

401The key is missing, malformed, or revoked.

{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

404No such record on this account.

{
    "message": "Not Found"
}

429Over 5 requests per second for the key. Retry after the limit resets.

{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

Error codes

Failures answer { success: false, error: { code, message, request_id } }. Each code has its own page.

markdown version·openapi.json