New to Confluence REST API

Hi all, just introducing myself. I recently have started tackling the problem of keeping documentation up to date against external sources at my work and have been delving into the Confluence REST API for that purpose. I'm relatively new to programming in general, so looking to learn a ton here.

1 comment

Craig Castle-Mead Community Champion Mar 10, 2018

Hey Jeremiah,

Step 1 - bookmark the relevant REST documentation page - you'll be visiting them frequently! Server and Cloud

Step 2 - get a tool like https://www.getpostman.com/ so you can easily trigger requests

While the documentation is quite in depth, I personally often start by viewing the actual calls that are made while interacting with the application itself. In Chrome, this is under Developer Tools > Network (https://developers.google.com/web/tools/chrome-devtools/network-performance/reference) it will show you all of the HTTP(s) requests being made by the browser. If you then filter to XHR (one of the buttons with ALL | XHR | JS | Img | Media etc). Any rest calls should show up under the XHR filter - you'll then be able to see what calls were made, what HTTP method is being used (GET, POST, DELETE etc) and see the JSON payloads that are submitted etc. It will also show you the responses received. I'll often start by spying on this real world traffic, triggering an action similar to what I want to achieve, look at the call - try and replicate and/or check the documentation for that REST endpoint for further options.

CCM

Comment

Log in or Sign up to comment
Community showcase
Posted Friday in Off-topic

Friday Fun: Dry T-Shirt Competition - What's your BEST (Atlassian) T-Shirt!?

[Note: So it was my turn for Friday Fun and sadly I was sick thanks to rubbish sinus infection... so apologies to most of Europe and Asia for the delayed post. However, I finally got out of bed for t...

204 views 14 4
Join discussion

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you