IOionworks
Sites
Cyclers

Create a new cycler for a site

Changed on

Create a new cycler under the specified site (by ID).

The request body must include project_id — the project that will own this cycler. The site is org-scoped (cross-project), so any of the org's sites may host a cycler for any of its projects. Returns the created cycler and sets the Location header.

post/sites/{site_id}/cyclers

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/sites/{site_id}/cyclers
  • Auth
    none declared

Path parameters

site_idstring uuid required

Request body

object required

Response

Successful Response

namestring required

Name of the cycler

manufacturerstring nullable

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

modelstring nullable

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

versionstring nullable

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

serial_numberstring nullable

Manufacturer serial number of the cycler

firmware_versionstring nullable

Firmware revision currently installed on the cycler

hostnamestring nullable

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

ip_addressstring ipvanyaddress nullable

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

portinteger nullable

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

last_calibrated_atstring date-time nullable

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

calibration_interval_daysinteger nullable

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

notesstring nullable

Free-text notes about the cycler

site_idstring required

Foreign key to the parent site

project_idstring required

Project that owns this cycler

idstring required

Unique identifier for the cycler

organization_idstring required

Organization this cycler belongs to.

created_bystring nullable

User ID of the user who created this cycler

created_by_emailstring nullable

Email of the user who created this cycler

created_atstring date-time required

Timestamp when the cycler was created

updated_atstring date-time required

Timestamp when the cycler was last updated

calibration_due_atstring date-time nullable

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_idsobject[] nullable

List of channel IDs belonging to this cycler

Changes