Folio API

openapi: 3.1.0
info:
  title: Folio API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 8 operation(s) read from 11 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Folio has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 7
    documentation: 1
    pages-with-code: 10
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://foliowiki.online/templates/api-reference
  - https://foliowiki.online/install
  - https://foliowiki.online/tools/confluence-to-markdown
  - https://foliowiki.online/integrations/claude
  - https://foliowiki.online/integrations/chatgpt
  - https://foliowiki.online/install/vps
  - https://foliowiki.online/install/coolify
  - https://foliowiki.online/install/digitalocean
  - https://foliowiki.online/install/dokploy
  - https://foliowiki.online/install/portainer
  - https://foliowiki.online/templates/design-doc
servers:
- url: https://demo.foliowiki.online
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://foliowiki.online/install/vps
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl. For HTTPS: a domain whose DNS A record points at the server, and ports 80 and 443 open. Steps 1 Step 1 : Install Docker
          Engine with the Compose plugin if the server does not have it yet. bash Copy curl -fsSL https://get.docker.com | sh 2 Step 2 : Run the
          installer. It asks for a domain. An empty answer means plain http on the server''s IP, for a trial. bash Copy curl -fsSL https://raw.githubu'
  /api/health:
    get:
      operationId: get_api_health
      tags:
      - Api
      summary: GET /api/health
      x-source: https://foliowiki.online/install/vps
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: fetch('http://127.0.0.1:4870/api/health')
  /evergreen-it-dev/folio/main/deploy/vps/install.sh:
    get:
      operationId: get_evergreen_it_dev_folio_main_deploy_vps_install_sh
      tags:
      - Evergreen It Dev
      summary: GET /evergreen-it-dev/folio/main/deploy/vps/install.sh
      x-source: https://foliowiki.online/install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -fsSL https://raw.githubusercontent.com/evergreen-it-dev/folio/main/deploy/vps/install.sh | bash Details, options, updates
          and backups are on the Linux server page . Not ready to install? Try the public demo: https://demo.foliowiki.online . Pick Sam on the
          sign-in screen. The login is shared and the data resets every 24 hours, so don''t enter personal data or API keys. Open the demo What
          Folio'
  /mcp:
    post:
      operationId: post_mcp
      tags:
      - Mcp
      summary: POST /mcp
      x-source: https://foliowiki.online/integrations/claude
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -si -X POST https://your-folio.example.com/mcp  -H ''content-type: application/json'' -d ''{}'' | head -8 2 Step 2 : In
          Claude on the web or in Claude Desktop, open Customize, then Connectors. Click the plus, then Add custom connector. On Team and Enterprise
          an Owner adds it under Organization settings, Connectors, Add, Custom, Web. Name it Folio and paste the address. Remote MCP server URL
          Copy '
  /rest/api/content/{pageid}:
    get:
      operationId: get_rest_api_content_pageid
      tags:
      - Rest
      summary: GET /rest/api/content/{pageId}
      x-source: https://foliowiki.online/tools/confluence-to-markdown
      parameters:
      - name: pageid
        in: path
        required: true
        schema:
          type: string
      - name: expand
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "Authorization: Bearer PAT"  "https://wiki.example.com/rest/api/content/PAGE_ID?expand=body.storage" The page body is
          in the value field of the JSON, with its quotes escaped. Paste the unescaped XML into the box above, or save an HTML export and choose
          the file. The requests are described in Atlassian''s REST API documentation for Cloud and Data Center . How do I export a whole Confluence
          s'
  /v1/me/quiet-hours:
    put:
      operationId: put_v1_me_quiet_hours
      tags:
      - Me
      summary: PUT /v1/me/quiet-hours
      x-source: https://foliowiki.online/templates/design-doc
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV1MeQuietHoursRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV1MeQuietHoursResponse'
      x-evidence:
        kind: documentation
  /v1/resources/{id}:
    get:
      operationId: get_v1_resources_id
      tags:
      - Resources
      summary: 'One sentence: what this endpoint does and when to use it.'
      x-source: https://foliowiki.online/templates/api-reference
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: expand
        in: query
        required: false
        schema:
          type: string
        description: Allowed values and what each does
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ResourcesIdResponse'
      x-evidence:
        kind: documentation
  /wiki/api/v2/pages/{pageid}:
    get:
      operationId: get_wiki_api_v2_pages_pageid
      tags:
      - Wiki
      summary: GET /wiki/api/v2/pages/{pageId}
      x-source: https://foliowiki.online/tools/confluence-to-markdown
      parameters:
      - name: pageid
        in: path
        required: true
        schema:
          type: string
      - name: body-format
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -u you@example.com:API_TOKEN  "https://your-site.atlassian.net/wiki/api/v2/pages/PAGE_ID?body-format=storage"
components:
  schemas:
    PutV1MeQuietHoursRequest:
      type: object
      properties:
        time_zone:
          type: string
          description: IANA time zone identifier, e.g., "Europe/Lisbon"
        days:
          type: array
          description: List of quiet‑hour entries per weekday
        days.weekday:
          type: integer
          description: Weekday number (0‑6, where 0 is Sunday)
        days.start:
          type: string
          description: Start time in HH:MM format
        days.end:
          type: string
          description: End time in HH:MM format
      required:
      - time_zone
      - days
      - days.weekday
      - days.start
      - days.end
    PutV1MeQuietHoursResponse:
      type: object
      properties:
        saved:
          type: boolean
          description: Indicates the quiet‑hours settings were saved
    GetV1ResourcesIdResponse:
      type: object
      properties:
        id:
          type: string
          description: '...'
        created_at:
          type: string
          description: ISO 8601 timestamp in UTC
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Evergreen It Dev
- name: Mcp
- name: Me
- name: Resources
- name: Rest
- name: Wiki