Postman Collection of Bare Metal Cloud APIs

Interact with Bare Metal Cloud (BMC) APIs using your favorite API management and testing tool.

Bare Metal Cloud • BMC Collection on Postman • Developers Portal • Knowledge Base • Support

Requirements

• Bare Metal Cloud (BMC) account - Get Started
• Postman account / locall installation of Postman - View Instructions

Creating a Bare Metal Cloud account

1. Go to the Bare Metal Cloud signup page.
2. Follow the prompts to set up your account.
3. Use your credentials to log in to Bare Metal Cloud portal.

▶️ Video tutorial: How to Create a Bare Metal Cloud Account in Minutes

▶️ Video tutorial: How to Deploy a Bare Metal Server in a Minute

Creating Postman Account

To use Postman on the desktop, download the app and launch it.

Alternatively, navigate to Postman on the web at go.postman.co/home.

You will see a prompt to log in or sign up. Follow the steps outlined here to create an account.

Using BMC Postman Collection

The Postman Collection of BMC APIs lets you easily trigger and test API calls to view your BMC server status, billing information, audit logs, networks, and tags. It is automatically updated on GitHub with every change we make to our APIs, so you always have the access to the latest version.

Deployment steps:

1. Download Collection from https://github.com/phoenixnap/postman-collection-bmc.
2. Import the collection into Postman.
3. Set up two enviorment variables: clientId and clientSecret.
   
   • Go to your Bare Metal Cloud acount and create Client Credentials with wanted scopes. Refer to the section below for detailed instructions on how to do it.
     
   • Click Manage Enviornments in the top right corner of Postman inerface.
     
   • Add two new environments with variables clientId (for Client ID) and clientSecret (for Client Secret) that you fetched from step BMC portal.
     
   • Save the environment and select it in the environment drop down menu
     
4. The Collection can now be used to make or test API calls.

Authorization steps:

1. Go to Collection.
2. Click on the 3 dots button icon or right click the item.

3. Go to Edit.
4. Go to Authorization.

5. Click the Get New Access Token button.
6. Click Update.
7. You have generated a token that will be inherited by the individual calls. Repeat the process only for when the token expires.

💡 Parameters and Body Requests are provided as an example in all requests. They need to be changed to reflect your own use.
💡 Environment variables you created for BMC credentials will not be deleted when you update the collection, even though everything else will be refreshed.

Creating BMC Credentials

Creating BMC Client ID and Client Secret takes several simple steps.

1. Log in to your BMC account at bmc.phoenixnap.com.
2. Choose API Credentials from the left side menu.

3. Click Create API Credentials to open a dialogue where you will enter Credential name and Credential description.

4. Select the Credentials scope and click Create.
5. Your Client ID and Client Secret have been created. You can copy them and add them to Postman as clientId and clientSecret for authorization.

Bare Metal Cloud community

Become part of the Bare Metal Cloud community to get updates on new features, help us improve the platform, and engage with developers and other users.

• Follow @phoenixNAP on Twitter
• Join the official Slack channel
• Sign up for our Developers Monthly newsletter

Resources

• Product page
• Instance pricing
• YouTube tutorials
• Developers Portal
• Knowledge Base
• Blog

Documentation

• Postman Website - phoenixNAP
• API documentation

Contact phoenixNAP

Get in touch with us if you have questions or need help with Bare Metal Cloud.

Twitter • Facebook • LinkedIn • Instagram • YouTube • Email