Get instrument information

GET /control/instruments/{serial}

Get up to date information about a specific instrument. This includes the same values as the instrument list but only for one instrument.

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
    • type string

      Type of instrument

      Values are Noise, AirQuality, or Vibration.

    • serialNumber string

      Serial number of the instrument

    • model string

      Model of the instrument

    • name string

      Friendly name or description of the instrument

    • image string(uri)

      URL of the image for the instrument

    • subscription object

      Subscription details for this instrument

      Additional properties are allowed.

      Hide subscription attributes Show subscription attributes object
      • status string

        Status of the subscription

        Values are Active, Cancelled, or Expired.

      • tier string

        Tier of the subscription

        Values are Standard, Pro, Storage, Track, or Enviro.

      • addons array[string]

        Addons for the subscription

        Value is Audio.

    • position object

      Position of the instrument

      Additional properties are allowed.

      Hide position attributes Show position attributes object
    • feature array[string]

      Additional features available on this instrument

      Values are SIC, Modem, or Weather.
  • 400 application/json

    There is an error in the request, possibly missing parameter or incorrect url.

    Hide response attributes Show response attributes object
  • 401 application/json

    Your access token is invalid or has expired

    Hide response attributes Show response attributes object
  • 403 application/json

    You do not have permission to access this data

    Hide response attributes Show response attributes object
  • 404 application/json

    There is an error in the request, possibly missing parameter or incorrect url.

    Hide response attributes Show response attributes object
  • 429 application/json

    You have made too many requests in a short time

    Hide response attributes Show response attributes object
GET /control/instruments/{serial} 
curl \
 --request GET 'https://api.mycirrus.cloud/v1/control/instruments/QT123456'
Response examples (200) 
{
  "name": "My Quantum",
  "type": "Noise",
  "image": "https://images.mycirrus.cloud/xxxxxxxx-xxxxxxxx-xxxxxxxx.jpg",
  "model": "CR:900",
  "feature": [
    "SIC",
    "Modem"
  ],
  "position": {
    "lat": 0,
    "long": 0
  },
  "serialNumber": "QT123456",
  "subscription": {
    "tier": "Standard",
    "status": "Active"
  }
}
Response examples (400) 
{
  "error": "MissingParam",
  "description": "The required parameter StartTime was missing from the request."
}
{
  "error": "NotFound",
  "description": "The instrument QT123456 could not be found."
}
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."
}