Images
Covered in this doc:
​List images​
List all images uploaded within a Site
GET /api/v2/images/?site_id=12345
Name | Type | Description |
|
| optional ID of the |
{"meta": {"limit": 20,"next": "/api/v2/images/?limit=20&offset=20","offset": 0,"previous": null,"total_count": 5},"objects": [{"added": "2012-06-01T09:28:46","height": 1400,"id": 1194687,"image": "img/upload/c1_26.jpg","mimetype": "image/jpeg","modified": "2012-06-01T09:28:46","resource_uri": "/api/v2/images/1194687/","site_id": 12345,"sizes": {"big": "img/upload/c1_26.big.jpg","large": "img/upload/c1_26.large.jpg","medium": "img/upload/c1_26.medium.jpg","original": "img/upload/c1_26.jpg","small": "img/upload/c1_26.small.jpg","thumbnail": "img/upload/c1_26.thumbnail.jpg"},"user_id": 54321,"width": 1304},...]}
Any image file is available publicly using the image parameter from the response and prefixing it with the frontend hostname of your API instance.
Example:
https://yourprivatelabel.cloudfrontend.net/img/upload/c1_26.jpg
If you are using uploaded images within hosted Sites (CSS, HTML, etc), you should reference these images by their local path. You do not want to directly link to yourprivatelabel.cloudfrontend.net.
<img src="/img/upload/c1_26.jpg">
.body { background-image: url('/img/upload/c1_26.jpg'); }
POST /api/v2/images/
Name | Type | Description |
|
| optional Site to upload the image to |
|
| required Publicly accessible url for the image to be fetched by our system and uploaded |
{"site_id": 12345,"external_url": "http://www.examples.com/full/path/to/image.jpg"}
A status code of 201 created is returned on a successful creation and contains the created image object as JSON.
POST /api/v2/images/
Name | Type | Description |
|
| required |
|
| optional |
{"site_id": 12345,"upload": {"name": "image.jpg","file": "iVBORw0KGgoAAAANSUhEUgAAASAAAABsCAIAAABFDPh0AAAAGXRFWHRTb2Z0d2F..."}}
A status code of 201 created is returned on a successful creation and contains the created image object as JSON.
