Sites API

Manage your websites — create, update, list, and configure sites.

List Sites

Retrieve all sites for the authenticated user.

GET /api/v1/sites

Query Parameters

ParameterTypeDefaultDescription
is_activebooleanFilter by active status

Example Response

{
  "items": [
    {
      "id": "site-uuid",
      "name": "My Website",
      "domain": "example.com",
      "platform": "wordpress",
      "is_active": true,
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 1
}

Get Site

Retrieve details for a specific site.

GET /api/v1/sites/{site_id}

Example Response

{
  "id": "site-uuid",
  "name": "My Website",
  "domain": "example.com",
  "platform": "wordpress",
  "is_active": true,
  "health_score": 85,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-02-20T14:00:00Z"
}

Create Site

Add a new website to your account.

POST /api/v1/sites

Request Body

FieldTypeRequiredDescription
namestringYesDisplay name for the site
domainstringYesWebsite domain (e.g., example.com)

Example Response

{
  "id": "new-site-uuid",
  "name": "My New Site",
  "domain": "newsite.com",
  "is_active": true,
  "created_at": "2026-02-25T10:00:00Z"
}

Update Site

Update site details.

PUT /api/v1/sites/{site_id}

Request Body

FieldTypeRequiredDescription
namestringNoUpdated display name
domainstringNoUpdated domain