Retrieve a booth's provisioning data

GET /api/booths_provisioning/{serial_number}

Api key

Allows you to get the provisioning data for a booth.

Path parameters

serial_number string Required

The serial number of the booth for which to get provisioning data

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- certificate_id string
  
  ID of the certificate, inferred from the uploaded certs file
- completion_status string
  
  Status of completion of the provisioning process.
- hw_configuration string
  
  Specific HW configuration for the booth.
- new_password string
  
  Randomly generated password for the PLC.
- old_password string
  
  Password initially generated for the PLC.
- s3_certs_path string
  
  Path in S3 where the booth's certificates are stored
- serial_number string
  
  serial number of the booth the data belongs to
400 application/json

Bad request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401 application/json

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
404 application/json

Not found
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/booths_provisioning/{serial_number}

curl \
 --request GET 'http://localhost:4000/api/booths_provisioning/{serial_number}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "new_password": "NewRandomPassword",
  "old_password": "Generic password",
  "s3_certs_path": "ABCD1234/a5d43ba45c3b54add35b565655737afff47a7b4d7f47abc767a7.zip",
  "serial_number": "ABCD1234",
  "certificate_id": "a5d43ba45c3b54add35b565655737afff47a7b4d7f47abc767a7",
  "hw_configuration": "6-slot",
  "completion_status": "IN PROGRESS"
}

Response examples (200)

{
  "new_password": "NewRandomPassword",
  "old_password": "Generic password",
  "s3_certs_path": "ABCD1234/a5d43ba45c3b54add35b565655737afff47a7b4d7f47abc767a7.zip",
  "serial_number": "ABCD1234",
  "certificate_id": "a5d43ba45c3b54add35b565655737afff47a7b4d7f47abc767a7",
  "hw_configuration": "6-slot",
  "completion_status": "IN PROGRESS"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}