http://localhost:1888/v2/apiThis is the API documentation for the NINA plugin Advanced API. Please use streaming instead of the default base64 encoding for images, as base64 support will be removed in the near future!
This is version 2.2.11 of this API documentation. Last update on Nov 7, 2025.
curl \
--request GET 'http://localhost:1888/v2/api/version'{
"Response": "2.2.11.0",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/version/nina'{
"Response": {
"oneOf": [
"3.2.0.1058",
"3.2 NIGHTLY #058"
]
},
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/application-start'{
"Response": "2025-07-20T09:43:44+02:00",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/application/switch-tab?tab=equipment'{
"Response": "Switched tab",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Invalid application tab",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/application/get-tab'{
"Response": "equipment",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Invalid application tab",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/application/plugins'{
"Response": [
"Advanced API",
"Livestack",
"Three Point Polar Alignment",
"Touch 'N' Stars"
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}Get a list of the last N log entries, this will ignore the header of the file. The endpoint is limited by the log level set in NINA
curl \
--request GET 'http://localhost:1888/v2/api/application/logs?lineCount=42'{
"Response": [
{
"Timestamp": "2025-05-04T14:57:39.5079",
"Level": "INFO",
"Source": "CameraChooserVM.cs",
"Member": "GetEquipment",
"Line": "279",
"Message": "Found 2 ASCOM Cameras"
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}Whether to resize the screenshot.
The quality of the screenshot, ranging from 1 (worst) to 100 (best). -1 or omitted for png
The size of the screenshot ([width]x[height]). Requires resize to be true.
The scale of the screenshot. Requires resize to be true.
Stream the image to the client. This will stream the image in image/jpg or image/png format.
curl \
--request GET 'http://localhost:1888/v2/api/application/screenshot'{
"Response": "<base64 encoded image>",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/info'{
"Response": {
"TargetTemp": 42.0,
"AtTargetTemp": true,
"CanSetTemperature": true,
"HasShutter": true,
"Temperature": 42.0,
"Gain": 42,
"DefaultGain": 42,
"ElectronsPerADU": 42.0,
"BinX": 42,
"BitDepth": 42,
"BinY": 42,
"CanSetOffset": true,
"CanGetGain": true,
"OffsetMin": 42,
"OffsetMax": 42,
"Offset": 42,
"DefaultOffset": 42,
"USBLimit": 42,
"IsSubSampleEnabled": true,
"CameraState": "NoState",
"XSize": 42,
"YSize": 42,
"PixelSize": 42.0,
"Battery": 42,
"GainMin": 42,
"GainMax": 42,
"CanSetGain": true,
"Gains": [],
"CoolerOn": true,
"CoolerPower": 42.0,
"HasDewHeater": true,
"DewHeaterOn": true,
"CanSubSample": true,
"SubSampleX": 42,
"SubSampleY": 42,
"SubSampleWidth": 42,
"SubSampleHeight": 42,
"TemperatureSetPoint": 42.0,
"ReadoutModes": [
"string"
],
"ReadoutMode": 42,
"ReadoutModeForSnapImages": 42,
"ReadoutModeForNormalImages": 42,
"IsExposing": true,
"ExposureEndTime": "string",
"LastDownloadTime": 42.0,
"SensorType": "Monochrome",
"BayerOffsetX": 42,
"BayerOffsetY": 42,
"BinningModes": [
{
"Name": "string",
"X": 42,
"Y": 42
}
],
"ExposureMax": 42.0,
"ExposureMin": 42.0,
"LiveViewEnabled": true,
"CanShowLiveView": true,
"SupportedActions": [
"string"
],
"CanSetUSBLimit": true,
"USBLimitMin": 42,
"USBLimitMax": 42,
"Connected": true,
"Name": "string",
"DisplayName": "string",
"DeviceId": "string"
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/connect'{
"Response": "Connected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/disconnect'{
"Response": "Disconnected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/list-devices'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/rescan'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/set-readout?mode=42'{
"Response": "Readout mode updated",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Invalid readout mode",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/cool?temperature=42.0&minutes=42.0'{
"Response": "Cooling started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Camera not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/warm?minutes=42.0'{
"Response": "Warming started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Camera not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/abort-exposure'{
"Response": "Exposure aborted",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Camera not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/dew-heater?power=true'{
"Response": "Dew heater set",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Camera not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/set-binning?binning=2x2'{
"Response": "Binning set",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Camera not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}This endpoint captures and/or returns an image. Can optionally solve the image.
Whether to solve the image.
The duration of the exposure. If omitted the exposure time for plate solving will be used.
The gain to use for the exposure. If omitted, the camera's default gain will be used.
Whether to get the result.
Whether to resize the image.
The quality of the image, ranging from 1 (worst) to 100 (best). -1 or omitted for png
The size of the image ([width]x[height]). Requires resize to be true.
The scale of the image. Requires resize to be true.
Stream the image to the client. This will only stream the image in image/jpg or image/png format. The platesolve result is not included.
Omit the image from the response. This will only send the platesolve result, if the image was platesolved. Use it if you do not care about the image, only about the platesolve result.
Wait for the capture to finish and then return the result. This will immediately take into account all the settings you would otherwise use together with getResult, like resize and stream.
The name of the target that is being captured. Useful for livestacking as an example.
Save the image to the disk. This needs to be set, when capturing the image.
Use this if you want to capture images at a high rate, the endpoint will return immediately once the camera is ready to take a picture again. The image preparation, platesolve and save will continue to run in the background, so the image wont be available until these have completed as well.
Use if you do not need the other capture endpoints, but want to save the raw image. Useful for high frequency captures.
curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/capture'{
"Response": "Capture already in progress",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "Camera not connected",
"Error": "string",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/camera/capture/statistics'{
"Response": {
"Stars": 42,
"HFR": 42.0,
"Median": 42.0,
"MedianAbsoluteDeviation": 42.0,
"Mean": 42.0,
"Max": 42,
"Min": 42,
"StDev": 42.0
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "No image available",
"Error": "string",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/info'{
"Response": {
"ShutterStatus": "ShutterNone",
"DriverCanFollow": true,
"CanSetShutter": true,
"CanSetPark": true,
"CanSetAzimuth": true,
"CanSyncAzimuth": true,
"CanPark": true,
"CanFindHome": true,
"AtPark": true,
"AtHome": true,
"DriverFollowing": true,
"Slewing": true,
"Azimuth": 42,
"SupportedActions": [],
"Connected": true,
"Name": "string",
"DisplayName": "string",
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"DeviceId": "string",
"IsFollowing": true,
"IsSynchronized": true
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/connect'{
"Response": "Connected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/disconnect'{
"Response": "Disconnected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/list-devices'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/rescan'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/open'{
"Response": "Shutter opening",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/close'{
"Response": "Shutter closing",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/stop'{
"Response": "Movement stopped",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/set-follow'{
"Response": "Following enabled",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/sync'{
"Response": "Dome Sync Started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/slew'{
"Response": "Dome Slew Started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/set-park-position'{
"Response": "Park position set",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/park'{
"Response": "Parking",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/dome/home'{
"Response": "Homing",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Dome not connected",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/event-history'{
"Response": [
{
"Event": "string",
"Time": "string"
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/info'{
"Response": {
"Connected": true,
"Name": "string",
"DisplayName": "string",
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"DeviceId": "string",
"IsMoving": true,
"SupportedActions": [
"string"
],
"SelectedFilter": {
"Name": "string",
"Id": 42
},
"AvailableFilters": [
{
"Name": "string",
"Id": 42
}
]
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/connect'{
"Response": "Connected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/disconnect'{
"Response": "Disconnected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/list-devices'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/rescan'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/change-filter?filterId=42'{
"Response": "Filter changed",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Filterwheel not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/filterwheel/filter-info?filterId=42'{
"Response": {
"Name": "string",
"FocusOffset": 42,
"Position": 42,
"AutoFocusExposureTime": 42,
"AutoFocusFilter": true,
"FlatWizardFilterSettings": {
"FlatWizardMode": 42,
"HistogramMeanTarget": 42.0,
"HistogramTolerance": 42.0,
"MaxFlatExposureTime": 42,
"MinFlatExposureTime": 42.0,
"MaxAbsoluteFlatDeviceBrightness": 42,
"MinAbsoluteFlatDeviceBrightness": 42,
"Gain": 42,
"Offset": 42,
"Binning": {
"Name": "string",
"X": 42,
"Y": 42
}
},
"AutoFocusBinning": {
"Name": "string",
"X": 42,
"Y": 42
},
"AutoFocusGain": 42,
"AutoFocusOffset": 42
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Filterwheel not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/flatdevice/info'{
"Response": {
"CoverState": "Unknown",
"LocalizedCoverState": "string",
"LocalizedLightOnState": "string",
"LightOn": true,
"Brightness": 42,
"SupportsOpenClose": true,
"MinBrightness": 42,
"MaxBrightness": 42,
"SupportsOnOff": true,
"SupportedActions": [],
"Connected": true,
"Name": "string",
"DisplayName": "string",
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"DeviceId": "string"
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/flatdevice/connect'{
"Response": "Connected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}Determine rotation from camera. This does nothing else than what the button in the framing assistant does. If waitForResult is set to true, the method will wait until the rotation is determined. This will only work if an image is loaded in the framing assistant
curl \
--request GET 'http://localhost:1888/v2/api/framing/determine-rotation'{
"Response": "Determine rotation started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": {
"BoundHeight": 42,
"BoundWidth": 42,
"CameraHeight": 42,
"CameraWidth": 42,
"CameraPixelSize": 42,
"DecDegrees": 42,
"DecMinutes": 42,
"DecSeconds": 42,
"RAHours": 42,
"RAMinutes": 42,
"RASeconds": 42,
"FieldOfView": 42,
"FocalLength": 42,
"HorizontalPanels": 42,
"VerticalPanels": 42,
"Rectangle": {
"OriginalX": 42,
"OriginalY": 42,
"Id": 42,
"DSOPositionAngle": 42,
"OriginalOffset": 42,
"RotationOffset": 42,
"Rotation": 42,
"TotalRotation": 42,
"X": 42,
"Y": 42,
"Width": 42,
"Height": 42
}
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Could not start process",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/guider/start'{
"Response": "Guiding started",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Guider not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/guider/clear-calibration'{
"Response": "Calibration cleared",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Guider not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/guider/graph'{
"Response": {
"RMS": {
"RA": 42.0,
"Dec": 42.0,
"Total": 42.0,
"RAText": "string",
"DecText": "string",
"TotalText": "string",
"PeakRAText": "string",
"PeakDecText": "string",
"Scale": 42.0,
"PeakRA": 42.0,
"PeakDec": 42.0,
"DataPoints": 42
},
"Interval": 42,
"MaxY": 42,
"MinY": 42,
"MaxDurationY": 42,
"MinDurationY": 42,
"GuideSteps": [
{
"Id": 42,
"IdOffsetLeft": 42.0,
"IdOffsetRight": 42.0,
"RADistanceRaw": 42.0,
"RADistanceRawDisplay": 42.0,
"RADuration": 42,
"DECDistanceRaw": 42.0,
"DECDistanceRawDisplay": 42.0,
"DECDuration": 42,
"Dither": "string"
}
],
"HistorySize": 42,
"PixelScale": 42.0,
"Scale": 42
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}Whether to resize the image.
The quality of the image, ranging from 1 (worst) to 100 (best). -1 or omitted for png
The size of the image ([width]x[height]). Requires resize to be true.
The scale of the image. Requires resize to be true.
The stretch factor to apply, between 0 and 1. Defaults to what is configured in the profile.
The black clipping to apply. Defaults to what is configured in the profile.
Indicates if the stretch should be unlinked. Defaults to what is configured in the profile.
Stream the image to the client. This will stream the image in image/jpg or image/png format.
Indicates if the image should be debayered
What bayer pattern to use for debayering, if debayer is true. If this is not specified, the api will try to use the bayer pattern that is configured in the profile as its first option, if that is set to Auto, the api will try to use the bayer pattern reported by the camera if it is connected. The fallback value is Monochrome.
Values are Monochrome, Color, RGGB, CMYG, CMYG2, LRGB, BGGR, GBRG, GRBG, GRGB, GBGR, RGBG, or BGRG.
Setting this to true will leave all processing up to NINA and you will recieve exactly the same image as you see in NINA. All other parameters related to image processing will have no effect.
Filter the image history by image type. This is useful if you got the index of an image using the history with a filter and now want to get the image. E.g. the 3rd flat in the image history is the 3rd flat in the image endpoint.
Values are LIGHT, FLAT, DARK, BIAS, or SNAPSHOT.
Whether to send the image (without streaming) as a raw FITS format. Will return an error if the image is not of type FITS.
Successful response
Image in png format, when stream is set to true and the image quality is not specified or set to -1
Image in jpg format, when stream is set to true and the image quality is specified
Invalid image index / invalid bayer pattern / image is not a FITS file
Internal server error, Unknown error
curl \
--request GET 'http://localhost:1888/v2/api/image/{index}'{
"Response": "<base64 encoded image>",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Index out of range",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/livestack/stop'{
"Response": "Live stack stopped",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/info'{
"Response": {
"SiderealTime": 42.0,
"RightAscension": 42.0,
"Declination": 42.0,
"SiteLatitude": 42.0,
"SiteLongitude": 42.0,
"SiteElevation": 42.0,
"RightAscensionString": "string",
"DeclinationString": "string",
"Coordinates": {
"RA": 42.0,
"RAString": "string",
"RADegrees": 42.0,
"Dec": 42.0,
"DecString": "string",
"Epoch": "JNOW",
"DateTime": {
"Now": "string",
"UtcNow": "string"
}
},
"TimeToMeridianFlip": 42.0,
"SideOfPier": "pierEast",
"Altitude": 42.0,
"AltitudeString": "string",
"Azimuth": 42.0,
"AzimuthString": "string",
"SiderealTimeString": "string",
"HoursToMeridianString": "string",
"AtPark": true,
"TrackingRate": {},
"TrackingEnabled": true,
"TrackingModes": [
"Siderial"
],
"AtHome": true,
"CanFindHome": true,
"CanPark": true,
"CanSetPark": true,
"CanSetTrackingEnabled": true,
"CanSetDeclinationRate": true,
"CanSetRightAscensionRate": true,
"EquatorialSystem": "JNOW",
"HasUnknownEpoch": true,
"TimeToMeridianFlipString": "string",
"Slewing": true,
"GuideRateRightAscensionArcsecPerSec": 42.0,
"GuideRateDeclinationArcsecPerSec": 42.0,
"CanMovePrimaryAxis": true,
"CanMoveSecondaryAxis": true,
"PrimaryAxisRates": [
{}
],
"SecondaryAxisRates": [
{}
],
"SupportedActions": [
"string"
],
"AlignmentMode": "AltAz",
"CanPulseGuide": true,
"IsPulseGuiding": true,
"CanSetPierSide": true,
"CanSlew": true,
"UTCDate": "string",
"Connected": true,
"Name": "string",
"DisplayName": "string",
"DeviceId": "string"
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/list-devices'{
"Response": [
{
"HasSetupDialog": true,
"Id": "string",
"Name": "string",
"DisplayName": "string",
"Category": "string",
"Connected": true,
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"SupportedActions": []
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/tracking?mode=42'{
"Response": "Tracking mode changed",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Mount not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/unpark'{
"Response": "Unparking",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Mount not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/flip'{
"Response": "Flipping",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Mount not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/mount/slew?ra=42.0&dec=42.0'{
"Response": "Started Slew",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Mount not connected",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/profile/show'{
"Response": {
"Name": "string",
"Description": "string",
"Id": "string",
"LastUsed": "string",
"ApplicationSettings": {
"Culture": "string",
"DevicePollingInterval": 42,
"PageSize": 42,
"LogLevel": "ERROR"
},
"AstrometrySettings": {
"Latitude": 42.0,
"Longitude": 42.0,
"Elevation": 42,
"HorizonFilePath": "string"
},
"CameraSettings": {
"BitDepth": 42,
"BulbMode": "NATIVE",
"Id": "string",
"PixelSize": 42,
"RawConverter": "DCRAW",
"SerialPort": "string",
"MinFlatExposureTime": 42.0,
"MaxFlatExposureTime": 42,
"FileCameraFolder": "string",
"FileCameraUseBulbMode": true,
"FileCameraIsBayered": true,
"FileCameraExtension": "string",
"FileCameraAlwaysListen": true,
"FileCameraDownloadDelay": 42,
"BayerPattern": "None",
"FLIEnableFloodFlush": true,
"FLIEnableSnapshotFloodFlush": true,
"FLIFloodDuration": 42,
"FLIFlushCount": 42,
"BitScaling": true,
"CoolingDuration": 42,
"WarmingDuration": 42,
"Temperature": 42,
"Gain": 42,
"Offset": 42,
"QhyIncludeOverscan": true,
"Timeout": 42,
"DewHeaterOn": true,
"ASCOMAllowUnevenPixelDimension": true,
"MirrorLockupDelay": 42,
"BinAverageEnabled": true,
"TrackingCameraASCOMServerEnabled": true,
"TrackingCameraASCOMServerPipeName": "string",
"TrackingCameraASCOMServerLoggingEnabled": true,
"SBIGUseExternalCcdTracker": true,
"AtikGainPreset": 42,
"AtikExposureSpeed": 42,
"AtikWindowHeaterPowerLevel": 42,
"TouptekAlikeUltraMode": true,
"TouptekAlikeHighFullwell": true,
"TouptekAlikeLEDLights": true,
"TouptekAlikeDewHeaterStrength": 42,
"GenericCameraDewHeaterStrength": 42,
"GenericCameraFanSpeed": 42,
"ZwoAsiMonoBinMode": true,
"ASCOMCreate32BitData": true,
"BadPixelCorrection": true,
"BadPixelCorrectionThreshold": 42
},
"ColorSchemaSettings": {
"AltColorSchema": "string",
"ColorSchema": "string"
},
"DomeSettings": {
"Id": "string",
"ScopePositionEastWest_mm": 42,
"ScopePositionNorthSouth_mm": 42,
"ScopePositionUpDown_mm": 42,
"DomeRadius_mm": 42,
"GemAxis_mm": 42,
"LateralAxis_mm": 42,
"AzimuthTolerance_degrees": 42,
"FindHomeBeforePark": true,
"DomeSyncTimeoutSeconds": 42,
"SynchronizeDuringMountSlew": true,
"SyncSlewDomeWhenMountSlews": true,
"RotateDegrees": 42,
"CloseOnUnsafe": true,
"ParkMountBeforeShutterMove": true,
"RefuseUnsafeShutterMove": true,
"RefuseUnsafeShutterOpenSansSafetyDevice": true,
"ParkDomeBeforeShutterMove": true,
"MountType": "EQUATORIAL",
"DecOffsetHorizontal_mm": 42,
"SettleTimeSeconds": 42
},
"FilterWheelSettings": {
"FilterWheelFilters": [
{
"Name": "string",
"FocusOffset": 42,
"Position": 42,
"AutoFocusExposureTime": 42,
"AutoFocusFilter": true,
"FlatWizardFilterSettings": {
"FlatWizardMode": "DYNAMICEXPOSURE",
"HistogramMeanTarget": 42.0,
"HistogramTolerance": 42.0,
"MaxFlatExposureTime": 42,
"MinFlatExposureTime": 42.0,
"MaxAbsoluteFlatDeviceBrightness": 42,
"MinAbsoluteFlatDeviceBrightness": 42,
"Gain": 42,
"Offset": 42,
"Binning": {
"Name": "string",
"X": 42,
"Y": 42
}
},
"AutoFocusBinning": {
"Name": "string",
"X": 42,
"Y": 42
},
"AutoFocusGain": 42,
"AutoFocusOffset": 42
}
],
"Id": "string",
"DisableGuidingOnFilterChange": true,
"Unidirectional": true
},
"FlatWizardSettings": {
"FlatCount": 42,
"HistogramMeanTarget": 42.0,
"HistogramTolerance": 42.0,
"DarkFlatCount": 42,
"OpenForDarkFlats": true,
"AltitudeSite": 42,
"FlatWizardMode": "DYNAMICEXPOSURE"
},
"FocuserSettings": {
"AutoFocusExposureTime": 42,
"AutoFocusInitialOffsetSteps": 42,
"AutoFocusStepSize": 42,
"Id": "string",
"UseFilterWheelOffsets": true,
"AutoFocusDisableGuiding": true,
"FocuserSettleTime": 42,
"AutoFocusTotalNumberOfAttempts": 42,
"AutoFocusNumberOfFramesPerPoint": 42,
"AutoFocusInnerCropRatio": 42,
"AutoFocusOuterCropRatio": 42,
"AutoFocusUseBrightestStars": 42,
"BacklashIn": 42,
"BacklashOut": 42,
"AutoFocusBinning": 42,
"AutoFocusCurveFitting": "TRENDLINES",
"AutoFocusMethod": "STARHFR",
"ContrastDetectionMethod": "Sobel",
"BacklashCompensationModel": "ABSOLUTE",
"AutoFocusTimeoutSeconds": 42,
"RSquaredThreshold": 42.0
},
"FramingAssistantSettings": {
"CameraHeight": 42,
"CameraWidth": 42,
"FieldOfView": 42,
"Opacity": 42.0,
"LastSelectedImageSource": "NASA",
"LastRotationAngle": 42,
"SaveImageInOfflineCache": true
},
"GuiderSettings": {
"GuiderName": "string",
"DitherPixels": 42,
"DitherRAOnly": true,
"PHD2GuiderScale": "PIXELS",
"MaxY": 42,
"PHD2HistorySize": 42,
"PHD2ServerPort": 42,
"PHD2ServerUrl": "string",
"PHD2InstanceNumber": 42,
"SettleTime": 42,
"SettlePixels": 42.0,
"SettleTimeout": 42,
"PHD2Path": "string",
"AutoRetryStartGuiding": true,
"AutoRetryStartGuidingTimeoutSeconds": 42,
"MetaGuideUseIpAddressAny": true,
"MetaGuidePort": 42,
"MGENFocalLength": 42,
"MGENPixelMargin": 42,
"MetaGuideMinIntensity": 42,
"MetaGuideDitherSettleSeconds": 42,
"MetaGuideLockWhenGuiding": true,
"PHD2ROIPct": 42,
"SkyGuardServerPort": 42,
"SkyGuardServerUrl": "string",
"SkyGuardPath": "string",
"SkyGuardCallbackPort": 42,
"SkyGuardTimeLapsChecked": true,
"SkyGuardValueMaxGuiding": 42,
"SkyGuardTimeLapsGuiding": 42,
"SkyGuardTimeLapsDitherChecked": true,
"SkyGuardValueMaxDithering": 42,
"SkyGuardTimeLapsDithering": 42,
"SkyGuardTimeOutGuiding": 42,
"GuideChartRightAscensionColor": {
"A": 42,
"R": 42,
"G": 42,
"B": 42,
"ScA": 42,
"ScR": 42,
"ScG": 42,
"ScB": 42
},
"GuideChartDeclinationColor": {
"A": 42,
"R": 42,
"G": 42,
"B": 42,
"ScA": 42,
"ScR": 42,
"ScG": 42,
"ScB": 42
},
"GuideChartShowCorrections": true
},
"ImageFileSettings": {
"FilePath": "string",
"FilePattern": "string",
"FilePatternDARK": "string",
"FilePatternBIAS": "string",
"FilePatternFLAT": "string",
"FileType": "TIFF",
"TIFFCompressionType": "NONE",
"XISFCompressionType": "NONE",
"XISFChecksumType": "NONE",
"XISFByteShuffling": true,
"FITSCompressionType": "NONE",
"FITSAddFzExtension": true,
"FITSUseLegacyWriter": true
},
"ImageSettings": {
"AnnotateImage": true,
"DebayerImage": true,
"DebayeredHFR": true,
"UnlinkedStretch": true,
"AnnotateUnlimitedStars": true,
"AutoStretchFactor": 42.0,
"BlackClipping": 42.0,
"StarSensitivity": "Normal",
"NoiseReduction": "None",
"DetectStars": true,
"AutoStretch": true
},
"MeridianFlipSettings": {
"MinutesAfterMeridian": 42,
"MaxMinutesAfterMeridian": 42,
"PauseTimeBeforeMeridian": 42,
"Recenter": true,
"SettleTime": 42,
"UseSideOfPier": true,
"AutoFocusAfterFlip": true,
"RotateImageAfterFlip": true
},
"PlanetariumSettings": {
"StellariumHost": "string",
"StellariumPort": 42,
"CdCHost": "string",
"CdCPort": 42,
"TSXHost": "string",
"TSXPort": 42,
"TSXUseSelectedObject": true,
"HNSKYHost": "string",
"HNSKYPort": 42,
"C2AHost": "string",
"C2APort": 42,
"SkytechXHost": "string",
"SkytechXPort": 42,
"PreferredPlanetarium": "CDC"
},
"PlateSolveSettings": {
"AstrometryURL": "string",
"AstrometryAPIKey": "string",
"BlindSolverType": "ASTROMETRY_NET",
"CygwinLocation": "string",
"ExposureTime": 42,
"Gain": 42,
"Binning": 42,
"PlateSolverType": "ASTROMETRY_NET",
"PS2Location": "string",
"PS3Location": "string",
"Regions": 42,
"SearchRadius": 42,
"Threshold": 42,
"RotationTolerance": 42,
"ReattemptDelay": 42,
"NumberOfAttempts": 42,
"AspsLocation": "string",
"ASTAPLocation": "string",
"DownSampleFactor": 42,
"MaxObjects": 42,
"Sync": true,
"SlewToTarget": true,
"BlindFailoverEnabled": true,
"TheSkyXHost": "string",
"TheSkyXPort": 42,
"PinPointCatalogType": "ppGSCACT",
"PinPointCatalogRoot": "string",
"PinPointMaxMagnitude": 42,
"PinPointExpansion": 42,
"PinPointAllSkyApiKey": "string",
"PinPointAllSkyApiHost": "string"
},
"RotatorSettings": {
"Id": "string",
"Reverse2": true,
"RangeType": "FULL",
"RangeStartMechanicalPosition": 42
},
"FlatDeviceSettings": {
"Id": "string",
"PortName": "string",
"SettleTime": 42,
"TrainedFlatExposureSettings": []
},
"SequenceSettings": {
"EstimatedDownloadTime": "string",
"TemplatePath": "string",
"TimeSpanInTicks": 42,
"ParkMountAtSequenceEnd": true,
"CloseDomeShutterAtSequenceEnd": true,
"ParkDomeAtSequenceEnd": true,
"WarmCamAtSequenceEnd": true,
"DefaultSequenceFolder": "string",
"StartupSequenceTemplate": "string",
"SequencerTemplatesFolder": "string",
"SequencerTargetsFolder": "string",
"CollapseSequencerTemplatesByDefault": true,
"CoolCameraAtSequenceStart": true,
"UnparMountAtSequenceStart": true,
"OpenDomeShutterAtSequenceStart": true,
"DoMeridianFlip": true,
"DisableSimpleSequencer": true
},
"SwitchSettings": {
"Id": "string"
},
"TelescopeSettings": {
"Name": "string",
"MountName": "string",
"FocalLength": 42,
"FocalRatio": 42,
"Id": "string",
"SettleTime": 42,
"SnapPortStart": "string",
"SnapPortStop": "string",
"NoSync": true,
"TimeSync": true,
"PrimaryReversed": true,
"SecondaryReversed": true,
"TelescopeLocationSyncDirection": "PROMPT"
},
"WeatherDataSettings": {
"Id": "string",
"OpenWeatherMapAPIKey": "string",
"TheWeatherCompanyAPIKey": "string",
"WeatherUndergroundAPIKey": "string",
"WeatherUndergroundStation": "string"
},
"SnapShotControlSettings": {
"ExposureDuration": 42,
"Gain": 42,
"Save": true,
"Loop": true
},
"SafetyMonitorSettings": {
"Id": "string"
},
"AlpacaSettings": {
"NumberOfPolls": 42,
"PollInterval": 42,
"DiscoveryPort": 42,
"DiscoveryDuration": 42,
"ResolveDnsName": true,
"UseIPv4": true,
"UseIPv6": true,
"UseHttps": true
},
"ImageHistorySettings": {
"ImageHistoryLeftSelected": "NONE",
"ImageHistoryRightSelected": "NONE"
}
},
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/profile/change-value?settingpath=CameraSettings-PixelSize&newValue=3.2'{
"Response": "Updated setting",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Invalid path",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/rotator/info'{
"Response": {
"CanReverse": true,
"Reverse": true,
"MechanicalPosition": 42,
"Position": 42,
"StepSize": 42.0,
"IsMoving": true,
"Synced": true,
"SupportedActions": [],
"Connected": true,
"Name": "string",
"DisplayName": "string",
"Description": "string",
"DriverInfo": "string",
"DriverVersion": "string",
"DeviceId": "string"
},
"Error": "string",
"StatusCode": 42,
"Success": true,
"Type": "string"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/sequence/json'{
"Response": [
{
"Conditions": [],
"Items": [],
"Triggers": [],
"Status": "string",
"Name": "string"
}
],
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Sequencer not initialized",
"StatusCode": 409,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}This works similary to profile/set-value. Note that this mainly supports fields that expect simple types like strings, numbers etc, and may not work for things like enums or objects (filter, time source, ...). This is an experimental feature, and it could have unexpected side effects or simply not work for some instructions or fields. If you encounter any bugs (except that it is not working with enums or objects), feel free to create an issue on github or contact me on the NINA discord.
The path to the property that should be updated. Use GlobalTriggers, Start, Imaging, End for the sequence root containers. Then use the name of the property or the index of the item in a list, seperated with -. The example would set the exposure time of a Take Exposure instruction, contained in a DSO container, to 20s. Use sequence/state as reference, not sequence/json!
The new value
curl \
--request GET 'http://localhost:1888/v2/api/sequence/edit?path=Imaging-Items-0-Items-0-ExposureTime&value=20'{
"Response": "Updated setting",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Sequence is not initialized",
"StatusCode": 400,
"Success": false,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}curl \
--request GET 'http://localhost:1888/v2/api/equipment/switch/connect'{
"Response": "Connected",
"Error": "string",
"StatusCode": 200,
"Success": true,
"Type": "API"
}{
"Response": "string",
"Error": "Unknown error",
"StatusCode": 500,
"Success": false,
"Type": "API"
}