Assets Module

Last updated on April 04, 2026.

The Assets module (insites_assets) provides file and folder management for Insites instances. This guide covers the module architecture, v2 API endpoints, data structures, and integration patterns for developers.

Module Information

PropertyValue
Machine Nameinsites_assets
Current Version5.2.0
Slugassets
LabelAssets

v2 API Endpoints

The Assets module exposes seven v2 API endpoints. All endpoints require a valid instance API key passed in the Authorization header. For full API documentation including request and response examples, visit /admin/api.

Asset Endpoints

MethodEndpointDescription
GET/all_assets/api/v2/assetsList assets. Supports filtering by folder, tags, and pagination.
GET/all_assets/api/v2/assets/{id}Get a single asset by its numeric ID.
POST/all_assets/api/v2/assetsCreate a new asset record.
DELETE/all_assets/api/v2/assets/{id}Permanently delete an asset by ID or by physical file path.
PATCH/all_assets/api/v2/assets/{id}/archiveArchive an asset (soft delete).

Folder Endpoints

MethodEndpointDescription
POST/all_assets/api/v2/foldersCreate a new folder.
DELETE/all_assets/api/v2/foldersDelete a folder and all its contents.

Data Structures

Asset Object

FieldTypeDescription
idIntegerAuto-assigned numeric ID. Note: this is an integer, not a UUID like other Insites modules.
nameStringFull path name of the asset, including the folder structure.
physical_file_pathStringPhysical storage path of the file.
urlStringCDN URL where the asset can be accessed directly.
metadataObjectContains is_archived (string), tags (array of strings), and administrator_uuid (string).
created_atDateTimeISO 8601 timestamp of when the asset was created.
updated_atDateTimeISO 8601 timestamp of when the asset was last modified.

Folder Object

FieldTypeDescription
idIntegerAuto-assigned numeric ID.
nameStringFull folder path.
created_atDateTimeISO 8601 timestamp.
updated_atDateTimeISO 8601 timestamp.

Metadata Object

FieldTypeDefaultDescription
is_archivedStringfalseWhether the asset is archived. Stored as a string, not a boolean.
tagsArray[]Array of tag strings for categorization and search.
administrator_uuidString(auto-set)UUID of the administrator who last modified the asset.

Rendering Assets

Assets can be rendered in your pages and templates using Liquid tags or direct URLs.

Liquid Tag

Use the asset_url Liquid filter to generate a URL for an asset:

{{ 'path/to/file.png' | asset_url }}

You can copy the ready-to-use Liquid code snippet from the file detail panel in the Assets admin interface.

Direct URL

Each asset has a direct CDN URL that can be used in Markdown, HTML, or external applications. The URL is available in the file detail panel under the URL field.

Event Stream Integration

The Assets module integrates with the Insites Event Stream to track all file and folder activity. Events are created server-side when files or folders are added, edited, deleted, archived, or restored. Each event records the administrator, the asset name, and a timestamp.

The Event Stream is accessible from the Assets sidebar under Event Stream.

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.