Skip to main content
Create a new cycler for a site

Path Parameters

site_id
string
required

Body

application/json

The body is of type Raw Data · object.

Response

Successful Response

Model representing a cycler as returned by the API.

name
string
required

Name of the cycler

site_id
string
required

Foreign key to the parent site

project_id
string
required

Project that owns this cycler

id
string
required

Unique identifier for the cycler

organization_id
string
required

Organization this cycler belongs to.

created_at
string<date-time>
required

Timestamp when the cycler was created

updated_at
string<date-time>
required

Timestamp when the cycler was last updated

manufacturer
string | null

Manufacturer (make) of the cycler (e.g. Arbin, Maccor)

model
string | null

Model (type) of the cycler (e.g. LBT-5V, Series 4000)

version
string | null

Hardware/product version of the cycler. Distinct from firmware_version, which changes without the hardware changing.

serial_number
string | null

Manufacturer serial number of the cycler

firmware_version
string | null

Firmware revision currently installed on the cycler

hostname
string | null

DNS name of the cycler control host on the lab network. Null for an instrument reachable only by IP.

ip_address
string<ipvanyaddress> | null

IP address of the cycler control host (IPv4 or IPv6)

port
integer | null

TCP port the cycler control software listens on (1-65535)

Required range: 1 <= x <= 65535
last_calibrated_at
string<date-time> | null

When the cycler was last calibrated. Null means never calibrated or not tracked — which reads as unknown, not as overdue.

calibration_interval_days
integer | null

Maximum time allowed between calibrations, in days. Null means the cycler is not on a calibration schedule.

Required range: x > 0
notes
string | null

Free-text notes about the cycler

created_by
string | null

User ID of the user who created this cycler

created_by_email
string | null

Email of the user who created this cycler

calibration_due_at
string<date-time> | null

When calibration next falls due: last_calibrated_at plus calibration_interval_days. Read-only — a generated database column, so it can never disagree with the two fields it derives from. Null when either is unset (the cycler is not on a schedule, or has never been calibrated).

channel_ids
Channel Ids · object[] | null

List of channel IDs belonging to this cycler