> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentivel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set a status page's custom domain

> Attach a custom domain (e.g. `status.example.com`), replacing any the page already has, then check it. The page is served there only once DNS points at Sentivel and ownership is verified with the page's `_sentivel-challenge` TXT record. The response lists the exact DNS records to create. Custom domains are on every plan.



## OpenAPI

````yaml https://www.sentivel.com/api/v1/openapi.json put /status-pages/{id}/custom-domain
openapi: 3.1.0
info:
  title: Sentivel API
  version: 1.0.0
  description: >-
    Provision and read your Sentivel workspace programmatically: components,
    monitors, status pages, incidents, maintenance windows, on-call schedules,
    integrations and members. Authenticate with an org API token (Developers →
    API tokens in the dashboard), a personal access token (Account →
    Connections) or an OAuth access token from a connected app.
  contact:
    name: Sentivel
    url: https://www.sentivel.com
servers:
  - url: https://www.sentivel.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Identity
    description: Who the token is
  - name: Components
    description: Status-page components (status units)
  - name: Monitors
    description: Uptime/HTTP checks
  - name: Status pages
    description: Public status pages
  - name: Incidents
    description: Incidents (read + manual create)
  - name: People
    description: Workspace members
  - name: Integrations
    description: Outbound alert destinations
  - name: On-call
    description: On-call schedules
  - name: Maintenance
    description: Scheduled maintenance windows
paths:
  /status-pages/{id}/custom-domain:
    put:
      tags:
        - Status pages
      summary: Set a status page's custom domain
      description: >-
        Attach a custom domain (e.g. `status.example.com`), replacing any the
        page already has, then check it. The page is served there only once DNS
        points at Sentivel and ownership is verified with the page's
        `_sentivel-challenge` TXT record. The response lists the exact DNS
        records to create. Custom domains are on every plan.
      operationId: setStatusPageCustomDomain
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDomainSet'
      responses:
        '200':
          description: The domain's state after attaching.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomDomainStatus'
        '400':
          description: Not a valid hostname, or a sentivel.com address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such status page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The domain is in use on another status page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CustomDomainSet:
      type: object
      required:
        - domain
      properties:
        domain:
          type: string
          maxLength: 253
          description: Hostname, e.g. `status.example.com`. A scheme or path is stripped.
    CustomDomainStatus:
      type: object
      properties:
        domain:
          type: string
          nullable: true
        verified:
          type: boolean
          description: 'Ownership and DNS confirmed: the page is routed on this host.'
        live:
          type: boolean
          description: The page answers over HTTPS on the domain.
        records:
          type: array
          description: The DNS records to create at the domain's DNS provider.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - CNAME
                  - A
                  - TXT
              name:
                type: string
              value:
                type: string
        note:
          type: string
          nullable: true
          description: What is still outstanding, when the domain isn't live.
        provisionError:
          type: string
          nullable: true
          description: 'Set only by PUT: why registering the domain for HTTPS failed.'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - internal
            message:
              type: string
            details:
              type: object
          required:
            - code
            - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Sent as `Authorization: Bearer <token>`. Three kinds are accepted: an
        ORG token (`sv_…`), bound to one workspace with a fixed role; a PERSONAL
        token (`svu_…`), which acts as you with your own live role in whichever
        workspace it is pointed at; and an OAUTH access token (`mcp_at_…`) from
        a connected app, limited to the workspaces you granted it. A personal or
        OAuth token names its workspace with the `X-Sentivel-Workspace` header
        (a slug or an id). Without it an OAuth token falls back to the
        connection's primary workspace, while a personal token in more than one
        workspace is rejected `400 invalid_request` with the choices in
        `error.details.workspaces`. An org token sent with a header naming a
        different workspace is rejected `400 invalid_request`. Membership is
        re-read every request, so leaving a workspace or revoking the grant
        takes effect at once.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.