Distribution control
The named country sets an asset's public reach is built from, and which of them the whole workspace is held to.
Get the delivery settings
The hostname permanent URLs are issued against and the image drawn over watermarked renditions. An unset hostname means the platform default, which is what almost every workspace uses.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get the delivery settings › Responses
Success
hostnamehostname_defaultwatermark_filewatermark_nameUpdate the delivery settings
Point published URLs at your own subdomain by sending its hostname and a CNAME to the platform hostname; send null to go back to the default. A hostname already claimed by another workspace is refused. Changing it moves the URLs shown for every published asset, and the previous hostname keeps resolving so links already in circulation are not broken.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update the delivery settings › Request Body optional
hostnamewatermark_fileUpdate the delivery settings › Responses
Success
List geo restrictions
The workspace's named country sets, with how many published assets reference each. Every country in one is blocked. A set marked geo_workspace_wide blocks on every published asset whether or not the asset names it.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List geo restrictions › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Add a geo restriction
Pass template to start from one of the shipped catalogs. It fills the countries when you send none of your own, and records which catalog it came from either way. A catalog is copied once and owned by the workspace from that moment; it is never updated for you.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Add a geo restriction › Request Body
geo_nametemplategeo_countriesgeo_workspace_wideAdd a geo restriction › Responses
Created
geo_idgeo_namegeo_workspace_widegeo_sourcegeo_activegeo_createdgeo_updatedgeo_countriesgeo_usageGet a geo restriction
One restriction and the countries it blocks, as ISO 3166-1 alpha-2 codes.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a geo restriction › Responses
Success
geo_idgeo_namegeo_workspace_widegeo_sourcegeo_activegeo_createdgeo_updatedgeo_countriesgeo_usageDelete a restriction
Deactivates the restriction and stops it fencing anything. Assets referencing it keep serving.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a restriction › Responses
Success. No content.
Edit a geo restriction
Editing the countries or the workspace-wide flag reaches every asset the restriction governs on the next edge refresh, within about a minute. No asset is rewritten.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Edit a geo restriction › Request Body optional
geo_namegeo_countriesgeo_workspace_wideEdit a geo restriction › Responses
Success
geo_idgeo_namegeo_workspace_widegeo_sourcegeo_activegeo_createdgeo_updatedgeo_countriesgeo_usageList starter catalogs
Shipped country sets for common regimes, offered as a starting point to copy and verify against the workspace's own trade compliance requirements. They are static data, not a maintained authority.
Requires the module-publication license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List starter catalogs › Responses
Success
idnamecountries