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

Instruments

Operations

Labware

Operations

LabwareCategories

Operations

LabwareSignature

Operations

Lighting

Operations

LiquidClass

Operations

Maintenance

Operations

NetworkConfiguration

Operations

Power

Operations

Request a power down

Request

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/request-powerdown' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request to powerdown was received successfully

Response
No content

Confirm the power down

Request

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/confirm-powerdown' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Confirm the power down was received successfully

Response
No content

Cancel the power down request

Request

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/cancel-powerdown' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Cancelling the power down was received successfully

Response
No content

Set the channel power on or off

Request

Security
Bearer
Path
enabledbooleanrequired

Enable or disable

curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/channel-power/{enabled}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Channel power was set successfully

Response
No content

Check if the power service is initialized

Request

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/power/is-initialized' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The power service is initialized state

Bodyapplication/json
boolean
Response
application/json
true

Enable or disable the servo power

Request

Security
Bearer
Path
enabledbooleanrequired

Enable or disable

curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/servo-power/{enabled}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The servo power was set successfully

Bodyapplication/json
boolean
Response
application/json
true

Subscribe to power-down events

Request

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/power/monitor-powerdown' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The subscription was successful

Response
No content

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