Change Updates

Do not miss any Advanced API changes, ever again

Subscribe to the Advanced API changelog to be up to date on recent changes.

RSS
Advanced API

Changelog

Last update:
Compare
2.2.9
1 structure change including:
1 Addition
Added 1
GET /prepared-image
2.2.7
6 structure changes including:
1 Breaking change
2 Additions
3 Modifications
1 Removal
Modified 3 Breaking
GET /application/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • Type went from object to array[object]
          Breaking
        • Timestamp, Level, Source, Member, Line, Message properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object property Added
GET /equipment/camera/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • Temperature, ElectronsPerADU, PixelSize, CoolerPower, TemperatureSetPoint, LastDownloadTime, ExposureMax, ExposureMin properties Modified
          • Type went from integer to number
            Breaking
GET /equipment/mount/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • GuideRateRightAscensionArcsecPerSec, GuideRateDeclinationArcsecPerSec properties Modified
          • Type went from integer to number
            Breaking
Removed 1 Breaking
GET /livestack/{target}/{filter}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /livestack/image/available
GET /livestack/image/{target}/{filter}
1 structure change including:
1 Modification
Modified 1
GET /application/logs
  • Query
  • lineCount, level query parameters Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /sequence/list-available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • Type went from array[object] to array[string]
          Breaking
2.2.6
6 structure changes including:
5 Additions
1 Modification
Modified 1
GET /equipment/mount/slew
  • Query
  • center, rotate, rotationAngle query parameters Added
Added 5
GET /application-start
GET /application/logs
GET /sequence/load
GET /version/nina
POST /sequence/load
2.2.3
3 structure changes including:
2 Additions
1 Modification
Modified 1
GET /image/{index}
  • Query
  • raw_fits query parameter Added
Added 2
GET /equipment/mount/sync
GET /profile/horizon
2.2.2
1 structure change including:
1 Addition
Added 1
GET /application/get-tab
1 structure change including:
1 Modification
Modified 1
GET /equipment/dome/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • ShutterStatus, DriverCanFollow, CanSetShutter, CanSetPark, CanSetAzimuth, CanSyncAzimuth, CanPark, CanFindHome, AtPark, AtHome, DriverFollowing, Slewing, Azimuth, SupportedActions, Connected, Name, DisplayName, Description, DriverInfo, DriverVersion, DeviceId properties Modified
          • Properties are no longer required
        • IsFollowing, IsSynchronized properties Added
4 structure changes including:
3 Additions
1 Modification
Modified 1
GET /equipment/dome/slew
  • Query
  • waitToFinish query parameter Added
Added 3
GET /equipment/dome/home
GET /equipment/dome/park
GET /equipment/dome/set-park-position
1 structure change including:
1 Modification
Modified 1
GET /equipment/dome/set-follow
  • Query
  • enabled query parameter Added
2.2.0
39 structure changes including:
27 Additions
12 Modifications
Modified 12 Breaking
GET /equipment/camera/capture
  • Query
  • save query parameter Added
GET /equipment/camera/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/dome/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/filterwheel/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/flatdevice/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/focuser/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/guider/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/mount/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/rotator/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/safetymonitor/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/switch/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
GET /equipment/weather/connect
  • Query
  • skipRescan query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • to query parameter Added
Added 27
GET /sequence/state
GET /sequence/edit
GET /image/thumbnail/{index}
GET /equipment/weather/rescan
GET /equipment/weather/list-devices
GET /equipment/switch/rescan
GET /equipment/switch/list-devices
GET /equipment/camera/capture/statistics
GET /equipment/camera/list-devices
GET /equipment/camera/rescan
GET /equipment/dome/list-devices
GET /equipment/dome/rescan
GET /equipment/filterwheel/list-devices
GET /equipment/filterwheel/rescan
GET /equipment/flatdevice/list-devices
GET /equipment/flatdevice/rescan
GET /equipment/focuser/list-devices
GET /equipment/focuser/rescan
GET /equipment/guider/list-devices
GET /equipment/guider/rescan
GET /equipment/mount/list-devices
GET /equipment/mount/rescan
GET /equipment/mount/set-park-position
GET /equipment/rotator/list-devices
GET /equipment/rotator/rescan
GET /equipment/safetymonitor/list-devices
GET /equipment/safetymonitor/rescan
1 structure change including:
1 Modification
Modified 1 Breaking
GET /flats/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • Type went from string to object
          Breaking
        • CompletedIterations, TotalIterations, State properties Added
2.1.8
11 structure changes including:
8 Additions
3 Modifications
Modified 3
GET /equipment/mount/slew
  • Query
  • waitForResult query parameter Added
GET /image-history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • array-1 alternative Modified
  • Query
  • imageType query parameter Added
GET /image/{index}
  • Query
  • debayer, bayerPattern, autoPrepare, imageType query parameters Added
