/imgix | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
imgix_add_asset_from_origin | Add asset from origin |
imgix_create_purge | Purge a cached asset |
imgix_create_source | Create a new Source |
imgix_get_asset | Get a single asset |
imgix_get_report | Get a single report |
imgix_get_source | Get a single Source |
imgix_list_assets | List assets for a Source |
imgix_list_reports | List all reports |
imgix_list_sources | List all Sources |
imgix_publish_asset | Publish an asset |
imgix_refresh_asset | Refresh a cached asset |
imgix_unpublish_asset | Unpublish an asset |
imgix_update_asset | Update asset metadata |
imgix_update_source | Update a Source |
imgix_add_asset_from_origin
Add asset from origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source. |
origin_path | string | Yes | — | The origin path of the asset to add. |
body | object | No | — | Request body |
imgix_create_purge
Purge a cached asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
imgix_create_source
Create a new Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
imgix_get_asset
Get a single asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source. |
origin_path | string | Yes | — | The origin path of the asset (URL-encoded if necessary). |
imgix_get_report
Get a single report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
report_id | string | Yes | — | The ID of the report to retrieve. |
imgix_get_source
Get a single Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source to retrieve. |
imgix_list_assets
List assets for a Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source. |
filter[keyword] | string | No | — | Search across multiple asset fields. |
filter[tags] | string | No | — | Filter by tags (comma-separated, AND logic). |
filter[categories] | string | No | — | Filter by categories (comma-separated, AND logic). |
filter[media_kind] | string | No | — | Filter by media kind (IMAGE, ANIMATION, DOCUMENT, VECTOR). |
filter[origin_path] | string | No | — | Filter by asset origin path. |
sort | string | No | — | Sort results. Options: -date_created, -date_modified, -file_size. |
page[cursor] | string | No | — | Pagination cursor for result sets. |
page[limit] | integer | No | — | Number of results per page. |
imgix_list_reports
List all reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[completed] | boolean | No | — | Filter by completion status. |
filter[report_type] | string | No | — | Filter by report type (image_analytics, source_analytics, cdn_logs, mild_errors). |
sort | string | No | — | Sort results. Options: period_end, period_start, report_key, report_type. Prefix with ’-’ for descending. |
page[number] | integer | No | — | Page number (zero-indexed). |
page[size] | integer | No | — | Number of results per page. |
imgix_list_sources
List all Sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[name] | string | No | — | Filter sources by name (substring match). |
filter[enabled] | boolean | No | — | Filter sources by enabled status. |
filter[deployment.type] | string | No | — | Filter by deployment type (azure, gcs, s3, webfolder, webproxy, s3_compatible). |
sort | string | No | — | Sort results. Prefix with ’-’ for descending. Options: date_deployed, enabled, name. |
page[number] | integer | No | — | Page number (zero-indexed) for pagination. |
page[size] | integer | No | — | Number of results per page. |
imgix_publish_asset
Publish an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
imgix_refresh_asset
Refresh a cached asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source. |
origin_path | string | Yes | — | The origin path of the asset to refresh. |
body | object | No | — | Request body |
imgix_unpublish_asset
Unpublish an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
imgix_update_asset
Update asset metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source. |
origin_path | string | Yes | — | The origin path of the asset. |
data | object | No | — | The data value |
imgix_update_source
Update a Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The ID of the Source to update. |
data | object | No | — | The data value |

