Skip to content

Disclaimer

Important Notice: Postman is a commercial software developed by Postman, Inc., with certain features requiring a paid subscription (e.g., advanced collaboration tools, enhanced automation testing). This tutorial covers the basic functionality of Postman’s free version. Please note the following:

  • Copyright and Usage Restrictions: Postman’s use is governed by its official Terms of Service. Users must comply with these terms, particularly when using Postman in a commercial environment, where appropriate licensing may be required.

  • Free Version Limitations: The free version of Postman is suitable for individual learning and small projects but has limitations (e.g., number of workspaces, API call limits). For advanced features, refer to the Postman pricing page.

  • Third-Party Content: This tutorial is provided for educational purposes only and is not endorsed by Postman, Inc. Always consult official Postman documentation for authoritative guidance and verify functionality in your specific use case.

  • Liability Disclaimer: This tutorial is not responsible for any direct or indirect damages resulting from the use of Postman. Ensure compliance with applicable laws and your organization’s policies when using Postman.

For more details, visit the Postman official website or contact the Postman support team.

Introduction

What is ERMI API?

ERMI API is a standardized RESTful API developed based on specifications from the Distributed Management Task Force (DMTF). It is designed specifically for managing hardware resources such as servers, storage devices, and networking equipment. Its key objectives include:

  • Replacing traditional IPMI with a more secure and modern management interface
  • Utilizing JSON format and HTTPS for data transmission, enabling easier integration and automation
  • Supporting remote management capabilities, including firmware updates, system reboots, and virtual media mounting

ERMI API using /redfish/v1/ as the root directory. Under this path, various resources are exposed—such as Systems, Managers, and SessionService—each of which can be accessed and manipulated using standard HTTP methods like GET, POST, and DELETE.

What is Postman?

Postman is a powerful API testing and development tool, in this session, we’ll use Postman to:

  • Authenticate with ERMI API and obtain a session token
  • Use the token to access protected endpoints
  • Demonstrate operations: GET Device Information

Setup

  • Install Postman setup-postmam

  • Download openapi.yaml from the API Reference. setup-download

  • Use Postman's Import feature to load the file. setup-import

Disable SSL Certificate Verification

Go to File > Settings > General alt text

Authenticating with ERMI API (Login)

login

  • create a POST request
  • in the url field, enter the ERMI module’s IP (e.g., 169.254.9.168)
  • configure the request Body
  • enter the login credentials (e.g., admin/ admin)
  • send the request, and grab the Session Token

login-s

Store the Token as a Variable in Postman

token

To streamline subsequent API calls, we recommend defining variables (e.g., Environment) based on your usage habits.

Calling Other APIs (Using Session)

The ERMI API follows a hierarchical structure. We recommend starting with a list query to identify the correct System ID. Once confirmed, you can use this ID to access detailed data from related endpoints.

We will use Computer System as an example to demonstrate how to retrieve information using Postman. Please follow the steps below.

alt text

  • GET: Retrieve the list of systems

  • Authorization: Ensure the baseUrl and apiKey is correctly set

  • Send Request: Execute the request and obtain the system ID (e.g.,1) from the response.

alt text

After that, we can call the Get a specific Computer System API by replacing :SystemId with 1 to retrieve the corresponding system details.

alt text

If you have any further questions about using the ERMI API, feel free to reach out via Support. We’ll be happy to assist you.