Skip to main content

Endpoints

Overview

Manages custom domain configuration for DROP service. Requires Enterprise tier. Custom domains are stored in service metadata.

GET /api/user/custom-domain

Retrieves custom domain configuration for the authenticated user’s DROP service.

Response

string
Custom domain (null if not set)
boolean
Whether domain is verified
boolean
Whether custom domain is configured

POST /api/user/custom-domain

Sets a custom domain for DROP service. Requires Enterprise tier.

Request

string
required
Domain name (1-255 characters). Must be valid domain format.

Response

boolean
Always true on success
string
The domain that was set
string
“Domain connected successfully. Please configure your DNS settings.”

DELETE /api/user/custom-domain

Removes custom domain configuration.

Response

boolean
Always true on success
string
“Custom domain disconnected successfully”

Implementation Details

Code Reference

Status Codes

OK
Success
Bad Request
Invalid domain format
Forbidden
Enterprise plan required
Conflict
Domain is already in use by another user
Unauthorized
Missing or invalid authentication token

Requirements

  • Tier: Enterprise plan required
  • Service: DROP service only
  • Domain Format: Valid domain name format (regex validated)
  • Uniqueness: Domain must be unique across all users

Example Requests

Get Custom Domain

Set Custom Domain

Remove Custom Domain

Example Response (GET)

Domain Storage

Custom domains are stored in the metadata field of the DROP service entitlement:
  • customDomain: Domain string
  • customDomainVerified: Verification status (boolean)

Audit Events

  • USER_UPDATE: Custom domain set or removed (includes field: 'customDomain')