image.exists
Description
boolean image.exists(object filter)
This method checks if at least one image that matches the given filter criteria exists.
This method is deprecated and will be removed in the future. Please use image.get instead.
Parameters
(object) Criteria to search by.
The following parameters are supported as search criteria.
| Parameter | Type | Description |
|---|---|---|
| imageid | string/array | IDs of images. |
| imagetype | integer/array | Types of images. Refer to the image "imagetype" property for a list of supported types. |
| name | string/array | Names of images. |
Return values
(boolean) Returns true if at least one image that matches the given
filter criteria exists.
Examples
Check image by name
Check if an image called "Cloud_(96)" exists.
Request:
{
"jsonrpc": "2.0",
"method": "image.exists",
"params": {
"name": "Cloud_(96)"
},
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}Source
CImage::exists() in frontends/php/include/classes/api/services/CImage.php.