PageHub Domain API

A site's custom domain.

GitHub OpenAPI

Operations 3

GET /api/v1/sites/{id}/domain Read a site's domain, or preflight one #
PATCH /api/v1/sites/{id}/domain Attach a domain or change its redirect mode #
DELETE /api/v1/sites/{id}/domain Detach the domain #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pagehub-dev:pagehub-dev-domain-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pagehub-dev-domain-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: PageHub Domain API
  version: 1.0.0
  description: 'The public REST API of PageHub, called with a `ph_` API key (`Authorization: Bearer ph_...`), plus the one webhook the platform calls on a white-label tenant''s server (`fetchPage`).


    A site is HTML + Liquid files: its pages are files (`pages/*.liquid`), written through the files API; the page routes manage each page''s record (name, slug, SEO, access). Writes land in the site''s draft; `PUT /api/v1/sites/{id}` with `published: true` makes the draft live.


    The headless content API (`/api/v1/content/...`) is described by its own document (`GET /api/v1/content/openapi.json`); `GET /api/openapi.json` serves this document with it merged in.


    The routes also accept the dashboard''s session cookie from the dashboard itself; only the API key is the public contract.


    Every operation carries two extension fields. `x-auth` says who may call it: `api-key` (a `ph_` key), `session-or-key` (the dashboard''s own session, or a key), `optional-key` (public, a key widens what you see), `admin-key` (a platform admin''s key), `session` (the dashboard session only; an API key is refused) or `public`. `x-rate-limit` names the rate-limit rule (see the rate-limiting guide) when the route has one; most routes limit per user, public routes per IP.'
  contact:
    name: PageHub
    url: https://pagehub.dev/developers
servers:
- url: https://pagehub.dev
  description: PageHub
security:
- bearerAuth: []
tags:
- name: Domain
  description: A site's custom domain.
paths:
  /api/v1/sites/{id}/domain:
    get:
      tags:
      - Domain
      summary: Read a site's domain, or preflight one
      description: 'The attached domain with the DNS records still to create for each variant. `check=` preflights a candidate instead; a candidate held by another site answers only `available: false`.'
      operationId: getSiteDomain
      parameters:
      - $ref: '#/components/parameters/SiteId'
      - name: check
        in: query
        required: false
        schema:
          type: string
        description: A domain to preflight.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainState'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-auth: api-key
      x-rate-limit: dashboard_settings_save
    patch:
      tags:
      - Domain
      summary: Attach a domain or change its redirect mode
      description: Needs the owner or agency role. Attaching registers both variants of the pair with the host, and the answer carries the DNS records to create; attaching does not publish the site. Repeating the same call is a no-op that reports the DNS state.
      operationId: setSiteDomain
      parameters:
      - $ref: '#/components/parameters/SiteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type:
                  - string
                  - 'null'
                  description: The domain to attach; null detaches it.
                domainRedirectMode:
                  type: string
                  enum:
                  - none
                  - to-apex
                  - to-www
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainState'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: A conflict (`error` says which).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          description: An upstream service (Stripe, Vercel, a mail server, a stock provider) failed or refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      x-auth: api-key
      x-rate-limit: dashboard_settings_save
    delete:
      tags:
      - Domain
      summary: Detach the domain
      description: Needs the owner or agency role. `detachFailures` lists any variant still left on the host project.
      operationId: clearSiteDomain
      parameters:
      - $ref: '#/components/parameters/SiteId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  id:
                    type: string
                  domain:
                    type: 'null'
                  domainRedirectMode:
                    const: none
                  detachFailures:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                required:
                - ok
                - id
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-auth: api-key
      x-rate-limit: dashboard_settings_save
components:
  parameters:
    SiteId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: The site's id.
  responses:
    Unauthorized:
      description: Missing, malformed or invalid `ph_` API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    BadRequest:
      description: The request is malformed or refused (`error`, often `message`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: The key's user lacks the role this needs, or a plan limit applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: No such site, or the key has no access to it, or no such resource under it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Too many requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    DomainState:
      type: object
      properties:
        ok:
          type: boolean
        id:
          type: string
        domain:
          type:
          - string
          - 'null'
        domainRedirectMode:
          type: string
          enum:
          - none
          - to-apex
          - to-www
        checked:
          type: string
        pair:
          type:
          - object
          - 'null'
          description: '`{ apex, www }` for an apex or www domain, else `{ primary }`.'
          additionalProperties: true
        variants:
          type: array
          items:
            $ref: '#/components/schemas/DomainVariant'
        allowance:
          $ref: '#/components/schemas/Allowance'
          description: The owner's custom-domain meter; null when no plan can be resolved.
        noop:
          type: boolean
        detachFailures:
          type: array
          items:
            type: object
            additionalProperties: true
        available:
          type: boolean
        reason:
          type: string
        message:
          type: string
      required:
      - id
      - domain
      additionalProperties: true
    DomainVariant:
      type: object
      description: One hostname of the domain pair and its Vercel and DNS state.
      properties:
        name:
          type: string
        attachedToPagehub:
          type: boolean
        available:
          type: boolean
        redirect:
          type:
          - string
          - 'null'
        redirectStatusCode:
          type:
          - integer
          - 'null'
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
        misconfigured:
          type: boolean
        live:
          type: boolean
        records:
          type: array
          items:
            type: object
            additionalProperties: true
        configError:
          type: string
      required:
      - name
      - attachedToPagehub
      - available
      additionalProperties: true
    Allowance:
      type: object
      description: How much of the owner's plan cap is used.
      additionalProperties: true
    ApiError:
      type: object
      description: The error body of the management routes. The content API uses `Error` instead.
      properties:
        error:
          type: string
          description: A message, or a code such as `version_conflict`, `lint`, `maintenance`, `site_format_changed`.
        message:
          type: string
        code:
          type: string
        upgrade:
          type: boolean
          description: True when the plan is the reason.
      required:
      - error
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `ph_` API key (a user's key, or a tenant's).
    tenantAuthToken:
      type: apiKey
      in: header
      name: x-pagehub-auth
      description: The tenant's token, sent by PageHub on every webhook call so the tenant can check the request came from PageHub.