> ## 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.

# Update a status page surface

> Rename, describe or move a surface. A surface's status changes only through report updates.



## OpenAPI

````yaml /openapi.json patch /status-pages/{statusPageId}/surfaces/{surfaceId}
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/{surfaceId}:
    patch:
      tags:
        - StatusPages
      summary: Update a status page surface
      description: >-
        Rename, describe or move a surface. A surface's status changes only
        through report updates.
      operationId: statusPages.surfaces.update
      parameters:
        - name: statusPageId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
            description: Status page ID (UUID) or slug.
        - name: surfaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                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'
                position:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                showUptime:
                  type: boolean
      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.