Markdown Importer REST API

A GitHub Actions step publishing a page through the API

The Markdown Importer REST API allows you to programmatically import markdown content into Confluence pages. This feature is designed for automation workflows, CI/CD pipelines, bulk migrations, and custom integrations.

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

Explore the REST API documentation:

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

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

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

GitHub Actions

To publish a docs folder on every push, use the open source confluence-markdown-sync Action. See Examples for the workflow step.

Support

Support Portal: https://yamuno.atlassian.net/servicedesk/customer/portals
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