Amber Simulation APIs

Get Amber Simulation

• Description – Gets amber simulation.

• Request URL – GET /cablevalidation/simulation/amber

• Request Params: ParameterDescriptionTypeOptional/Requirednode_nameNode name. If set, gets a simulation info for that nodestringOptional

• Response Content Type – application/json

• Status Codes200 – OK

• Response Data Example

  [{"node_name": "sw-hdr-proton01", "device": null}]
  

Load Amber Simulation

• Description – Load amber simulation.

• Request URL – POST /cablevalidation/simulation/amber/load

• Request Data

  Parameter	Description	Type	Optional/Required
  node_name	Node name	string	Required
  device	Device's name, if the node contains multiple devices	string	Optional
  file	The binary file	Binary	Required

  
  

• Response Content Type – application/json

• Status Codes201 – CREATED400  - Bad Request409 -  CONFLICT

• Response Data Example

  {
      "status": "success",
      "node_name": "sw-hdr-proton01",
      "saved_file": "/tmp/amber_simulation_sw-hdr-proton01_device1_1754227317.csv",
      "size_bytes": 185578
  }
  

Stop Amber Simulation

• Description – Load amber simulation.

• Request URL – DELETE /cablevalidation/simulation/amber/stop

• Request Parameters: 

  Parameter	Description	Type	Optional/Required
  node_name	Node name	string	Required
  device	Device's name, if the node contains multiple devices	string	Optional

  
  

• Response Content Type – no content

• Status Codes204 – NO CONTENT400  - BAD REQUEST404 -  NOT FOUND

Last updated: June 03, 2026