It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How should I create page with markdown content by using REST API ?

HI, I want  to sync my docs into  Confluence server and all docs are written by markdown . I install a markdown plugin named bobswift-markdown on Confluence

I plan to develop a script tool and create page by invoking Confluence REST API .


I have read the doc  and the doc

But I still don't know how to create a page with markdown content .

Is there any documents or examples ?

3 answers

1 accepted

Hi @chengjingtao 

Hope you are doing good.

We have tested your requirement internally which you want to update/create a page with the Markdown content document into confluence. This can be achieved by using Confluence Command Line Interface(CLI) app.

Here is the examples page for run the actions.

Run the following command to copy the documents from your local system to Confluence.

--action storePage --space "zclimarkdown" --title "markdown readme with toc" --parent "@home" --file "./src/itest/confluence/resources/readme-flexmark.markdown" --markdown

Please let us know if you need any further assistance.



Thanks for your reply.

I have tried `Confluence Command Line Interface (CLI) app` and it works well when use action of storePage.

And I have also tried action of loadFiles.

But I am confusing about that how should I specify `mime`.  Becuase CLI always treat my `.md` file as attachments.  It cannot works well with options `--mime text/markdown`.

Hi @chengjingtao 

Normally, Markdown files must have the right mime type set to work correctly.

Are you running the CLI command as below (md files will copy the contents of the file and store as the contents in the page)
--action storePage --space "zmarkdown" --title "markdown" --parent "@home" --file "" --markdown
Can you confirm if all your files are with extensions, md?



Hi @chengjingtao 

Hope you are doing great!

As we didn't get any response from you and there is no outstanding activity on this ticket, we are marking this support ticket as resolved for now.

Please feel free to reopen or add a comment to this ticket if desired, or open a new ticket. We will be happy to reconnect with you!

Thank you!


I am sorry to reply so late.

My original problem has been resolved, you could mark this support ticket as resolved.

I will open a new ticket for my new problem, Thanks again.

Thank you for your reply and please report any Bobshwift related issue via and Wittified related issues via



Hi @chengjingtao 

Markdown for Confluence provides macros that render Markdown content on Confluence pages. The content can be entered directly in the body of a the markdown macro or be from an attachment or url. Markdown content is processed using flexmark which supports a version of the Markdown language with many popular extensions including Github-flavored-Markdown (GFM), PHP Markdown Extra, and wiki links.
Its features include Render Markdown content on Confluence pages, Pull-in Markdown content from multiple sources and Easily link to other pages with WikiLinks.

You can review the documentation on the below links.
We are sorry to inform you that the behavior of our app is not meant to be used with the REST API.


Suggest an answer

Log in or Sign up to answer
Community showcase
Posted in Confluence

What project did you transition or start on Confluence with the shift to remote work?

It’s been great to hear from fellow users over the last few weeks about the best tips and fun moments you’ve had working on Confluence since the transition to working remote. I’d love to keep the c...

109 views 3 7
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you