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

Adds a CORS origin

Request

Security
Bearer
Body
urlstring or null

The URL of the origin

curl -i -X POST \
  'http://{{your_prep_ip_address}}/api/v1/configuration/cors' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "url": "http://localhost:4300"
  }'

Responses

The request was successful

Response
No content

Get all CORS origins

Request

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

Responses

The list of CORS Origins

Bodyapplication/jsonArray [
idinteger(int32)

The ID of the origin

urlstring or null

The URL of the origin

canDeleteboolean

Whether or not the origin can be deleted

]
Response
application/json
[ { "id": 0, "url": "string", "canDelete": true } ]

Deletes a CORS origin

Request

Security
Bearer
Path
originIdinteger(int32)required

The CORS origin id to delete

curl -i -X DELETE \
  'http://{{your_prep_ip_address}}/api/v1/configuration/cors/{originId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Response
No content

Get a CORS origin

Request

Security
Bearer
Path
originIdinteger(int32)required

The CORS origin id to get

curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/configuration/cors/{originId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The CORS origin

Bodyapplication/jsonArray [
idinteger(int32)

The ID of the origin

urlstring or null

The URL of the origin

canDeleteboolean

Whether or not the origin can be deleted

]
Response
application/json
[ { "id": 0, "url": "string", "canDelete": true } ]

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

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