image.exists

Description

boolean image.exists(object filter)

This method checks if at least one image that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
node string Name of the node the images must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the nodes the images must belong to.
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/api/classes/CImage.php.