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

# Search articles

> Ranked search over active articles, the same ranking the site search uses. Returns up to the best matches with a text snippet. Not paginated.

**Permission:** `modules.knowledgebase.articles.read`



## OpenAPI

````yaml /docs/modules-api.yaml get /application/modules/knowledgebase/search
openapi: 3.1.0
info:
  title: Spartan Module API
  version: '2026.11'
  description: >-
    Endpoints added by modules. Key endpoints live under
    `/api/application/modules/<module>/` and need an API key with the module
    permission. Content modules (Blog, News, Knowledge Base, Status) also offer
    keyless read only endpoints under `/api/public/modules/<module>/` that only
    return what an anonymous visitor can see.
servers:
  - url: https://{domain}/api
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Blog
  - name: Blog (public)
  - name: News
  - name: News (public)
  - name: Knowledge Base
  - name: Knowledge Base (public)
  - name: Status
  - name: Status (public)
  - name: Forms
  - name: Affiliates
  - name: Deprecated endpoints
paths:
  /application/modules/knowledgebase/search:
    get:
      tags:
        - Knowledge Base
      summary: Search articles
      description: >-
        Ranked search over active articles, the same ranking the site search
        uses. Returns up to the best matches with a text snippet. Not paginated.


        **Permission:** `modules.knowledgebase.articles.read`
      operationId: searchKnowledgeBase
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
            maxLength: 255
            minLength: 2
          description: Search text.
          example: server
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KnowledgeBaseSearchResult'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  - id: 64
                    title: The MCP server for AI assistants
                    slug: mcp-server
                    url: >-
                      https://billing.example.com/knowledgebase/modules-integrations/mcp-server
                    description: >-
                      Let an AI assistant read and manage Spartan through
                      scoped, logged tokens.
                    snippet: >-
                      ...you choose. Go to Developers, then MCP server. Tokens
                      here only work against the MCP endpoint, and every token
                      starts with no tools at all. The top of the page Tool
                      calls today...
                    category:
                      id: 13
                      name: Modules and Integrations
                      slug: modules-integrations
                  - id: 57
                    title: Proxmox, VirtFusion, cPanel, Plesk and HestiaCP modules
                    slug: vps-web-hosting-modules
                    url: >-
                      https://billing.example.com/knowledgebase/modules-integrations/vps-web-hosting-modules
                    description: >-
                      What each virtual server and web hosting module creates
                      and what you set up before selling with it.
                    snippet: >-
                      ...modules turn a paid order into a virtual server or a
                      hosting account. Turn the one you need on under
                      Integrations, Modules, Services, then open its Settings.
                      Each one connects...
                    category:
                      id: 13
                      name: Modules and Integrations
                      slug: modules-integrations
                meta:
                  request_id: 8d59600d-14a1-4051-8212-f3abb2a2ffbb
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                validation_failed:
                  summary: Query too short
                  value:
                    error:
                      code: validation_failed
                      message: The request data is invalid.
                      details:
                        q:
                          - The q field must be at least 2 characters.
                    request_id: 74444d94-3e07-4898-9cfa-25acac898b61
components:
  schemas:
    KnowledgeBaseSearchResult:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        slug:
          type: string
        url:
          type: string
          format: uri
        description:
          type:
            - string
            - 'null'
        snippet:
          type: string
          description: Plain text excerpt around the first match.
        category:
          $ref: '#/components/schemas/KnowledgeBaseCategoryReference'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    ValidationError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
              description: Always `validation_failed`.
            message:
              type: string
              description: Always `The request data is invalid.`
            details:
              type: object
              properties: {}
              description: >-
                Map of field name to a list of messages. Nested fields use dot
                notation, for example `ticket_ids.0`.
              additionalProperties:
                type: array
                items:
                  type: string
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: Request id.
      description: Returned with HTTP 422 when the body or query string fails validation.
      required:
        - error
        - request_id
    KnowledgeBaseCategoryReference:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 6bf04242-ac61-44b9-9dbf-b63a114b54c8
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

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