Skip to Content

Domains API

API for managing Domains resources.

Fields

interface Domains { name: string; domain: string; project: string; status?: 'pending' | 'active' | 'error'; hostnames?: any[]; vercelId?: string; cloudflareId?: string; errorMessage?: string; }

API Endpoints

GET /api/domains

Retrieves a list of Domains with pagination.

Query Parameters

  • limit: Maximum number of items to return (default: 10)
  • page: Page number for pagination (default: 1)
  • sort: Field to sort by (default: createdAt)
  • where: JSON query for filtering results

GET /api/domains/:id

Retrieves a single Domains by ID.

POST /api/domains

Creates a new Domains.

PATCH /api/domains/:id

Updates an existing Domains.

DELETE /api/domains/:id

Deletes a Domains.

Last updated on