Skip to main content
Server path: /imgix | Type: Application | PCID required: Yes

Tools

ToolDescription
imgix_add_asset_from_originAdd asset from origin
imgix_create_purgePurge a cached asset
imgix_create_sourceCreate a new Source
imgix_get_assetGet a single asset
imgix_get_reportGet a single report
imgix_get_sourceGet a single Source
imgix_list_assetsList assets for a Source
imgix_list_reportsList all reports
imgix_list_sourcesList all Sources
imgix_publish_assetPublish an asset
imgix_refresh_assetRefresh a cached asset
imgix_unpublish_assetUnpublish an asset
imgix_update_assetUpdate asset metadata
imgix_update_sourceUpdate a Source

imgix_add_asset_from_origin

Add asset from origin Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source.
origin_pathstringYesThe origin path of the asset to add.
bodyobjectNoRequest body

imgix_create_purge

Purge a cached asset Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value

imgix_create_source

Create a new Source Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value

imgix_get_asset

Get a single asset Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source.
origin_pathstringYesThe origin path of the asset (URL-encoded if necessary).

imgix_get_report

Get a single report Parameters:
ParameterTypeRequiredDefaultDescription
report_idstringYesThe ID of the report to retrieve.

imgix_get_source

Get a single Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source to retrieve.

imgix_list_assets

List assets for a Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source.
filter[keyword]stringNoSearch across multiple asset fields.
filter[tags]stringNoFilter by tags (comma-separated, AND logic).
filter[categories]stringNoFilter by categories (comma-separated, AND logic).
filter[media_kind]stringNoFilter by media kind (IMAGE, ANIMATION, DOCUMENT, VECTOR).
filter[origin_path]stringNoFilter by asset origin path.
sortstringNoSort results. Options: -date_created, -date_modified, -file_size.
page[cursor]stringNoPagination cursor for result sets.
page[limit]integerNoNumber of results per page.

imgix_list_reports

List all reports Parameters:
ParameterTypeRequiredDefaultDescription
filter[completed]booleanNoFilter by completion status.
filter[report_type]stringNoFilter by report type (image_analytics, source_analytics, cdn_logs, mild_errors).
sortstringNoSort results. Options: period_end, period_start, report_key, report_type. Prefix with ’-’ for descending.
page[number]integerNoPage number (zero-indexed).
page[size]integerNoNumber of results per page.

imgix_list_sources

List all Sources Parameters:
ParameterTypeRequiredDefaultDescription
filter[name]stringNoFilter sources by name (substring match).
filter[enabled]booleanNoFilter sources by enabled status.
filter[deployment.type]stringNoFilter by deployment type (azure, gcs, s3, webfolder, webproxy, s3_compatible).
sortstringNoSort results. Prefix with ’-’ for descending. Options: date_deployed, enabled, name.
page[number]integerNoPage number (zero-indexed) for pagination.
page[size]integerNoNumber of results per page.

imgix_publish_asset

Publish an asset Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value

imgix_refresh_asset

Refresh a cached asset Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source.
origin_pathstringYesThe origin path of the asset to refresh.
bodyobjectNoRequest body

imgix_unpublish_asset

Unpublish an asset Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value

imgix_update_asset

Update asset metadata Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source.
origin_pathstringYesThe origin path of the asset.
dataobjectNoThe data value

imgix_update_source

Update a Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe ID of the Source to update.
dataobjectNoThe data value