Importing REST API Specs into Postman

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.

Problem

When testing the Atlassian cloud developer documentation REST API endpoints, we're sometimes at a loss as to what and how parameters/payloads are to be populated. It's usually done on a trial-and-error basis, resulting in a waste of time and effort, until we succeed.

Diagnosis

Environment

  • Atlassian, Jira, Confluence

Diagnostic Steps

  • NA

Cause

NA

Workaround

NA

Resolution

Refer to the screenshots below with explanations:

  • Go to your desired REST API and get its OpenAPI spec URL

  • In Postman, click on Collections, Import, Enter the OpenAPI spec URL and press Continue


  • Click Import


  • You can now use the pre-filled endpoint with sample fields filled


DescriptionImport REST API Specs into Postman
ProductAtlassian, Jira, Confluence

Last modified on Jun 1, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.