Image Library

Update a library image

Changed on

Update an existing image library entry. If the request body is non-empty the binary data is replaced and the stored MIME type is taken from the Content-Type header. The "name" and "category" query parameters, if present, update the corresponding metadata fields; when absent the existing values are retained. Protected images cannot be modified. Requires the MANAGE_IMAGE_LIB system access right.

put/v1/image-library/{guid}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/image-library/{guid}
  • Auth
    HTTP bearer

Path parameters

guidstring uuid required

Image GUID.

Query parameters

namestring

New image display name.

categorystring

New image category.

Request body image/png

string binary required

Response

Image updated.

guidstring uuid

Unique image identifier.

namestring

Image display name.

categorystring

Image category.

mimeTypestring

Image MIME type (e.g. image/png, image/svg+xml).

isProtectedboolean

Whether the image is a system-protected image that cannot be modified or deleted.

Changes