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

# Read a shared health dashboard

> Returns the fault list associated with a shared health-dashboard token.



## OpenAPI

````yaml /api/en/faults.yaml get /fault/token/{id}
openapi: 3.0.3
info:
  title: Altostrat Faults API
  version: 1.0.0
  description: >-
    Query, resolve, and share SDX fault data through the public `/fault` gateway
    path. Use query parameters on `/fault` for site-specific and recent fault
    views.
servers:
  - url: https://v1.api.altostrat.io
    description: Production API Server
security:
  - BearerAuth: []
tags:
  - name: Faults
    description: Manage and retrieve fault records.
  - name: Comments
    description: Add comments to existing faults.
  - name: Analytics
    description: Access aggregated fault data and reports.
  - name: Access Tokens
    description: Generate temporary access tokens.
paths:
  /fault/token/{id}:
    get:
      tags:
        - Access Tokens
      summary: Read a shared health dashboard
      description: Returns the fault list associated with a shared health-dashboard token.
      operationId: getFaultDashboardByToken
      parameters:
        - name: id
          in: path
          required: true
          description: The shared dashboard token.
          schema:
            type: string
      responses:
        '200':
          description: Faults visible to the token.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Fault'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Fault:
      type: object
      description: >-
        The `Fault` object represents a detected issue or event within the
        network.
      properties:
        id:
          type: string
          description: A unique identifier for the fault object, prefixed with `flt_`.
          example: flt_31pkd1t8FvW7qZv0jG2a9kH5mB1
        resource_id:
          type: string
          description: The unique identifier of the resource that experienced the fault.
          example: dev_2j4k2l2j3k4l2j3k4
        customer_id:
          type: string
          description: The unique identifier of the customer account this fault belongs to.
          example: cus_1i2j3k4l5m6n7o8p
        microservice_id:
          type: string
          description: The identifier of the microservice that reported the fault.
          example: wantunnel-monitor
        type:
          type: string
          description: The category or type of the fault.
          example: wantunnel
        status:
          type: string
          description: The current status of the fault.
          enum:
            - unresolved
            - resolved
          example: unresolved
        severity:
          type: string
          description: The severity level of the fault.
          enum:
            - LOW
            - MEDIUM
            - HIGH
            - CRITICAL
            - WARNING
          example: CRITICAL
        message:
          type: string
          description: A concise, human-readable summary of the fault.
          example: 'WAN link failover: Primary link (WAN1) is down'
        cause:
          type: string
          description: A detailed explanation of the probable cause of the fault.
          example: 'Probe failed: Latency exceeded 500ms threshold'
        created_at:
          type: string
          format: date-time
          description: The timestamp when the fault was first detected and created.
          example: '2025-10-21T12:00:00.000000Z'
        resolved_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            The timestamp when the fault was resolved. Null if the fault is
            still active.
          example: null
        resource_ancestry_path:
          type: string
          nullable: true
          description: >-
            A pipe-delimited `|` string representing the hierarchical location
            of the resource, used for filtering faults by a parent resource
            (e.g., a specific site).
          example: site_8a7b6c5d4e3f2g1h|dev_2j4k2l2j3k4l2j3k4
        ttl:
          type: integer
          nullable: true
          description: >-
            A Unix timestamp indicating when the fault record will automatically
            expire from the database.
          example: 1797825595
        comments:
          type: array
          description: >-
            A list of comments associated with the fault, ordered from oldest to
            newest.
          items:
            $ref: '#/components/schemas/Comment'
    Comment:
      type: object
      description: A comment added to a fault object.
      properties:
        user_id:
          type: string
          description: The unique identifier of the user who added the comment.
          example: user_a1b2c3d4e5f6g7h8
        comment:
          type: string
          description: The text content of the comment.
          example: Contacted ISP, they are investigating a local outage.
        created_at:
          type: string
          format: date-time
          description: The timestamp when the comment was created.
          example: '2025-10-21T12:05:30.000000Z'
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_missing
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The 'resource_id' parameter is required for this request.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_missing
  responses:
    NotFound:
      description: Not Found - The requested resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: invalid_request_error
            code: resource_missing
            message: 'No such fault: ''flt_xxxxxxxxxxxxxxxxxxxxxxxxxx'''
            doc_url: https://docs.altostrat.io/errors/resource_missing
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        API requests are authenticated using a JSON Web Token (JWT) provided in
        the `Authorization` header.

````