RECS|Box Redfish API v1.2.0
This is the documentation of the RECS|Box Redfish API v1.2.0.The entry point of this API (and any Redfish API) is the ServiceRoot. One should start exploring at that Schema.
In case of an error, the API will respond with an HTTP status code as defined by the Redfish standard.
In addition to that, an error description will be returned in the format described in the Error schema.
Referenced Versions
- DMTF Redfish Scalable Platforms Management API Specification 1.4.0
- DMTF Redfish Schema Version 2017.3
Schema Definitions
Endpoint Definitions
Resource | URI |
---|---|
Baseboard | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID} |
BaseboardCollection | /redfish/v1/Baseboards /redfish/v1/Chassis/{ChassisID}/Baseboards |
Chassis | /redfish/v1/Chassis/{ChassisID} |
ChassisCollection | /redfish/v1/Chassis |
ComposedNode | /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID} |
ComposedNodeCollection | /redfish/v1/ComposedNodes /redfish/v1/Chassis/{ChassisID}/ComposedNodes |
ComputerSystem | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID} |
ComputerSystemCollection | /redfish/v1/Systems /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems |
EthernetInterface | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/EthernetInterfaces/{EthernetInterfaceID} |
EthernetInterfaceCollection | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/EthernetInterfaces |
HSLLConnection | /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID}/{HSLLConnectionSetID}/{HSLLConnectionID} |
HSLLConnectionSet | /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID}/{HSLLConnectionSetID} |
HSLLInterface | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/Ports/{PortID}/HSLLInterface /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/HSLLInterface /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/PCIeDevices/{PCIeDeviceID}/HSLLInterface |
JsonSchemaFile | /redfish/v1/JsonSchemas/{JsonSchemaFileID} |
JsonSchemaFileCollection | /redfish/v1/JsonSchemas |
PCIeDevice | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/PCIeDevices/{PCIeDeviceID} |
PCIeDeviceCollection | /redfish/v1/PCIeDevices /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/PCIeDevices |
PCIeFunction | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/PCIeFunctions/{PCIeFunctionID} /redfish/v1/Chassis/{ChassisID}/{SwitchID}/Ports/{PortID}/{PCIeFunctionID} /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/PCIeDevices/{PCIeDeviceID}/{PCIeFunctionID} /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID}/ProvidedPorts/{PortID}/{PCIeFunctionID} |
PCIeFunctionCollection | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/PCIeFunctions |
Port | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/Ports/{PortID} /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID}/ProvidedPorts/{PortID} |
PortCollection | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/Ports /redfish/v1/Chassis/{ChassisID}/ComposedNodes/{ComposedNodeID}/ProvidedPorts |
Power | /redfish/v1/Chassis/{ChassisID}/Power /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/Power /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/Power |
Processor | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/Processors/{ProcessorID} |
ProcessorCollection | /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/Processors |
ServiceRoot | /redfish/v1 |
SoftwareInventory | /redfish/v1/Chassis/{ChassisID}/ImageInventory/{SoftwareInventoryID} |
SoftwareInventoryCollection | /redfish/v1/Chassis/{ChassisID}/ImageInventory |
Switch | /redfish/v1/Chassis/{ChassisID}/{SwitchID} |
SwitchCollection | /redfish/v1/Switches |
Thermal | /redfish/v1/Chassis/{ChassisID}/Thermal /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/Thermal /redfish/v1/Chassis/{ChassisID}/Baseboards/{BaseboardID}/ComputerSystems/{ComputerSystemID}/Thermal |
VLanNetworkInterface | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/VLANs/{VLanNetworkInterfaceID} /redfish/v1/Chassis/{ChassisID}/{SwitchID}/Ports/{PortID}/UntaggedVLAN |
VLanNetworkInterfaceCollection | /redfish/v1/Chassis/{ChassisID}/{SwitchID}/VLANs |