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

# Search Altostrat Documentation

> Use this endpoint to integrate Altostrat's official help and developer documentation search directly into your tools. It's designed to provide quick answers and code references, helping developers resolve issues and build integrations faster.



## OpenAPI

````yaml /api/en/search.yaml get /search/docs
openapi: 3.0.3
info:
  title: Altostrat Search API
  version: 1.0.0
  description: >-
    The Altostrat Search API provides a unified, multi-tenant interface for
    querying indexed entities and documentation across the entire SDX platform.

    It acts as a centralized discovery layer, allowing developers to find any
    resource—from network configurations and automation scripts to support
    tickets and user guides—without needing to query individual microservices.

    This API allows you to programmatically manage:

    - **Entity Search:** Query for any indexed resource within your organization
    or a specific workspace. Results are tenant-aware, ensuring data isolation.

    - **Documentation Search:** Perform targeted searches against Altostrat's
    official developer documentation and API reference guides.

    Developers use this API to build powerful, context-aware search experiences
    directly into their applications and integrations, accelerating resource
    discovery for end-users.
servers:
  - url: https://v1.api.altostrat.io
    description: Altostrat Production API Server
security: []
tags:
  - name: Entity Search
    description: >-
      Endpoints for searching platform-wide entities like devices,
      configurations, and documents.
  - name: Documentation Search
    description: >-
      Endpoints for searching the official Altostrat developer documentation and
      API reference.
paths:
  /search/docs:
    get:
      tags:
        - Documentation Search
      summary: Search Altostrat Documentation
      description: >-
        Use this endpoint to integrate Altostrat's official help and developer
        documentation search directly into your tools. It's designed to provide
        quick answers and code references, helping developers resolve issues and
        build integrations faster.
      operationId: searchDocumentation
      parameters:
        - name: q
          in: query
          required: true
          description: The search query string for finding relevant documentation.
          schema:
            type: string
            maxLength: 255
          example: MikroTik BGP configuration
        - name: limit
          in: query
          required: false
          description: The maximum number of search results to return.
          schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 10
          example: 5
        - name: include_content
          in: query
          required: false
          description: >-
            If true, the response will include a snippet of the matching content
            from the document.
          schema:
            type: boolean
            default: false
          example: true
      responses:
        '200':
          description: A list of matching documentation pages.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocSearchResult'
        '400':
          description: >-
            Bad Request - The request was malformed or the 'q' parameter was
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - The request is missing a valid authentication token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but contained
            semantic errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error - Something went wrong on our end.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    DocSearchResult:
      type: object
      properties:
        title:
          type: string
          description: The title of the documentation page.
          example: Configuring BGP on MikroTik
        description:
          type: string
          description: The summary or meta description of the page.
          example: >-
            A step-by-step guide to setting up BGP peering sessions on MikroTik
            RouterOS.
        type:
          type: string
          enum:
            - api
            - doc
          description: >-
            The type of documentation. `api` for API reference, `doc` for guides
            and articles.
          example: doc
        href:
          type: string
          format: uri
          description: The full URL to the documentation page.
          example: https://altostrat.io/docs/networking/bgp-mikrotik
        content:
          type: string
          description: >-
            A snippet of the page content that matches the search query. Only
            included if `include_content=true`.
          example: >-
            ...to establish a BGP session, you must first define a remote peer
            with the correct ASN...
    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 'q' 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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Enter your bearer token in the format: Bearer {token}'

````