Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,293,827
Community Members
 
Community Events
165
Community Groups

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

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
TAGS
Community showcase
Published in Off-topic

Don't F&*% the planet.

Over the weekend, Atlassian ran a New York Times ad calling on business leaders to join us in committing to a net zero future through the Science-Based Targets Initiative. As part of our gl...

1,175 views 6 39
Read article

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