Skip to content

ML Prep API (v1)

Download OpenAPI description
Languages
Servers
Mock server

http://{{your_prep_ip_address}}/

Authenticate

Operations

Backups

Operations

Calibration

Operations

Camera

Operations

Configuration

Operations

Credentials

Operations

Deck

Operations

Diagnostics

Operations

Enclosure

Operations

Environment

Operations

Errors

Operations

HepaUv

Operations

Start the HEPA fan on the HEPA/UV device

Request

Turns on the HEPA fan

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/hepa-uv/start-hepa-fan' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

HEPA fan started

Bodyapplication/json
string
Response
application/json
"string"

Stop the HEPA fan on the HEPA/UV device

Request

Turns off the HEPA fan

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/hepa-uv/stop-hepa-fan' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

HEPA fan stopped

Bodyapplication/json
string
Response
application/json
"string"

The HEPA fan state

Request

Checks if the HEPA fan is running

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/hepa-uv/is-hepa-fan-running' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
string
Response
application/json
"string"

HEPA pre-filter usage

Request

Gets the current usage of the HEPA pre-filter

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/hepa-uv/pre-filter-usage' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The current usage

Bodyapplication/json
integer(int32)
Response
application/json
0

HEPA filter pressure

Request

Gets the current pressure of the HEPA filter

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/hepa-uv/hepa-filter-pressure' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The current pressure

Bodyapplication/json
integer(int32)
Response
application/json
0

Instruments

Operations

Labware

Operations

LabwareCategories

Operations

LabwareSignature

Operations

Lighting

Operations

LiquidClass

Operations

Maintenance

Operations

NetworkConfiguration

Operations

Power

Operations

ProtocolRun

Operations

Protocols

Operations

ProtocolSteps

Operations

ProtocolSupport

Operations

ProtocolVerification

Operations

Repair

Operations

Report

Operations

Roles

Operations

RunData

Operations

Screenshots

Operations

ServiceSoftwareApi

Operations

Settings

Operations

SoftwareVersions

Operations

SystemReady

Operations

SystemTime

Operations

ThermalDevice

Operations

Traces

Operations

UserKba

Operations

Users

Operations

Verification

Operations

VerificationResult

Operations