Set instrument information

PUT /control/instruments/{serial}

Change values for the specified instrument. Currently only the Name of the instrument can be modified.

Requires an API key with the instruments:write scope.

Path parameters

serial string Required

Serial number of the selected instrument

application/json

Body Required

Can pass the whole Instrument object or just an object containing Name

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
- latitude number
- longitude number
feature array[string]

Additional features available on this instrument

Values are SIC, Modem, or Weather.

Responses

204

No Content
400 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
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

PUT /control/instruments/{serial}

curl \
 --request PUT 'https://api.mycirrus.cloud/v1/control/instruments/QT123456' \
 --header "Content-Type: application/json" \
 --data '{"name":"My Quantum"}'

Request example

{
  "name": "My Quantum"
}

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."
}