Skip to main content
Skip table of contents

Camera movement. VMS Client

This request allows moving the camera in four directions and adjusting the zoom.

When this request is made, the RelativeMove method is called via ONVIF, and if unsuccessful, the ContinuousMove method is used.

This functionality is not currently in use.

POST/api/v1/cameras/{camera}/move

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

json

JSON
{
    "up": true,
    "down": true,
    "right": true,
    "left": true,
    "zoom-in": true,
    "zoom-out": true
}

cameraoptional

int

Camera identifier

uprequired

bool

Indicates that the camera should be moved upwards

downrequired

bool

Indicates that the camera should be moved downwards

rightrequired

bool

Indicates that the camera should be moved to the right

leftrequired

bool

Indicates that the camera should be moved to the left

zoom-inrequired

bool

Indicates that the zoom should be increased

zoom-outrequired

bool

Indicates that the zoom should be decreased

Response

200

Successful response

JSON
{
    "status": "ok"
}
403

If temporary access to the camera is blocked, an error with a 403 status code will be returned, with a response body similar to a 422 error

401

Authorization token not provided or invalid, see Obtaining a token

Example

JSON
curl -k --location --request POST 'https://vms.local/api/v1/cameras/{camera}/move' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "up": true,
    "down": true,
    "right": true,
    "left": true,
    "zoom-in": true,
    "zoom-out": true
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.