Get the status of an instrument

GET /control/instruments/{serial}/status

Get the status of an instrument. Includes flags to show if the instrument is online, if it is measuring and recording audio, as well as the calibration and SIC status.

Requires an API key with the instruments:read scope.

Path parameters

serial string Required

Serial number of the selected instrument

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- online boolean
- measuring boolean
- calibrationInProgress boolean
- sicInProgress boolean
- lastCalibration object
  
  Status of the Calibration
  
  Additional properties are allowed.
  
  Hide lastCalibration attributes Show lastCalibration attributes object
  
  time string(date-time)
  
  status string
  
  level number
  
  offset number
- lastSic object
  
  Status of the System Integrity Check (SIC)
  
  Additional properties are allowed.
  
  Hide lastSic attributes Show lastSic attributes object
  
  time string(date-time)
  
  status string
  
  _500Hz number
  
  _1KHz number
  
  _8KHz number
401 application/json

Your access token is invalid or has expired
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
403 application/json

You do not have permission to access this data
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
404 application/json

There is an error in the request, possibly missing parameter or incorrect url.
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error
429 application/json

You have made too many requests in a short time
Hide response attributes Show response attributes object
- error string
  
  Error code
- description string
  
  Description of the error

GET /control/instruments/{serial}/status

curl \
 --request GET 'https://api.mycirrus.cloud/v1/control/instruments/QT123456/status'

Response examples (200)

{
  "online": true,
  "lastSic": {
    "time": "2020-01-01T00:00:00Z",
    "status": "Success"
  },
  "measuring": true,
  "sicInProgress": false,
  "lastCalibration": {
    "time": "2020-01-01T00:00:00Z",
    "level": 93.7,
    "offset": 0.04,
    "status": "Success"
  },
  "calibrationInProgress": false
}

Response examples (401)

{
  "error": "TokenExpired",
  "description": "Your access token is invalid or has expired. Try refreshing the token."
}

Response examples (403)

{
  "error": "AccessDenied",
  "description": "You do not have permission to access this data."
}

Response examples (404)

{
  "error": "MissingParam",
  "description": "The required parameter StartTime was missing from the request."
}

{
  "error": "NotFound",
  "description": "The instrument QT123456 could not be found."
}

Response examples (429)

{
  "error": "TooManyRequests",
  "description": "You have made too many requests in a short time. Please wait before trying again."
}