Start instrument action
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.
Path parameters
-
serial
string Required Serial number of the selected instrument
Query parameters
-
action
string Required Values are
Identify
,Calibration
, orSIC
.
Responses
-
200 application/json
OK
-
400 application/json
There is an error in the request, possibly missing parameter or incorrect url.
-
401 application/json
Your access token is invalid or has expired
-
403 application/json
You do not have permission to access this data
-
404 application/json
There is an error in the request, possibly missing parameter or incorrect url.
-
429 application/json
You have made too many requests in a short time
POST
/control/instruments/{serial}/action
curl \
--request POST 'https://api.mycirrus.cloud/v1/control/instruments/QT123456/action?action=Identify'
Response examples (200)
{
"action": "Identify",
"status": "Success"
}
Response examples (400)
Example 1
{
"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)
Example 1
{
"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."
}