Get Image History

GET /image-history

Get image history. Only one parameter is required

Query parameters

  • all boolean

    Whether to get all images or only the current image

  • index integer(int32)

    The index of the image to get

  • count boolean

    Whether to count the number of images

  • imageType string

    Filter by image type. This will restrict the result to images of the specified type, meaning that count for example will only count images of the specified type. If this is omitted, all images are included.

    Values are LIGHT, FLAT, DARK, BIAS, or SNAPSHOT.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response array[object] | integer

      One of:
      Hide attributes Show attributes object
      • ExposureTime number
      • ImageType string

        Values are LIGHT, FLAT, DARK, BIAS, or SNAPSHOT.

      • Filter string
      • RmsText string
      • Temperature string
      • CameraName string
      • Gain integer
      • Offset integer
      • Date string
      • TelescopeName string
      • FocalLength number
      • StDev number
      • Mean number
      • Median number
      • Stars integer
      • HFR number
      • IsBayered boolean
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Invalid image index

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /image-history
curl \
 --request GET 'http://localhost:1888/v2/api/image-history'
Response examples (200)
{
  "Response": [
    {
      "ExposureTime": 42.0,
      "ImageType": "LIGHT",
      "Filter": "string",
      "RmsText": "string",
      "Temperature": "string",
      "CameraName": "string",
      "Gain": 42,
      "Offset": 42,
      "Date": "string",
      "TelescopeName": "string",
      "FocalLength": 42.0,
      "StDev": 42.0,
      "Mean": 42.0,
      "Median": 42.0,
      "Stars": 42,
      "HFR": 42.0,
      "IsBayered": true
    }
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (400)
{
  "Response": "string",
  "Error": "Index out of range",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500)
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}