Return image dimensions

This function returns the dimensions of the image file that you specify.

Important:

When you disable the WebServer role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

image_file

required

string

The path to the file to measure.

Note:

Use the absolute filepath or a path relative to the user's home directory.

Example: image_file=image/myimage.jpg

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/ImageManager/get_dimensions

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  ImageManager \
  get_dimensions \
  image_file='image/myimage.jpg'

Response samples

application/json

{"apiversion": 3,
"func": "get_dimensions",
"module": "ImageManager",
"result": {"data": {"height": 300,
"width": 261
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}