image.create

Description

object image.create(object/array images)

This method allows to create new images.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Images to create.

The method accepts images with the standard image properties.

Return values

(object) Returns an object containing the IDs of the created images under the imageids property. The order of the returned IDs matches the order of the passed images.

Examples

Create an icon image

Create a cloud icon.

Request:

{
    "jsonrpc": "2.0",
    "method": "image.create",
    "params": {
        "imagetype": 1,
        "name": "Cloud_(24)",
        "image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAANCAYAAACzbK7QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAACmAAAApgBNtNH3wAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIcSURBVDjLrZLbSxRRHMdPKiEiRQ89CD0s+N5j9BIMEf4Hg/jWexD2ZEXQbC9tWUFZimtLhswuZiVujK1UJmYXW9PaCUdtb83enL3P7s6ss5f5dc7EUsmqkPuFH3M4/Ob7+V0OAgC0UyDENFEU03rh1uNOs/lFG75o2i2/rkd9Y3Tgyj3HiaezbukdH9A/rP4E9vWi0u+Y4fuGnMf3DRgYc3Z/84YrQSkD3mgKhFAC+KAEK74Y2Lj3MjPoOokQ3Xyx/1GHeXCifbfO6lRPH/wi+AvZQhGSsgKxdB5CCRkCGPbDgMXBMbukTc4vK5/WRHizsq7fZl2LFuvE4T0BZDTXHtgv4TNUqlUolsqQL2qQwbDEXzBBTIJ7I4y/cfAENmHZF4XrY9Mc+X9HAFmoyXS2ddy1IOg6/KNyBcM0DFP/wFZFCcOy4N9Mw0YkCTOfhdL5AfZQXQBFn2t/ODXHC8FYVcoWjNEQ03qqwTJ5FdI44jg/msoB2Zd5ZKq3q6evA1FUS60bYyyj3AJf3V72HiLZJQxTtRLk1C2IYEg4mTNg63hPd1mOJd7Ict911OMNlWEf0nFxpCt16zcshTuLpGSwDDuPIfv0xzNyQYVGicC0cgUUDLM6Xp02lvvW/V2EBssnxlSGmWsxljw0znV9XfPLjTCW84r+cn7Jc8c2eWrbM6Wbe6/aTJbhJ/TNkWc9/xXW592Xb9iPkKnUfH8BKdLgFy0lDyQAAAAASUVORK5CYII="
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "imageids": [
            "188"
        ]
    },
    "id": 1
}

Create a background image

Create a small background image to be used as a pattern.

Request:

{
    "jsonrpc": "2.0",
    "method": "image.create",
    "params": {
        "imagetype": 2,
        "name": "background_image",
        "image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAIAAABvFaqvAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kb1Lw0AYxp+miiJVEYuIOGSoTnZREcdahSJUCLVCqw4ml35Bk4YkxcVRcC04+LFYdXBx1tXBVRAEP0D8A8RJ0UVKfC8ptIjxjuN+PPc+D3fvAUK9zDSrIwZoum2mEnExk10Vu14RpNmHAQzJzDLmJCkJ3/F1jwDf76I8y7/uz9Gr5iwGBETiGDNMm3iDeGbTNjjvE4dZUVaJz4knTLog8SPXFY/fOBdcFnhm2Eyn5onDxGKhjZU2ZkVTI54mjqiaTvlCxmOV8xZnrVxlzXvyF4Zy+soy12mNIoFFLEGCCAVVlFCGjSjtOikWUnQe9/GPuH6JXAq5SmDkWEAFGmTXD/4Hv3tr5acmvaRQHOh8cZyPMaBrF2jUHOf72HEaJ0DwGbjSW/5KHZj9JL3W0iJHQP82cHHd0pQ94HIHGH4yZFN2pSAtIZ8H3s/om7LA4C3Qs+b1rXmO0wcgTb1K3gAHh8B4gbLXfd7d3d63f2ua/fsBNgxyjt6uuLsAAAAJcEhZcwAALiMAAC4jAXilP3YAAAAHdElNRQfqAwMOEg/MywcyAAAAGXRFWHRDb21tZW50AENyZWF0ZWQgd2l0aCBHSU1QV4EOFwAAACJJREFUOMtj5HLLYqAGYGKgEhg1aNSgUYNGDRo1aNQg8gEAon8A6hfVTC8AAAAASUVORK5CYII="
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "imageids": [
            "189"
        ]
    },
    "id": 1
}

Source

CImage::create() in ui/include/classes/api/services/CImage.php.