Amber Collection Test API

Get Tests

• Description – get amber tests.

• Request URL – GET /cablevalidation/tests/amber

• Request Content Type – application/json

• Status Codes200 – OK

• Response Data Example 

  \[
    \{
      "timestamp": 1674151365.5055714,
      "scope": "DH0/SU1",
      "status": "Running",
      "name": "amber1"
    \},
    \{
      "timestamp": 1674151365.5055714,
      "scope": "DH0/SU1",
      "status": "Finished",
      "name": "amber2"
    \}
  \]
  

Get Test Circuit

• Description – get amber test details.

• Request URL – GET /cablevalidation/tests/amber/<test_name>

• Request Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND

• Response Data Example 

  \[
    \{
      "hostname": "sw-hdr-proton01",
      "ip": "10.209.44.74",
      "node_type": "Switch",
      "status": "Finished",
      "dh": "DH1",
      "su": "SU2",
      "rack": "AAA",
      "unit": "1"
    \}
  \]

Create Test

• Description – create user.

• Request URL – POST /cablevalidation/tests/amber

• Request Content Type – application/json

• Request Data Example

  {"name":"test","context":"dc"}

• Status Codes  201 – CREATED409 – CONFLICT

• Response - 201: Created

Download Amber tar File

• Description – download amber tar file.

• Request URL – GET /cv_tests/amber/<test_name>/<test_name>.csvtar.gz

• Request Content Type – application/json

• Status Codes200 – OK404 – NOT FOUND

• Response - NA

Last updated: February 10, 2025