Processors

Processor 1.20.1⁠


Version	v1.20
Release	2024.1

Description⁠

The Processor schema describes the information about a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if a unit is not present.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}

Properties⁠

Property	Type	Attributes	Notes
AccelerationFunctions (v1.4+) {}	object		The link to the collection of acceleration functions associated with this processor.
Actions (v1.1+) {	object		The available actions for this resource.
#Processor.Reset (v1.6+) {}	object		This action resets the processor. For more information, see the Actions section below.
#Processor.ResetToDefaults (v1.15+) {}	object		The action resets the values of writable properties to factory defaults. For more information, see the Actions section below.
}
AdditionalFirmwareVersions (v1.15+) {}	object		The additional firmware versions of the processor. See the SoftwareInventory.v1_13_0 schema for details on this property.
AppliedOperatingConfig (v1.9+) {}	object		The link to the operating configuration that is applied to this processor.
Assembly (v1.2+) {}	object		The link to an assembly associated with this processor.
BaseSpeedMHz (v1.10+)	integer (MHz)	read-only (null)	The base (nominal) clock speed of the processor in MHz.
BaseSpeedPriorityState (v1.9+)	string (enum)	read-only (null)	The state of the base frequency settings of the operation configuration applied to this processor. For the possible property values, see BaseSpeedPriorityState in Property details.
CacheMemory (v1.20+) {}	object		The link to the collection of cache memory associated with this processor.
Certificates (v1.11+) {}	object		The link to a collection of certificates for device identity and attestation.
Enabled (v1.12+)	boolean	read-write	An indication of whether this processor is enabled.
EnvironmentMetrics (v1.11+) {}	object		The link to the environment metrics for this processor.
Family (v1.16+)	string	read-only (null)	The processor family.
FirmwareVersion (v1.7+)	string	read-only	The firmware version of the processor.
FPGA (v1.4+) {	object		The properties for processors of the FPGA type.
ExternalInterfaces (v1.4+) [ {	array		An array of the FPGA external interfaces.
Ethernet (v1.4+) {	object		The Ethernet-related information for this interface.
MaxLanes (v1.4+)	integer	read-only (null)	The number of lanes supported by this interface.
MaxSpeedMbps (v1.4+)	integer (Mbit/s)	read-only (null)	The maximum speed supported by this interface.
Oem (v1.4+) {}	object		The OEM extension property. See the Resource schema for details on this property.
}
InterfaceType (v1.4+)	string (enum)	read-only (null)	The interface type. For the possible property values, see InterfaceType in Property details.
PCIe (v1.4+) {}	object		The PCIe-related information for this interface. See the PCIeDevice.v1_21_0 schema for details on this property.
} ]
FirmwareId (v1.4+)	string	read-only	The FPGA firmware identifier.
FirmwareManufacturer (v1.4+)	string	read-only	The FPGA firmware manufacturer.
FirmwareVersion (v1.4+, deprecated v1.9)	string	read-only	The FPGA firmware version. Deprecated in v1.9 and later. This property has been deprecated in favor of the `FirmwareVersion` property in the root of this resource.
FpgaType (v1.4+)	string (enum)	read-only	The FPGA type. For the possible property values, see FpgaType in Property details.
HostInterface (v1.4+, deprecated v1.8) {	object		The FPGA interface to the host. Deprecated in v1.8 and later. This property has been deprecated in favor of the `SystemInterface` property in the root of this resource.
Ethernet (v1.4+) {	object		The Ethernet-related information for this interface.
MaxLanes (v1.4+)	integer	read-only (null)	The number of lanes supported by this interface.
MaxSpeedMbps (v1.4+)	integer (Mbit/s)	read-only (null)	The maximum speed supported by this interface.
Oem (v1.4+) {}	object		The OEM extension property. See the Resource schema for details on this property.
}
InterfaceType (v1.4+)	string (enum)	read-only (null)	The interface type. For the possible property values, see InterfaceType in Property details.
PCIe (v1.4+) {}	object		The PCIe-related information for this interface. See the PCIeDevice.v1_21_0 schema for details on this property.
}
Model (v1.4+)	string	read-only	The FPGA model.
Oem (v1.4+) {}	object		The OEM extension property. See the Resource schema for details on this property.
PCIeVirtualFunctions (v1.4+)	integer	read-write	The number of PCIe Virtual Functions.
ProgrammableFromHost (v1.4+)	boolean	read-write (null)	An indication of whether the FPGA firmware can be reprogrammed from the host by using system software.
ReconfigurationSlots (v1.4+) [ {	array		An array of the FPGA reconfiguration slots. An FPGA uses a reconfiguration slot to contain an acceleration function that can change as the FPGA is provisioned.
AccelerationFunction (v1.4+) {}	object		The link to the acceleration function that the code programmed into a reconfiguration slot provides.
ProgrammableFromHost (v1.4+)	boolean	read-write (null)	An indication of whether the reconfiguration slot can be reprogrammed from the host by using system software.
SlotId (v1.4+)	string	read-only (null)	The FPGA reconfiguration slot identifier.
UUID (v1.4+)	string (uuid)	read-only (null)	The UUID for this reconfiguration slot.
} ]
}
HighSpeedCoreIDs (v1.9+) [ ]	array (integer, null)	read-only	The list of core identifiers corresponding to the cores that have been configured with the higher clock speed from the operating configuration applied to this processor.
InstructionSet	string (enum)	read-only (null)	The instruction set of the processor. For the possible property values, see InstructionSet in Property details.
Links (v1.1+) {	object		The links to other resources that are related to this resource.
Chassis (v1.1+) {}	object		The link to the chassis that contains this processor.
ConnectedProcessors (v1.4+) [ {	array		An array of links to the processors directly connected to this processor.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Endpoints (v1.4+) [ {	array		An array of links to the endpoints that connect to this processor.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
FabricAdapters (v1.17+) [ {	array		An array of links to the fabric adapters that present this processor to a fabric.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
GraphicsController (v1.12+) {}	object	(null)	A link to the graphics controller associated with this processor.
Memory (v1.11+) [ {	array		An array of links to the memory associated with this processor.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
NetworkDeviceFunctions (v1.13+) [ {	array		The network device functions to which this processor performs offload computation, such as with a SmartNIC.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PCIeDevice (v1.4+) {}	object		The link to the PCIe device associated with this processor.
PCIeFunctions (v1.4+) [ {	array		An array of links to the PCIeFunctions associated with this processor.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location (v1.2+) {}	object		The location of the processor. See the v1_23_0.v1_23_0 schema for details on this property.
LocationIndicatorActive (v1.10+)	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
Manufacturer	string	read-only (null)	The processor manufacturer.
MaxSpeedMHz	integer (MHz)	read-only (null)	The maximum clock speed of the processor.
MaxTDPWatts (v1.4+)	integer (W)	read-only (null)	The maximum Thermal Design Power (TDP) in watt units.
Measurements (v1.11+, deprecated v1.14) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.14 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
MemorySummary (v1.11+) {	object		The summary of all memory associated with this processor.
ECCModeEnabled (v1.13+)	boolean	read-write (null)	An indication of whether memory ECC mode is enabled for this processor.
Metrics (v1.11+) {}	object		The link to the memory metrics associated with all memory of this processor.
TotalCacheSizeMiB (v1.11+)	integer (MiBy)	read-only (null)	Total size of cache memory of this processor.
TotalMemorySizeMiB (v1.11+)	integer (MiBy)	read-only (null)	Total size of non-cache volatile or non-volatile memory attached to this processor. Examples include DRAMs and NV-DIMMs that are not configured as block storage.
}
Metrics (v1.4+) {}	object		The link to the metrics associated with this processor.
MinSpeedMHz (v1.8+)	integer (MHz)	read-only (null)	The minimum clock speed of the processor in MHz.
Model	string	read-only (null)	The product model number of this device.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OperatingConfigs (v1.9+) {}	object		The link to the collection of operating configurations that can be applied to this processor.
OperatingSpeedMHz (v1.8+)	integer (MHz)	read-only (null)	Operating speed of the processor in MHz.
OperatingSpeedRangeMHz (v1.13+) {}	object		Range of allowed operating speeds (MHz). See the Control.v1_7_0 schema for details on this property.
PartNumber (v1.7+)	string	read-only (null)	The part number of the processor.
Ports (v1.13+) {}	object		The link to the collection of ports for this processor.
PowerState (v1.17+)	string (enum)	read-only (null)	The current power state of the processor. For the possible property values, see PowerState in Property details.
ProcessorArchitecture	string (enum)	read-only (null)	The architecture of the processor. For the possible property values, see ProcessorArchitecture in Property details.
ProcessorId {	object		The identification information for this processor.
EffectiveFamily	string	read-only (null)	The effective family for this processor.
EffectiveModel	string	read-only (null)	The effective model for this processor.
IdentificationRegisters	string	read-only (null)	The raw manufacturer-provided processor identification registers for this processor.
MicrocodeInfo	string	read-only (null)	The microcode information for this processor.
ProtectedIdentificationNumber (v1.10+)	string	read-only (null)	The Protected Processor Identification Number (PPIN) for this processor.
Step	string	read-only (null)	The step value for this processor.
VendorId	string	read-only (null)	The vendor identification for this processor.
}
ProcessorIndex (v1.16+)	integer	read-only (null)	The logical index of this processor within the system.
ProcessorMemory (v1.4+) [ {	array		The memory directly attached or integrated within this processor. Examples include internal cache, dedicated memory for the processor, and system memory.
CapacityMiB (v1.4+)	integer (MiBy)	read-only (null)	The memory capacity in MiB.
IntegratedMemory (v1.4+)	boolean	read-only (null)	An indication of whether this memory is integrated within the processor.
MemoryType (v1.4+)	string (enum)	read-only (null)	The type of memory used by this processor. For the possible property values, see MemoryType in Property details.
SpeedMHz (v1.4+)	integer	read-only (null)	The operating speed of the memory in MHz.
} ]
ProcessorType	string (enum)	read-only (null)	The type of processor. For the possible property values, see ProcessorType in Property details.
Replaceable (v1.16+)	boolean	read-only (null)	An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.
SerialNumber (v1.7+)	string	read-only (null)	The serial number of the processor.
Socket	string	read-only (null)	The socket or location of the processor.
SparePartNumber (v1.11+)	string	read-only (null)	The spare part number of the processor.
SpeedLimitMHz (v1.10+)	integer (MHz)	read-write (null)	The clock limit of the processor in MHz.
SpeedLocked (v1.10+)	boolean	read-write (null)	Indicates whether the clock speed of the processor is fixed at the value specified in the `SpeedLimitMHz` property.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
SubProcessors (v1.3+) {}	object		The link to the collection of sub-processors associated with this processor, such as cores or threads, that are part of a processor.
SystemInterface (v1.8+) {	object		The interface between the system and the processor.
Ethernet (v1.4+) {	object		The Ethernet-related information for this interface.
MaxLanes (v1.4+)	integer	read-only (null)	The number of lanes supported by this interface.
MaxSpeedMbps (v1.4+)	integer (Mbit/s)	read-only (null)	The maximum speed supported by this interface.
Oem (v1.4+) {}	object		The OEM extension property. See the Resource schema for details on this property.
}
InterfaceType (v1.4+)	string (enum)	read-only (null)	The interface type. For the possible property values, see InterfaceType in Property details.
PCIe (v1.4+) {}	object		The PCIe-related information for this interface. See the PCIeDevice.v1_21_0 schema for details on this property.
}
TDPWatts (v1.4+)	integer (W)	read-only (null)	The nominal Thermal Design Power (TDP) in watt units.
ThrottleCauses (v1.16+) [ ]	array (string (enum))	read-only (null)	The causes of the processor being throttled. For the possible property values, see ThrottleCauses in Property details.
Throttled (v1.16+)	boolean	read-only (null)	An indication of whether the processor is throttled.
TotalCores	integer	read-only (null)	The total number of cores that this processor contains.
TotalEnabledCores (v1.5+)	integer	read-only (null)	The total number of enabled cores that this processor contains.
TotalThreads	integer	read-only (null)	The total number of execution threads that this processor supports.
TurboState (v1.9+)	string (enum)	read-only (null)	The state of turbo for this processor. For the possible property values, see TurboState in Property details.
UUID (v1.4+)	string (uuid)	read-only (null)	The UUID for this processor.
Version (v1.7+)	string	read-only (null)	The hardware version of the processor.

Actions⁠

Reset (v1.6+)⁠

Description

This action resets the processor.

Action URI

{Base URI of target resource}/Actions/Processor.Reset

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "ForceRestart"
}

ResetToDefaults (v1.15+)⁠

Description

The action resets the values of writable properties to factory defaults.

Action URI

{Base URI of target resource}/Actions/Processor.ResetToDefaults

Action parameters

This action takes no parameters.

Property details⁠

BaseSpeedPriorityState⁠

The state of the base frequency settings of the operation configuration applied to this processor.

string	Description
Disabled	Base speed priority is disabled.
Enabled	Base speed priority is enabled.

FpgaType⁠

The FPGA type.

string	Description
Discrete	The discrete FPGA device.
Integrated	The FPGA device integrated with other processor in the single chip.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

InstructionSet⁠

The instruction set of the processor.

string	Description
ARM-A32	ARM 32-bit.
ARM-A64	ARM 64-bit.
IA-64	Intel IA-64.
MIPS32	MIPS 32-bit.
MIPS64	MIPS 64-bit.
OEM	OEM-defined.
PowerISA (v1.4+)	PowerISA-64 or PowerISA-32.
RV32 (v1.19+)	RISC-V 32-bit.
RV64 (v1.19+)	RISC-V 64-bit.
x86	x86 32-bit.
x86-64	x86 64-bit.

InterfaceType⁠

The interface type.

string	Description
AMBA (v1.8+)	The Arm Advanced Microcontroller Bus Architecture interface.
CCIX (v1.8+)	The Cache Coherent Interconnect for Accelerators interface.
CXL (v1.8+)	The Compute Express Link interface.
Ethernet	An Ethernet interface.
OEM	An OEM-defined interface.
PCIe	A PCI Express interface.
QPI	The Intel QuickPath Interconnect.
UPI	The Intel UltraPath Interconnect.

MemoryType⁠

The type of memory used by this processor.

string	Description
Cache (v1.17+)	Processor cache, but no level is determined.
DDR	Double data rate synchronous dynamic random-access memory.
DDR2	Double data rate type two synchronous dynamic random-access memory.
DDR3	Double data rate type three synchronous dynamic random-access memory.
DDR4	Double data rate type four synchronous dynamic random-access memory.
DDR5	Double data rate type five synchronous dynamic random-access memory.
Flash	Flash memory.
GDDR	Synchronous graphics random-access memory.
GDDR2	Double data rate type two synchronous graphics random-access memory.
GDDR3	Double data rate type three synchronous graphics random-access memory.
GDDR4	Double data rate type four synchronous graphics random-access memory.
GDDR5	Double data rate type five synchronous graphics random-access memory.
GDDR5X	Double data rate type five X synchronous graphics random-access memory.
GDDR6	Double data rate type six synchronous graphics random-access memory.
HBM1	High Bandwidth Memory.
HBM2	The second generation of High Bandwidth Memory.
HBM2E (v1.17+)	An updated version of the second generation of High Bandwidth Memory.
HBM3	The third generation of High Bandwidth Memory.
L1Cache	L1 cache.
L2Cache	L2 cache.
L3Cache	L3 cache.
L4Cache	L4 cache.
L5Cache	L5 cache.
L6Cache	L6 cache.
L7Cache	L7 cache.
OEM	OEM-defined.
SDRAM	Synchronous dynamic random-access memory.
SGRAM	Synchronous graphics RAM.
SRAM	Static random-access memory.

PowerState⁠

The current power state of the processor.

string	Description
Off	The resource is powered off. The components within the resource might continue to have AUX power.
On	The resource is powered on.
Paused	The resource is paused.
PoweringOff	A temporary state between on and off. The components within the resource can take time to process the power off action.
PoweringOn	A temporary state between off and on. The components within the resource can take time to process the power on action.

ProcessorArchitecture⁠

The architecture of the processor.

string	Description
ARM	ARM.
IA-64	Intel Itanium.
MIPS	MIPS.
OEM	OEM-defined.
Power (v1.4+)	Power.
RISC-V (v1.19+)	RISC-V.
x86	x86 or x86-64.

ProcessorType⁠

The type of processor.

string	Description
Accelerator	An accelerator.
Core (v1.3+)	A core in a processor.
CPU	A CPU.
DSP	A DSP.
FPGA	An FPGA.
GPU	A GPU.
OEM	An OEM-defined processing unit.
Partition (v1.19+)	A partition in a single processor.
Thread (v1.3+)	A thread in a processor.

ResetType⁠

The type of reset.

string	Description
ForceOff	Turn off the unit immediately (non-graceful shutdown).
ForceOn	Turn on the unit immediately.
ForceRestart	Shut down immediately and non-gracefully and restart the unit.
FullPowerCycle	Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestart	Shut down gracefully and restart the unit.
GracefulShutdown	Shut down gracefully and power off.
Nmi	Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On	Turn on the unit.
Pause	Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCycle	Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButton	Simulate the pressing of the physical power button on this unit.
Resume	Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
Suspend	Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

ThrottleCauses⁠

The causes of the processor being throttled.

string	Description
ClockLimit	The cause of the processor being throttled is a clock limit.
ManagementDetectedFault	The cause of the processor being throttled is a fault detected by management hardware or firmware.
OEM	The cause of the processor being throttled is OEM-specific.
PowerLimit	The cause of the processor being throttled is a power limit.
ThermalLimit	The cause of the processor being throttled is a thermal limit.
Unknown	The cause of the processor being throttled is not known.

TurboState⁠

The state of turbo for this processor.

string	Description
Disabled	Turbo is disabled.
Enabled	Turbo is enabled.

Example response⁠

{
    "@odata.type": "#Processor.v1_22_0.Processor",
    "Name": "Processor",
    "Id": "1",
    "Socket": "CPU 1",
    "ProcessorType": "CPU",
    "ProcessorArchitecture": "x86",
    "InstructionSet": "x86-64",
    "Manufacturer": "Intel(R) Corporation",
    "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series",
    "ProcessorId": {
        "VendorId": "GenuineIntel",
        "IdentificationRegisters": "0x34AC34DC8901274A",
        "EffectiveFamily": "0x42",
        "EffectiveModel": "0x61",
        "Step": "0x1",
        "MicrocodeInfo": "0x429943"
    },
    "MaxSpeedMHz": 3700,
    "TotalCores": 8,
    "TotalThreads": 16,
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Location": {
        "PartLocation": {
            "ServiceLabel": "Processor 1",
            "LocationType": "Socket",
            "LocationOrdinalValue": 0
        }
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/1"
}

Processor 1.20.1⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

Reset (v1.6+)⁠​

ResetToDefaults (v1.15+)⁠​

Property details⁠​

BaseSpeedPriorityState⁠​

FpgaType⁠​

idRef⁠​

InstructionSet⁠​

InterfaceType⁠​

MemoryType⁠​

PowerState⁠​

ProcessorArchitecture⁠​

ProcessorType⁠​

ResetType⁠​

ThrottleCauses⁠​

TurboState⁠​

Example response⁠​