CMS Tool API schema
Public API version 1.4.10.
/api/images/{imagePath}
Read and update images under /images/ for the authenticated website.
Response types
| Name |
|---|
application/json |
application/octet-stream |
GET
Read image metadata, or request binary image content with an image Accept type.
Query parameters
| Name | Type | Example | Notes |
|---|---|---|---|
src | text | /images/112136/example.jpg | Select an image source beginning with /images/. |
POST
Upload an image body, or apply ordered JSON edits in place or to saveAs.
Query parameters
| Name | Type | Example | Notes |
|---|---|---|---|
src | text | /images/112136/example.jpg | Select an image source beginning with /images/. |
Request content type: application/json
Request body fields
| Name | Type | Example | Notes |
|---|---|---|---|
commands | text | example | Set the commands value. |
quality | int | 123 | Set the quality value. |
background | text | example | Set the background value. |
saveAs | text | /images/112136/example.jpg | Save the edited image to this new /images/ path. |
Machine-readable documentation
This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.