# Instrument info and control

Endpoints for finding and controlling instruments

## Retrieve the list of instruments

 - [GET /control/instruments](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/getinstruments.md): Get a list of all instruments that can be accessed with your account or api key.

Requires an API key with the instruments:read scope.

## Set instrument information

 - [PUT /control/instruments/{serial}](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/setinstrument.md): 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.

## Get instrument information

 - [GET /control/instruments/{serial}](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/getinstrument.md): 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.

## Get the status of an instrument

 - [GET /control/instruments/{serial}/status](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/getinstrumentstatus.md): 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.

## Start instrument action

 - [POST /control/instruments/{serial}/action](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/doinstrumentaction.md): Perform various actions on the instrument, including starting calibration or SIC.

This will return the current status of the operation. Calibration and SIC can take a long time, so if it returns InProgress you will need to check the calibration or sic status endpoints or wait for the relevant webhook to fire.
        
Requires an API key with the instruments:action scope.

## Get calibration status

 - [GET /control/instruments/{serial}/calibration](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/getcalibrationstatus.md): Get the status of the latest calibration.

Requires an API key with the instruments:read scope.

## Get SIC status

 - [GET /control/instruments/{serial}/sic](https://mycirrus.redocly.app/apis/mycirrus-main/instrument-info-and-control/getsicstatus.md): Get the status of the latest system integrity check.

Requires an API key with the instruments:read scope.