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

# Create a status page surface

> Add a surface (a public row, such as API) to a status page.



## OpenAPI

````yaml /openapi.json post /status-pages/{statusPageId}/surfaces
openapi: 3.1.1
info:
  title: Sazabi Public API
  version: 1.0.0
  description: >
    Public REST API for Sazabi. Authenticate using a secret API key in the
    Authorization header.


    ## Pagination


    This API uses two pagination strategies depending on the endpoint type:


    ### Cursor-Based Pagination (List Endpoints)


    List endpoints (threads, messages, keys) use cursor-based pagination for
    efficient, consistent results:


    - **Parameters**: `limit` (items per page, default 50, max 100), `cursor`
    (opaque pagination token)

    - **Response**: Includes `nextCursor` field - pass this as `cursor` in the
    next request

    - **End of results**: When `nextCursor` is `null`, there are no more results

    - **Example**: `GET
    /v1/threads?limit=20&cursor=01234567-89ab-cdef-0123-456789abcdef`


    ### Page-Based Pagination (Search Endpoints)


    Search endpoints use page-based pagination due to the underlying search
    engine:


    - **Parameters**: `limit` (items per page, default 20, max 100), `page`
    (1-indexed page number)

    - **Response**: Includes `pagination` object with `page`, `limit`,
    `totalResults`, `totalPages`

    - **Example**: `GET /v1/search/threads?q=error&limit=10&page=2`
servers:
  - url: https://api.sazabi.com/v1
    description: Production
security: []
paths:
  /status-pages/{statusPageId}/surfaces:
    post:
      tags:
        - StatusPages
      summary: Create a status page surface
      description: Add a surface (a public row, such as API) to a status page.
      operationId: statusPages.surfaces.create
      parameters:
        - name: statusPageId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
            description: Status page ID (UUID) or slug.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  pattern: ^[a-z0-9](?:[a-z0-9._-]{0,62}[a-z0-9])?$
                  description: >-
                    Stable key of a section or surface, unique within the page:
                    lowercase letters, digits, '.', '_' and '-'.
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                description:
                  anyOf:
                    - type: string
                      maxLength: 500
                    - type: 'null'
                  description: Short text shown under the surface's name.
                sectionId:
                  anyOf:
                    - type: string
                      format: uuid
                    - type: 'null'
                  description: Section to place the surface in; omit for the top level.
                position:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                showUptime:
                  type: boolean
              required:
                - key
                - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  surface:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      key:
                        type: string
                      name:
                        type: string
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      sectionId:
                        anyOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        description: >-
                          Section the surface sits in, or null at the page's top
                          level.
                      position:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      showUptime:
                        type: boolean
                      status:
                        enum:
                          - operational
                          - degraded_performance
                          - partial_outage
                          - major_outage
                          - under_maintenance
                        type: string
                        description: >-
                          A surface's current status: the worst impact named by
                          the latest published update of each open published
                          report, else operational.
                    required:
                      - id
                      - key
                      - name
                      - description
                      - sectionId
                      - position
                      - showUptime
                      - status
                required:
                  - surface

````

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