Postman is an API development tool that allows you to quickly and easily create and execute API requests and examine the responses for web service APIs like OctopusAPI. It provides a great way to experiment with and learn about the OctopusAPI without having to write a single line of code.
To help you get started with the OctopusAPI, this repository contains a series of Postman collections that provide example requests for the OctopusAPI.
If you aren't already using Postman, you can download it here. Before getting started with the OctopusAPI collection, take a moment to browse the introductory Postman documentation, especially the instructions for how to send your first request and how to use collections.
Once you have Postman installed on your machine, click here to download the source for the OctopusAPI collections.
In order to use the collections, you will need to create an Environment in Postman to store your OctopusAPI URL and credentials.
To set up your Postman environment:
- In the Postman toolbar, click Import.
- Browse and select the starter environment in the
postman/environmentsfolder that you downloaded above. - Click the "Manage Environments" button (the gear icon in the upper-right corner of the Postman window).
- Click the name of the "OctopusAPI" environment that you imported.
- Update the values of each of the environment variables in the list and save your changes. Each of the environment variables and their expected values are described below.
Now you're ready to import a collection and start making requests.
The collections can be found in the postman/collections directory, and are organized by entity type or by related functionality.
To import a collection into Postman:
- In the Postman toolbar, click Import.
- Browse to and select the
OctopusAPI.jsoncollection in thepostman/collectionsfolder that you downloaded above. - Expand the
OctopusAPIcollection and folder in the left panel of Postman.