Added 8
GET /equipment/mount/slew/stop
GET /flats/auto-brightness
GET /flats/auto-exposure
GET /flats/skyflat
GET /flats/status
GET /flats/stop
GET /flats/trained-dark-flat
GET /flats/trained-flat
2.1.7
11 structure changes including:
5 Additions
6 Modifications
Modified 6 Breaking
GET /equipment/camera/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • CameraState, SensorType properties Modified
          • Type went from integer to string
            Breaking
GET /equipment/dome/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • ShutterStatus property Modified
          • Type went from integer to string
            Breaking
GET /equipment/flatdevice/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • CoverState property Modified
          • Type went from integer to string
            Breaking
GET /equipment/mount/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • SiderealTime, RightAscension, Declination, SiteLatitude, SiteLongitude, SiteElevation, RightAscensionString, DeclinationString, Coordinates, TimeToMeridianFlip, Altitude, AltitudeString, AzimuthString, SiderealTimeString, HoursToMeridianString, AtPark, TrackingRate, TrackingEnabled, AtHome, CanFindHome, CanPark, CanSetPark, CanSetTrackingEnabled, CanSetDeclinationRate, CanSetRightAscensionRate, HasUnknownEpoch, TimeToMeridianFlipString, Slewing, GuideRateRightAscensionArcsecPerSec, GuideRateDeclinationArcsecPerSec, CanMovePrimaryAxis, CanMoveSecondaryAxis, PrimaryAxisRates, SecondaryAxisRates, SupportedActions, CanPulseGuide, IsPulseGuiding, CanSetPierSide, CanSlew, UTCDate properties Modified
          • Properties are no longer required
        • SideOfPier, EquatorialSystem, AlignmentMode properties Modified
          • Properties are no longer required
          • Type went from integer to string
            Breaking
        • Azimuth property Modified
          • Property is no longer required
          • Type went from integer to number
            Breaking
        • TrackingModes property Modified
          • Property is no longer required
          • Type went from array[integer] to array[string]
            Breaking
GET /framing/slew
  • Query
  • waitForResult query parameter Added
GET /profile/show
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • ApplicationSettings, CameraSettings, DomeSettings, FilterWheelSettings, FlatWizardSettings, FocuserSettings, FramingAssistantSettings, GuiderSettings, ImageFileSettings, ImageSettings, PlanetariumSettings, PlateSolveSettings, RotatorSettings, TelescopeSettings, ImageHistorySettings properties Modified
Added 5
GET /application/plugins
GET /livestack/start
GET /livestack/stop
GET /livestack/{target}/{filter}
GET /version
2.1.6
5 structure changes including:
2 Additions
3 Modifications
Modified 3
GET /application/screenshot
  • Response
  • 200 response Modified
    • image/png, image/jpg content types Added
  • Query
  • stream query parameter Added
GET /equipment/camera/capture
  • Response
  • 200 response Modified
    • image/png, image/jpg content types Added
  • Query
  • stream, omitImage, waitForResult query parameters Added
GET /image/{index}
  • Response
  • 200 response Modified
    • image/png, image/jpg content types Added
  • Query
  • stream query parameter Added
Added 2
GET /equipment/camera/set-binning
GET /framing/determine-rotation
2.1.5
5 structure changes including:
5 Additions
Added 5
GET /equipment/dome/set-follow
GET /equipment/dome/slew
GET /equipment/dome/sync
GET /equipment/mount/flip
GET /equipment/mount/slew
2.1.4
4 structure changes including:
2 Additions
2 Modifications
Modified 2
GET /equipment/guider/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • State property Added
GET /equipment/guider/start
  • Query
  • calibrate query parameter Added
Added 2
GET /equipment/guider/clear-calibration
GET /equipment/guider/graph
2.1.3
12 structure changes including:
12 Modifications
Modified 12
GET /equipment/camera/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/dome/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/filterwheel/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/flatdevice/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/focuser/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/guider/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/mount/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/rotator/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/safetymonitor/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/switch/connect
  • Query
  • skipRescan query parameter Added
GET /equipment/weather/connect
  • Query
  • skipRescan query parameter Added
GET /image/{index}
  • Query
  • factor, blackClipping, unlinked query parameters Added
1.0.0
  • Added more endpoints to flatdevice:
    • flatdevice/set-cover to open or close the cover
    • flatdevice/set-light to toggle the light on or off
    • flatdevice/set-brightness to change the brightness of the flatpanel
  • Added sequence/set-target to update the target in a target container
4 structure changes including:
4 Additions
Added 4
GET /equipment/flatdevice/set-brightness
GET /equipment/flatdevice/set-cover
GET /equipment/flatdevice/set-light
GET /sequence/set-target

profile/change-value fixes

framing/set-source added

camera/set-readout added to set the readout mode

version now returns the Plugin Version instead of an Independent Version number

2 structure changes including:
2 Additions
Added 2
GET /equipment/camera/set-readout
GET /framing/set-source