Monitoring guides / For AI agents

Check a deployment with a JSON CLI

Use CodaURL when a deployment needs an HTTPS availability check that an AI agent can read. Run a check against a saved monitor after a release, then keep scheduled monitoring and alerts for later outages.

Set up a monitor once

Install the CLI, sign in, and add your production health URL. Replace the example URL with a public HTTPS endpoint that you control.

brew install CodaSky/homebrew-tap/codaurl
codaurl login
codaurl add https://my-service.com/health --name "Production API" --expected-status 200 --interval 300 --json

Keep the returned monitor ID for later deployments. Reuse that monitor instead of adding and deleting one on every release. The example accepts HTTP 200 and uses a 5-minute schedule available on Free.

Check after a release

codaurl check <id> --json

Replace <id> with the saved monitor ID. Read check.status to decide whether the endpoint is UP or DOWN. A successful API request alone doesn't mean the monitored URL is healthy.

These are selected fields from an example response; other response fields are omitted:

{
  "check": {
    "previous_status": "DOWN",
    "status": "UP",
    "status_changed": true,
    "error_code": null,
    "notification": "sent"
  }
}

Account for HTTP behavior and limits

Checks use HEAD first and fall back to GET only for HTTP 405 or 501. Redirects aren't followed. Configure the expected status codes for the endpoint you actually want to check. A health endpoint that always returns 200 can't reveal failures it doesn't report.

An immediate check has a 60-second cooldown per monitor and a daily limit of 50 per account, counted in UTC. If the API returns HTTP 429, respect Retry-After. Use the scheduled monitor for ongoing checks.

This workflow tests HTTP availability. Browser interactions, JavaScript execution, and application logs need their own checks.

Keep people and agents informed

Use codaurl get <id> --json for the latest monitor status and codaurl status-history <id> --json for status history. A monitor can send email and push notifications on UP/DOWN changes, with webhook notifications on Pro.

Continue with authenticated API monitoring if your health URL requires a credential, or read the agent contract for response fields.

Get started free Read the docs