Advanced API

Warming

GET /equipment/camera/warm

This endpoint warms the camera.

Query parameters

  • minutes number(double) Required

    The minimum duration to warm the camera. -1 for default duration

  • cancel boolean

    Whether to cancel the warming process.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string

      Values are Warming started or Warming canceled.

    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Camera not connected / Camera has no temperature control

    Hide response attributes Show response attributes object
    • Response string
    • Error string

      Values are Camera not connected or Camera has no temperature control.

    • 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 /equipment/camera/warm 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/camera/warm?minutes=42.0'
Response examples (200) 
{
  "Response": "Warming started",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Camera not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}