Nova Uptime

Referencia de la API

Integra Nova Uptime en tu flujo de trabajo. Monitoriza dominios, rastrea cambios en URLs y comprueba la salud del email de forma programática.

v1URL base: https://api.novauptime.com/api/v1
Primeros pasos

Introduction

The Nova Uptime API gives you programmatic access to manage your uptime monitors, run email health checks, and retrieve incident history. All endpoints return JSON and follow RESTful conventions.

Base URL

https://api.novauptime.com/api/v1

Response Format

All responses are wrapped in a standard envelope:

{
  "success": true,
  "data": { ... },
  "message": "Optional status message"
}

Pagination

List endpoints return paginated results with this structure:

"pagination": {
  "total": 42,
  "page": 1,
  "limit": 10,
  "totalPages": 5
}

Authentication

All API requests require authentication via an API key. Pass your key in theX-API-Keyheader with every request.

curl https://api.novauptime.com/api/v1/domains \
  -H "X-API-Key: YOUR_API_KEY"

Getting your API key

Go to Dashboard → Settings → API Key to generate your key. You can regenerate or delete it at any time.

API Access — All Plans

The public API is available on all plans, including Free. Plan limits (domain count, check interval, etc.) still apply.


Rate Limits

The API enforces per-user rate limits based on your plan. If you exceed the limit, you'll receive a 429 Too Many Requests response. Rate limit headers are included in every response:

  • X-RateLimit-Limit — your plan's maximum requests per window
  • X-RateLimit-Remaining — requests remaining in the current window
  • X-RateLimit-Reset — Unix timestamp when the window resets
PlanLimitWindow
Free20 requests1 minute
Pro100 requests1 minute
Agency500 requests1 minute

Plan Limits

Resource limits depend on your subscription plan. When a limit is reached, create/add endpoints will return a 400 error with a descriptive message.

FeatureFreePro ($99/yr)Agency ($699/yr)
API Access
Domain monitors51001,000
URL monitors51001,000
Min check interval (domains)15 min5 min59s
Min check interval (URLs)24h3h1h

Limit Exceeded Example

{
  "success": false,
  "message": "Maximum domain limit (100) reached. Upgrade your plan to add more domains."
}

Dashboard & Status

Get an overview of all monitored resources and recent incidents.

Status Overview

Get a summary of all your monitored domains and URLs, including counts by state and plan usage.

GEThttps://api.novauptime.com/api/v1/status

Notes

  • Returns aggregate counts across all your monitored resources.

Recent Incidents

Get a list of recent downtime incidents across all your monitored domains.

GEThttps://api.novauptime.com/api/v1/incidents

Query Parameters

NameTypeDescription
limitintegerMax number of incidents (1-50)(default: 10)

Notes

  • Incidents are sorted by most recent first.
  • Only includes incidents from domains you own.

Domains

Monitor website uptime, SSL certificates, domain expiry, and email health.

List Domains

Retrieve a paginated list of your monitored domains with current status, SSL info, and email health grades.

GEThttps://api.novauptime.com/api/v1/domains

Query Parameters

NameTypeDescription
pageintegerPage number(default: 1)
limitintegerItems per page (1-50)(default: 10)

Notes

  • Results are sorted by creation date (newest first)
  • Only active (non-deleted) domains are returned

Get Domain

Retrieve detailed information about a specific domain including SSL, redirect detection, and monitoring config.

GEThttps://api.novauptime.com/api/v1/domains/:id

Path Parameters

NameTypeDescription
idrequiredstringThe domain ID

Error Responses

404Domain not found.

Add Domain

