DeCloudUs DNS

DeCloudUs DNS API reference

Every endpoint of the account API, grouped by what it manages. The full specification is at /developer/openapi.json; connecting an AI assistant is covered on the MCP page.

Authentication

Registration, login, and session management endpoints. These endpoints do not require authentication.

  • POST/logout — Logout current session
  • POST/logout-all — Logout all sessions
  • GET/auth/magic/{token} — Verify magic link token
  • POST/auth/otp/send — Send OTP code
  • POST/auth/otp/verify — Verify OTP code
  • POST/auth/password-totp — Login with password and TOTP
  • GET/register/referral-sources — List the answers to "How did you hear about us?"
  • POST/register — Register a new account

Account

Account management endpoints for email changes, passkey management, password+TOTP setup, and session/token management. Some endpoints require sudo mode for sensitive operations.

  • GET/user — Get current user
  • POST/account/email — Initiate email change
  • POST/account/email/verify — Confirm email change
  • GET/account/password-totp — Get Password+TOTP status
  • DELETE/account/password-totp — Disable Password+TOTP authentication
  • POST/account/password-totp/setup — Initiate Password+TOTP setup
  • POST/account/password-totp/confirm — Confirm TOTP setup
  • POST/account/sessions/sign-out-others — Sign out of other devices
  • POST/account/sessions/sign-out-everywhere — Sign out everywhere and revoke all access
  • DELETE/account — Delete user account
  • POST/account/sudo — Initiate sudo mode
  • POST/account/sudo/verify — Verify sudo mode
  • GET/account/tokens — List API tokens
  • POST/account/tokens — Create a new API token
  • DELETE/account/tokens/all — Revoke all API tokens
  • DELETE/account/tokens/{tokenId} — Revoke an API token

Profiles

DNS profile management. Profiles define your DNS resolution settings including blocking categories, services, and custom rules.

  • POST/profiles/{profile}/dns-test — Troubleshooting
  • GET/profiles — List all profiles
  • POST/profiles — Create a new DNS profile
  • GET/profiles/{profile} — Get a specific profile
  • PATCH/profiles/{profile} — Update a profile
  • DELETE/profiles/{profile} — Delete a profile
  • POST/profiles/{profile}/categories/toggle — Toggle a blocklist category
  • POST/profiles/{profile}/services/toggle — Toggle a service block

Rules

Custom DNS rules for profiles. Create allowlist/blocklist entries for specific domains.

  • GET/profiles/{profile}/rules — List all rules for a profile
  • POST/profiles/{profile}/rules — Create a new rule
  • GET/profiles/{profile}/rules/{rule} — Get a specific rule
  • PATCH/profiles/{profile}/rules/{rule} — Update a rule
  • DELETE/profiles/{profile}/rules/{rule} — Delete a rule

Schedules

Time-based schedule management for DNS profiles. Automate rule changes based on time of day.

  • GET/profiles/{profile}/schedules/active — Get currently active schedule
  • GET/profiles/{profile}/schedules — List all schedules for a profile
  • POST/profiles/{profile}/schedules — Create a new schedule
  • GET/profiles/{profile}/schedules/{schedule} — Get a specific schedule
  • PATCH/profiles/{profile}/schedules/{schedule} — Update a schedule
  • DELETE/profiles/{profile}/schedules/{schedule} — Delete a schedule

DNS Logs

DNS query log viewing, management, and analytics. View DNS query history for your profiles and access aggregated statistics.

  • GET/logs/analytics — Get DNS query analytics
  • GET/profiles/{profile}/logs — Get DNS query logs for a profile
  • DELETE/profiles/{profile}/logs — Delete all DNS query logs for a profile
  • GET/profiles/{profile}/log-settings — Get DNS log settings for a profile
  • PUT/profiles/{profile}/log-settings — Update DNS log retention settings
  • DELETE/profiles/{profile}/log-settings — Reset log retention to default
  • GET/logs — Get DNS query logs for all profiles
  • DELETE/logs — Delete all DNS query logs

Safe Search

Hold search engines in their safe modes, block engines that have none, and set YouTube Restricted Mode — per profile.

  • PATCH/profiles/{profile}/safe-search — Change safe search settings
  • GET/safe-search/catalogue — List safe search options

Categories

Blocklist categories available for DNS profiles (read-only list).

  • GET/categories — List all blocklist categories

Services

Blockable services available for DNS profiles (read-only list).

  • GET/services — List all blockable services

Subscription

Subscription plans, billing management, and promo codes. View available plans, manage your subscription, upgrade, downgrade, and apply promo codes.

  • POST/subscription/promo-code — Apply a promo code
  • DELETE/subscription/promo-code — Remove promo code
  • GET/subscription/plans — List available subscription plans
  • GET/subscription — Get subscription status
  • GET/subscription/events — Get subscription event history
  • POST/subscription/checkout — Start a new subscription checkout
  • POST/subscription/cancel — Cancel subscription auto-renewal
  • POST/subscription/upgrade — Upgrade subscription plan
  • POST/subscription/downgrade — Downgrade subscription plan
  • POST/subscription/portal — Create billing portal session
  • POST/subscription/pay-overdue — POST /api/subscription/pay-overdue
  • POST/subscription/additional-profiles — Add additional DNS profiles
  • DELETE/subscription/additional-profiles — Remove additional DNS profiles

Dex Tokens

Token balance, usage and purchasing for Dex, the assistant built into the dashboard. Dex consumes tokens per message; these endpoints expose the balance, spend over time, purchase history, and Stripe Checkout for buying more. Purchases are final and non-refundable. Paths keep the `/api/agent/` prefix Dex shipped with.

  • GET/agent/tokens/packs — List token packs
  • GET/agent/tokens — Get token balance
  • GET/agent/tokens/usage — Get token usage
  • GET/agent/tokens/history — Get token history
  • POST/agent/tokens/checkout — Buy a token pack

Dashboard

Dashboard configuration endpoint. Returns branding, theme, and feature flags for the SPA dashboard. This is a public endpoint that does not require authentication.

  • GET/dashboard/config — Get dashboard configuration

System

System health and status endpoints.

  • GET/health — Health check

Dex

The assistant built into the dashboard. One streaming endpoint carries a conversation, plus the endpoints for listing and deleting past ones. Every message is charged against the Dex token balance. Not to be confused with AI Connections, which lets an assistant you already own reach this account over MCP at no cost.

  • GET/agent/settings — Get Dex permissions
  • PATCH/agent/settings — Update Dex permissions
  • POST/agent/chat — Send a message
  • POST/agent/conversations/{conversation}/approve — Approve or reject a paused tool call
  • GET/agent/conversations — List conversations
  • DELETE/agent/conversations — Delete all conversations
  • GET/agent/conversations/{conversation} — Read a conversation
  • DELETE/agent/conversations/{conversation} — Delete a conversation

AI Connections

MCP connections: letting an AI assistant the account holder already owns reach this account and manage DNS on their behalf. Free — that assistant runs on its own provider — and entirely separate from Dex, which is ours and is what Dex tokens pay for.

  • GET/account/mcp-connections — List connected assistants
  • POST/account/mcp-connections — Connect with a token
  • DELETE/account/mcp-connections/{connection} — Disconnect an assistant