Table of Contents

Image object

The following objects are directly related to the image API.

Image

The image object has the following properties.

Property Type Description
imageid ID ID of the image.

Property behavior:
- read-only
- required for update operations
name string Name of the image.

Property behavior:
- required for create operations
imagetype integer Type of image.

Possible values:
1 - (default) icon;
2 - background image.

Property behavior:
- constant
- required for create operations
image string Base64 encoded image.
The maximum size of the encoded image is 1 MB. Maximum size can be adjusted by changing ZBX_MAX_IMAGE_SIZE constant value.
Supported image formats: PNG, JPEG, GIF.

Property behavior:
- required for create operations
To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.