5. File paths in scripts
A file uploaded through the application is usually needed not by itself but by reference: from a script, from an external system, or from a site page. Each of these references has its own form, and all of them are collected in the file details panel.
Where to get them
The Copy block in the details panel; the same block exists for the selected folder. The button to the right of a row copies the whole value even if it does not fit on the screen.
A row appears only if the section has it: without a macro prefix there is no script path, without publication there is no public link.
Script path
Starts with a macro prefix — :SYNC_COMMON, :GS_PUB, :SS_PUB, and others.
The macro prefix points not to a specific server directory but to its role:
the required directory is substituted on the server where the script executes. For details
on directory types and why direct paths are prohibited in scripts, see the article
Local paths.
This is the value substituted into script components that work with files: playback, recording, template reading.
API URL
The file address in the REST API. Both the application itself and you, when
accessing files with curl or another tool, use it.
Access to this address is determined by the account role: a domain administrator has it; for others it is granted by a role that allows the required endpoint and method — separately for reading and separately for writing. Therefore an external system that really needs to access files works under its own account with such a role; access to these addresses without permission configuration is not something to aim for.
Descriptions of methods, parameters, and responses are in the File section API section.
Public link
Available for sections whose content is published externally — for example, domain files for publication. The link is built from the section template and contains the domain, so it differs between domains.
A public link opens without signing in: everything you put in such a section is available, including to anonymous visitors.