# MyCirrus API - Instrument info, Data and Webhooks ## Description This is version `1.0.1` of this API documentation. Last update on Dec 4, 2024. API documentation for the MyCirrus API ## Servers - Production server: https://api.mycirrus.cloud/v1 (Production server) ## Authentication ## Topics - [Live data and status](https://bump.sh/cirrus/doc/mycirrus-main/topic/topic-live-data-and-status.md) - [Rate limits](https://bump.sh/cirrus/doc/mycirrus-main/topic/topic-rate-limits.md) - [Compression](https://bump.sh/cirrus/doc/mycirrus-main/topic/topic-compression.md) - [Support](https://bump.sh/cirrus/doc/mycirrus-main/topic/topic-support.md) ## Endpoints and operations ### [Instrument info and control](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-instrument-info-and-control.md) - [Retrieve the list of instruments](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getinstruments.md) - [Get instrument information](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getinstrument.md) - [Set instrument information](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-setinstrument.md) - [Get the status of an instrument](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getinstrumentstatus.md) - [Start instrument action](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-doinstrumentaction.md) - [Get calibration status](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getcalibrationstatus.md) - [Get SIC status](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getsicstatus.md) ### [Noise data](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-noise-data.md) - [Fetch noise measurements](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getmeasurements.md) - [Fetch noise time history](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-gettimehistory.md) - [Fetch frequency bands measurements](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getfrequencymeasurements.md) - [Fetch frequency bands time history](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getfrequencytimehist.md) - [Fetch a list of audio recordings](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getaudiolist.md) - [Get an audio recording](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getaudio.md) ### [Environmental data](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-environmental-data.md) - [Fetch weather data](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getweather.md) - [Fetch particulate data](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getparticulates.md) - [Fetch gas data](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getgases.md) - [Fetch vibration data](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getvibration.md) ### [Event data](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-event-data.md) - [Get a list of events](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getevents.md) - [Get event time history](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-geteventtimehistory.md) - [Get event audio recording](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-geteventaudio.md) ### [System health data](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-system-health-data.md) - [Fetch calibration records](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getcalibrations.md) - [Fetch calibration log items](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getcalibrationslog.md) - [Fetch SIC results](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getsicresults.md) - [Fetch system monitor statistics](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getmonitorstats.md) - [Fetch system monitor events](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getmonitorevents.md) - [Get current system monitor stats](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getmonitorcurrentstatus.md) ### [Webhook management](https://bump.sh/cirrus/doc/mycirrus-main/group/endpoint-webhook-management.md) - [Get a list of webhooks](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getwebhooks.md) - [Create a new webhook](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-addwebhook.md) - [Get a webhook](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-getwebhook.md) - [Remove a webhook](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-deletewebhook.md) ## Webhooks ### [Webhook Messages](https://bump.sh/cirrus/doc/mycirrus-main/group/webhook-webhook-messages.md) - [POST NewMeasurement](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-post-NewMeasurement.md) - [POST NewEvent](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-post-NewEvent.md) - [POST InstrumentStatus](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-post-InstrumentStatus.md) - [POST CalibrationFinished](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-post-CalibrationFinished.md) - [POST SicFinished](https://bump.sh/cirrus/doc/mycirrus-main/operation/operation-post-SicFinished.md) [Powered by Bump.sh](https://bump.sh)