Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Redfish API Reference

Overview

SmartForge implements the DMTF Redfish specification v1.19.0 for industry-standard RESTful manageability.

Base URL

http://localhost:8080/redfish/v1

Interactive API Documentation

Available Resources

  • ServiceRoot: /redfish/v1
  • Systems: /redfish/v1/Systems/{id}
  • Chassis: /redfish/v1/Chassis/{id}
  • Managers: /redfish/v1/Managers/{id}
  • Sessions: /redfish/v1/SessionService
  • Accounts: /redfish/v1/AccountService
  • Tasks: /redfish/v1/TaskService
  • Events: /redfish/v1/EventService
  • Updates: /redfish/v1/UpdateService

Quick Examples

Get Service Root

curl http://localhost:8080/redfish/v1/

Get System Information

curl http://localhost:8080/redfish/v1/Systems/1

Power On System

curl -X POST http://localhost:8080/redfish/v1/Systems/1/Actions/ComputerSystem.Reset \
  -H "Content-Type: application/json" \
  -d '{"ResetType": "On"}'