REST API

Note: The REST API currently supports importing only. Export functionality via API is not yet available and must be done through the UI.

​

Key Features

• Secure Authentication: JWT-based token authentication
• Automatic Conversion: Markdown to Confluence ADF (Atlas Document Format)
• Conflict Handling: Create new pages or update existing ones
• License Validation: Tied to your active Confluence license
• Audit Logging: Complete request logging for security and debugging

​

Prerequisites

• Active Markdown Importer for Confluence license
• Admin access to Confluence global settings
• HTTPS-enabled environment for secure API calls

​

Documentation Sections

• Getting Started - Set up API tokens and make your first request
• Authentication - Token management and security
• API Reference - Endpoints, request/response formats
• Limitations - API usage limits and constraints
• Examples - Code samples in multiple languages
• Best Practices - Security, performance, and error handling
• Troubleshooting - Common issues and solutions
• FAQ - Frequently asked questions

​

Quick Start

1. Navigate to Confluence Settings → Apps → Markdown Importer for Confluence → API tab
2. Click Create New Token and configure expiration
3. Copy your token (you won’t see it again!)
4. Make your first API request:

curl -X POST "YOUR_API_ENDPOINT" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "spaceId": "DOCS",
    "parentId": "123456789",
    "pageTitle": "My First API Page",
    "content": "# Hello World\n\nThis is my first API-created page!",
    "overwrite": false
  }'

​

Support

• Support Portal: https://yamuno.atlassian.net/servicedesk/customer/portal/2/group/2/create/51
• Product Documentation: https://yamuno.com/docs/markdown-importer-for-confluence
• Marketplace: https://marketplace.atlassian.com/apps/1231894/markdown-importer-for-confluence?hosting=cloud&tab=overview

• Document Version: 1.0
• Last Updated: 2025-10-07
• Product: Markdown Importer for Confluence