Add a new domain to monitor. Monitoring starts immediately with an initial health check. URL is automatically normalized (https:// prefix added if missing).

POSThttps://api.novauptime.com/api/v1/domains

Body Parameters

NameTypeDescription
urlrequiredstringDomain URL to monitor (e.g., "example.com" or "https://fliplink.me")
namestringFriendly display name
checkIntervalintegerCheck interval in seconds. Minimum depends on plan: Free=900, Pro=300, Agency=59(default: 300)
timeoutintegerRequest timeout in seconds (5-30). Must be less than checkInterval(default: 30)

Plan Limits

Domain limit depends on plan: Free=5, Pro=100, Agency=1000. Check interval minimum: Free=15min, Pro=5min, Agency=59s.

Error Responses

400URL is required.
400URL must point to a public domain.
400Maximum domain limit (100) reached. Upgrade your plan to add more domains.
400This domain is already being monitored.
400Timeout must be less than check interval.

Delete Domain

Remove a domain from monitoring (soft delete). The domain data is retained but monitoring stops.

DELETEhttps://api.novauptime.com/api/v1/domains/:id

Path Parameters

NameTypeDescription
idrequiredstringThe domain ID to delete

Error Responses

404Domain not found.

Get Domain Incidents

Retrieve the last 20 incidents (downtime events) for a domain, including trigger/resolution status codes and screenshot URLs.

GEThttps://api.novauptime.com/api/v1/domains/:id/incidents

Path Parameters

NameTypeDescription
idrequiredstringThe domain ID

Error Responses

404Domain not found.

Notes

  • Returns up to 20 most recent incidents
  • Screenshot URLs may be null if screenshots are disabled

Get Check History

Retrieve health check history for a domain within a configurable time window. Returns up to 500 records.

GEThttps://api.novauptime.com/api/v1/domains/:id/history

Path Parameters

NameTypeDescription
idrequiredstringThe domain ID

Query Parameters

NameTypeDescription
hoursintegerHours of history to fetch (1-720)(default: 24)

Error Responses

404Domain not found.

Notes

  • Maximum 720 hours (30 days)
  • Maximum 500 records per request
  • Sorted newest first

Update Domain

Update monitoring settings for an existing domain.

PATCHhttps://api.novauptime.com/api/v1/domains/:id

Path Parameters

NameTypeDescription
idrequiredstringDomain ID

Body Parameters

NameTypeDescription
namestringDisplay name
checkIntervalintegerCheck interval in seconds (59-86400)
timeoutSecondsintegerTimeout in seconds (5-30)
ccEmailsstring[]CC email addresses for alerts
screenshotOnFailurebooleanCapture screenshot on failure
emailHealthIntervalintegerEmail health check interval (seconds)
cardColorstringCard color hex code

Notes

  • Only provided fields are updated.
  • Check interval must be >= your plan minimum.

Pause Domain Monitoring

Temporarily pause monitoring for a domain. No health checks or alerts while paused.

POSThttps://api.novauptime.com/api/v1/domains/:id/pause

Path Parameters

NameTypeDescription
idrequiredstringDomain ID

Notes

  • Monitoring is immediately paused.
  • Use Resume to restart monitoring.

Resume Domain Monitoring

Resume monitoring for a previously paused domain.

POSThttps://api.novauptime.com/api/v1/domains/:id/resume

Path Parameters

NameTypeDescription
idrequiredstringDomain ID

Notes

  • The domain state resets to unknown until the next check completes.

Domain Email Health Check

Run an email health check for a specific monitored domain (MX, SPF, DKIM, DMARC, Blacklist).

POSThttps://api.novauptime.com/api/v1/domains/:id/email-health

Path Parameters

NameTypeDescription
idrequiredstringDomain ID

Query Parameters

NameTypeDescription
freshbooleanSkip cache and run fresh check(default: false)

Notes

  • Results are cached for 1 hour unless fresh=true is specified.

Bulk Update Domains

Update monitoring settings for multiple domains at once. Only provided fields are changed.

PATCHhttps://api.novauptime.com/api/v1/domains/bulk

Body Parameters

NameTypeDescription
domainIdsrequiredstring[]Array of domain IDs to update
updatesrequiredobjectFields to update (checkInterval, timeoutSeconds, etc.)

Notes

  • Domains are processed in chunks of 50.
  • Partial failures are reported in the errors array.

Bulk Delete Domains

Delete multiple monitored domains at once. Requires confirmation string.

DELETEhttps://api.novauptime.com/api/v1/domains/bulk

Body Parameters

NameTypeDescription
domainIdsrequiredstring[]Array of domain IDs to delete
confirmationrequiredstringMust be exactly "DELETE"

Notes

  • This is a soft delete — domains are marked inactive.
  • Monitoring is immediately stopped for deleted domains.

Assign Tags to Domain

Replace all tags on a domain with the provided tag IDs.

PUThttps://api.novauptime.com/api/v1/domains/:id/tags

Path Parameters

NameTypeDescription
idrequiredstringDomain ID

Body Parameters

NameTypeDescription
tagIdsrequiredstring[]Array of tag IDs to assign

Notes

  • Pass an empty array to remove all tags.
  • Tags must belong to your account.

Tags

Organize domains into folders/tags for easy management and filtering.

List Tags

Get all tags for your account with domain counts.

GEThttps://api.novauptime.com/api/v1/tags

Create Tag

Create a new tag for organizing domains.

POSThttps://api.novauptime.com/api/v1/tags

Body Parameters

NameTypeDescription
namerequiredstringTag name (unique per account)
colorstringHex color code(default: #6B7280)

Notes

  • Tag names must be unique within your account.

Update Tag

Update an existing tag name, color, or sort order.

PATCHhttps://api.novauptime.com/api/v1/tags/:id

Path Parameters

NameTypeDescription
idrequiredstringTag ID

Body Parameters

NameTypeDescription
namestringNew tag name
colorstringNew hex color code
sortOrderintegerDisplay order

Delete Tag

Delete a tag. Domains are unlinked but not deleted.

DELETEhttps://api.novauptime.com/api/v1/tags/:id

Path Parameters

NameTypeDescription
idrequiredstringTag ID

Notes

  • Deleting a tag removes it from all domains but does not delete the domains.

URL Monitoring

Monitor specific URLs for uptime, content changes, and capture screenshots.

List URLs

Retrieve a paginated list of your monitored URLs with current status and check configuration.

GEThttps://api.novauptime.com/api/v1/urls

Query Parameters

NameTypeDescription
pageintegerPage number(default: 1)
limitintegerItems per page (1-50)(default: 10)

Notes

  • URL states: active (green), changed (amber), error (red), unknown (gray)

Get URL

Retrieve detailed information about a specific monitored URL.

GEThttps://api.novauptime.com/api/v1/urls/:id

Path Parameters

NameTypeDescription
idrequiredstringThe URL monitor ID

Error Responses

404URL not found.

Add URL

Add a new URL to monitor. Monitoring starts immediately. URL is normalized with https:// prefix if missing.

POSThttps://api.novauptime.com/api/v1/urls

Body Parameters

NameTypeDescription
urlrequiredstringURL to monitor (e.g., "https://example.com/status")
namestringFriendly display name
checkIntervalintegerCheck interval in seconds. Min depends on plan: Free=86400, Pro=10800, Agency=3600(default: 86400)

Plan Limits

URL limit depends on plan: Free=5, Pro=100, Agency=1000. Check interval minimum: Free=24h, Pro=3h, Agency=1h.

Error Responses

400URL is required.
400URL must point to a public domain.
400Maximum URL limit reached. Upgrade your plan to add more URLs.
400This URL is already being monitored.

Delete URL

Remove a URL from monitoring (soft delete). Monitoring stops immediately.

DELETEhttps://api.novauptime.com/api/v1/urls/:id

Path Parameters

NameTypeDescription
idrequiredstringThe URL monitor ID to delete

Error Responses

404URL not found.

Check URL Now

Trigger an immediate check for a monitored URL. Runs the check without waiting for the next scheduled interval. Rate limited to one check every 30 seconds.

POSThttps://api.novauptime.com/api/v1/urls/:id/check-now

Path Parameters

NameTypeDescription
idrequiredstringThe URL monitor ID to check

Error Responses

404URL not found.
429Please wait X seconds before checking again.

Get Content Changes

Retrieve content change history for a monitored URL. Each entry includes a diff summary and change count.

GEThttps://api.novauptime.com/api/v1/urls/:id/changes

Path Parameters

NameTypeDescription
idrequiredstringThe URL monitor ID

Query Parameters

NameTypeDescription
limitintegerNumber of records (1-50)(default: 20)

Error Responses

404URL not found.

Get Screenshots

Retrieve screenshot history for a monitored URL. Screenshots are captured at configurable intervals.

GEThttps://api.novauptime.com/api/v1/urls/:id/screenshots

Path Parameters

NameTypeDescription
idrequiredstringThe URL monitor ID

Query Parameters

NameTypeDescription
limitintegerNumber of records (1-50)(default: 20)

Error Responses

404URL not found.

Update URL

Update monitoring settings for a URL.

PATCHhttps://api.novauptime.com/api/v1/urls/:id

Path Parameters

NameTypeDescription
idrequiredstringURL ID

Body Parameters

NameTypeDescription
namestringDisplay name
checkIntervalintegerCheck interval in seconds
screenshotEnabledbooleanEnable/disable screenshots
screenshotWaitMsintegerWait time before screenshot (ms)
timeoutSecondsintegerRequest timeout (5-30)

Notes

  • Only provided fields are updated.

Pause URL Monitoring

Temporarily pause monitoring for a URL.

POSThttps://api.novauptime.com/api/v1/urls/:id/pause

Path Parameters

NameTypeDescription
idrequiredstringURL ID

Resume URL Monitoring

Resume monitoring for a paused URL.

POSThttps://api.novauptime.com/api/v1/urls/:id/resume

Path Parameters

NameTypeDescription
idrequiredstringURL ID

Bulk Update URLs

Update settings for multiple URLs at once.

PATCHhttps://api.novauptime.com/api/v1/urls/bulk

Body Parameters

NameTypeDescription
urlIdsrequiredstring[]Array of URL IDs to update
updatesrequiredobjectFields to update

Bulk Delete URLs

Delete multiple monitored URLs at once. Requires explicit confirmation string.

DELETEhttps://api.novauptime.com/api/v1/urls/bulk

Body Parameters

NameTypeDescription
urlIdsrequiredstring[]Array of URL IDs to delete
confirmationrequiredstringMust be exactly "DELETE" to confirm

Error Responses

400confirmation must be exactly "DELETE"

Notes

  • This action is irreversible. Deleted URLs stop being monitored immediately.
  • The confirmation field must be the exact string "DELETE" (case-sensitive).

Assign Tags to URL

Replace all tags on a URL with the provided tag IDs.

PUThttps://api.novauptime.com/api/v1/urls/:id/tags

Path Parameters

NameTypeDescription
idrequiredstringURL ID

Body Parameters

NameTypeDescription
tagIdsrequiredstring[]Array of tag IDs to assign (empty array removes all tags)

Notes

  • Replaces all existing tag assignments — pass the full desired tag list.
  • Use an empty array [] to remove all tags from the URL.

Email Health

Check MX, SPF, DKIM, DMARC, and blacklist status for any domain.

Check Email Health

Run a comprehensive email deliverability check including MX records, SPF, DKIM (50 selector scan), DMARC, and IP blacklist status. Results are cached for 1 hour.

POSThttps://api.novauptime.com/api/v1/email-health

Body Parameters

NameTypeDescription
domainrequiredstringDomain to check (e.g., "example.com"). Protocol and www prefix are auto-stripped.
freshbooleanSkip cache and run a fresh check(default: false)

Notes

  • Results cached in Redis for 1 hour (use fresh=true to bypass)
  • DKIM detection scans 50 common selectors in parallel
  • Scoring: MX 20%, SPF 25%, DKIM 20%, DMARC 25%, Blacklist 10%
  • Grades: A (90-100), B (80-89), C (70-79), D (60-69), F (0-59)

Notifications

View alerts and notification history for your monitored resources.

List Notifications

Get a paginated list of your notifications.

GEThttps://api.novauptime.com/api/v1/notifications

Query Parameters

NameTypeDescription
pageintegerPage number(default: 1)
limitintegerItems per page (1-50)(default: 20)
typestringFilter by type (status_change, ssl_expiry, etc.)

Notes

  • Notification types: status_change, ssl_expiry, ssl_invalid, domain_expiry, email_health_alert, email_health_recovery, weekly_report.

Unread Notification Count

Get the count of pending (unsent) notifications.

GEThttps://api.novauptime.com/api/v1/notifications/unread

Pause Notifications

Pause all notifications (email, WhatsApp, webhooks). Monitoring continues in the background — domains are still checked and incidents are still logged, but you will not receive alerts.

POSThttps://api.novauptime.com/api/v1/notifications/pause

Notes

  • Monitoring continues — only alert delivery is paused.
  • Affects all channels: email, WhatsApp, and webhooks.
  • Use POST /notifications/resume to re-enable alerts.

Resume Notifications

Resume all notifications after pausing. You will start receiving alerts again when domains go down or recover.

POSThttps://api.novauptime.com/api/v1/notifications/resume

Notification Pause Status

Check whether notifications are currently paused.

GEThttps://api.novauptime.com/api/v1/notifications/pause-status

Team Members

Manage team members and shared domain access.

List Team Members

Get all team members and their invite status.

GEThttps://api.novauptime.com/api/v1/team

Notes

  • Only the account owner can manage team members.

Invite Team Member

Invite a new team member by email with optional domain access.

POSThttps://api.novauptime.com/api/v1/team/invite

Body Parameters

NameTypeDescription
emailrequiredstringEmail address to invite
domainAccessobject[]Array of { domainId, canWrite } objects

Notes

  • Invite expires after 7 days.
  • Team member limits: Pro = 5, Agency = 20.

Remove Team Member

Remove a team member and revoke all their domain access.

DELETEhttps://api.novauptime.com/api/v1/team/:membershipId

Path Parameters

NameTypeDescription
membershipIdrequiredstringMembership ID

Resend Invite

Resend an invitation email to a pending team member.

POSThttps://api.novauptime.com/api/v1/team/:membershipId/resend

Path Parameters

NameTypeDescription
membershipIdrequiredstringMembership ID

Notes

  • Generates a new invite token with a fresh 7-day expiry.

Webhooks

Manage outgoing webhook integrations for real-time alerts.

List Webhooks

Get all webhooks, optionally filtered by domain.

GEThttps://api.novauptime.com/api/v1/webhooks

Query Parameters

NameTypeDescription
domainIdstringFilter by domain ID

Create Webhook

Create a new webhook endpoint for receiving real-time alerts.

POSThttps://api.novauptime.com/api/v1/webhooks

Body Parameters

NameTypeDescription
domainIdrequiredstringDomain to attach webhook to
urlrequiredstringWebhook URL (must be HTTPS)
labelstringDisplay label
eventsrequiredstring[]Event types to subscribe to

Notes

  • The signing secret is shown only once on creation.
  • Payloads are signed with HMAC-SHA256 in the X-NovaUptime-Signature header.

Delete Webhook

Delete a webhook endpoint.

DELETEhttps://api.novauptime.com/api/v1/webhooks/:id

Path Parameters

NameTypeDescription
idrequiredstringWebhook ID

Test Webhook

Send a test payload to a webhook endpoint to verify connectivity.

POSThttps://api.novauptime.com/api/v1/webhooks/:id/test

Path Parameters

NameTypeDescription
idrequiredstringWebhook ID

Notes

  • Sends a test event payload to the webhook URL.

Settings

View and update user settings including timezone, weekly reports, and notification pause.

Get Settings

Get your current settings — timezone, weekly report preference, and notification pause status.

GEThttps://api.novauptime.com/api/v1/settings

Update Settings

Update one or more settings. Only include fields you want to change.

PATCHhttps://api.novauptime.com/api/v1/settings

Body Parameters

NameTypeDescription
timezonestringIANA timezone string (e.g., "America/New_York")
weeklyReportEnabledbooleanEnable or disable weekly email reports
notificationsPausedbooleanPause all notifications (monitoring continues, alerts silenced)

Notes

  • Set notificationsPaused to true to pause all alerts (email, WhatsApp, webhooks). Monitoring continues in the background.

Account & Billing

View account information, plan details, and payment history.

Get Account Info

Get your account profile and current plan information.

GEThttps://api.novauptime.com/api/v1/account

Billing Summary

Get your current plan, limits, expiry date, and add-on information.

GEThttps://api.novauptime.com/api/v1/billing

Payment History

Get a list of past payments and license purchases.

GEThttps://api.novauptime.com/api/v1/billing/history

Notes

  • Amounts are in cents (e.g., 9900 = $99.00).

Create Checkout Session

Create a Stripe checkout session and get a URL to complete the purchase. Redirect the user to the returned URL.

POSThttps://api.novauptime.com/api/v1/billing/checkout

Body Parameters

NameTypeDescription
typerequiredstringPlan type: "pro" or "agency"
isAddonbooleanSet to true to purchase a domain add-on instead of a plan
addonTypestringAdd-on type: "domains_10", "domains_50", or "domains_100" (required when isAddon is true)

Notes

  • Add-ons require an active Pro or Agency plan.
  • The URL expires after 24 hours.

Campaign Simulation

Run cold email deliverability simulations against prospect lists. Each unique domain checked costs 1 simulation credit. Public email domains (gmail.com, yahoo.com, etc.) are filtered automatically and do not cost credits.

Run Campaign Simulation

Start a cold email deliverability simulation. Deducts credits from your account based on the number of unique domains checked.

POSThttps://api.novauptime.com/api/v1/campaign-simulate

Body Parameters

NameTypeDescription
sendingDomainsrequiredstring[]Your sending domains (e.g., ["outreach.kitepin.com", "sales.fliplink.me"])
prospectEntriesrequiredstring[]Prospect emails or domains to check — see exampleRequest below for format
namestringCampaign name for easy identification (max 100 chars). Auto-generated if omitted.

Error Responses

402Insufficient simulation credits. Need 4, have 2.
400sendingDomains is required (array of domain strings)
400prospectEntries is required (array of email/domain strings)

Notes

  • Each unique domain (sender + prospect) costs 1 credit. Public email domains (gmail.com, outlook.com, etc.) are filtered and do not cost credits.
  • Returns 402 Payment Required if you do not have enough credits.
  • Job processing is asynchronous — poll the status endpoint until status is "completed".
  • Rate limited to prevent abuse.

Get Simulation Status

Check the status and results of a campaign simulation job.

GEThttps://api.novauptime.com/api/v1/campaign-simulate/:jobId

Path Parameters

NameTypeDescription
jobIdrequiredstringThe job ID returned from the create endpoint

Error Responses

404Job not found

Notes

  • Possible status values: "queued", "processing", "completed", "failed", "expired".
  • Poll every 3-5 seconds until status is "completed" or "failed".
  • CSV downloads are available when the corresponding has*Csv field is true.
  • shareUrl is the OTP-protected web share link for this campaign (null until campaign has a share token).

Get Simulation Credit Balance

Check your current simulation credit balance and recent transaction history.

GEThttps://api.novauptime.com/api/v1/simulation-credits

Notes

  • Positive amounts are credit grants; negative amounts are usage deductions.
  • Annual credit allocations: Free = 60, Pro = 1,200, Agency = 12,000.
  • Add-on credits available: 1,000 credits / $9, 5,000 credits / $39, 10,000 credits / $69.

List Campaign Simulations

List your campaign simulation jobs, most recent first.

GEThttps://api.novauptime.com/api/v1/campaign-simulations

Query Parameters

NameTypeDescription
pagenumberPage number (default: 1)
limitnumberResults per page (default: 20, max: 50)

Notes

  • Results are ordered by creation date, most recent first.
  • Each job includes a name and shareUrl for OTP-protected sharing.
  • Use the job ID with the status endpoint to get full details.

Download Simulation CSV

Download the CSV results of a completed campaign simulation. Three CSV types are available: campaign (full prospect analysis), sender (sending domain health), and suggestion (improvement recommendations).

GEThttps://api.novauptime.com/api/v1/campaign-simulate/:jobId/download/:type

Path Parameters

NameTypeDescription
jobIdrequiredstringThe job ID returned from the create endpoint
typerequiredstringCSV type: "campaign", "sender", or "suggestion"

Error Responses

400Invalid CSV type. Must be: campaign, sender, or suggestion.
404Job not found.
404CSV not yet available. Wait for the job to complete.

Notes

  • Only available after the job status is "completed".
  • Check the has*Csv fields in the status response to see which CSVs are available.
  • The response is a binary file download, not JSON.
  • campaign = full prospect domain analysis, sender = your sending domain health, suggestion = improvement recommendations.

Get Campaign Share URL

Get the OTP-protected web share URL for a completed campaign. The URL is permanent (no expiry) but the recipient must enter a 4-digit OTP sent to your account email to view results.

POSThttps://api.novauptime.com/api/v1/campaign-simulate/:jobId/share-info

Path Parameters

NameTypeDescription
jobIdrequiredstringThe campaign job ID

Error Responses

404Job not found.

Notes

  • shareUrl is null if the campaign has no share token yet.
  • OTP is sent to the campaign owner's account email — not the recipient's email.
  • Use revoke-share to invalidate the URL and rotate the share token.

Revoke Campaign Share

Rotate the campaign's share token. All previously issued share URLs and any open OTP/access tokens stop working immediately. A new share URL is generated.

POSThttps://api.novauptime.com/api/v1/campaign-simulate/:jobId/revoke-share

Path Parameters

NameTypeDescription
jobIdrequiredstringThe campaign job ID

Error Responses

404Job not found.

Notes

  • Use this if a share URL leaks or you want to revoke access.
  • The new shareUrl works immediately — issue it to anyone you still want to grant access.
  • Existing OTP codes for the OLD share token are deleted from Redis.

Free Tools

Standalone diagnostic checks that don't require domains to be added to your account. Useful for ad-hoc validation, signup forms, and integrations.

Check Disposable Email

Check whether an email address (or bare domain) belongs to a disposable / temporary email provider. Backed by a 72,000+ domain blocklist. Use to block fake signups, throwaway trial accounts, or low-quality leads at registration.

POSThttps://api.novauptime.com/api/v1/check-disposable-email

Body Parameters

NameTypeDescription
emailrequiredstringFull email address or bare domain to check (see exampleRequest)

Error Responses

400email or domain is required

Notes

  • Legitimate privacy providers (ProtonMail, StartMail, SimpleLogin, Tutanota) are NOT flagged.
  • Accepts either a full email address or a bare domain.
  • No credit cost — runs against an in-memory blocklist (sub-millisecond).
  • Source list: github.com/disposable/disposable-email-domains (refreshed periodically).

Error Codes

The API uses standard HTTP status codes. Errors include a descriptive message in the response body.

CodeMeaning
200Success — request completed normally
201Created — resource was created successfully
400Bad Request — invalid parameters, duplicate, or plan limit reached
401Unauthorized — missing or invalid API key
403Forbidden — plan limit reached (e.g., max domains) or feature requires upgrade
404Not Found — resource does not exist or belongs to another user
429Rate Limited — too many requests, try again later
500Server Error — something went wrong on our end

Error Response Format

{
  "success": false,
  "message": "Human-readable error description"
}

¿Listo para empezar?

Genera tu clave API desde el dashboard y empieza a construir.