Styles

A Style is a custom set of branding that can be applied on a per-folder basis. Currently these support a logo per folder and an optional click-through URL for public visitors. In the future we may extend these to also support colors. If you want to see that, please let us know so we can add your vote to the list.

Show Style

Command

files-cli styles find

Output

Outputs a Style object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--path=
string
Required		Style path.

Example Request

files-cli styles find \
  --path="path"

Update Style

Command

files-cli styles update

Output

Outputs a Style object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Flags

FlagDescription
--path=
string
Required		Style path.
--file=
file		Logo for custom branding. Required when creating a new style. See Attaching Files to API Requests.
--logo-click-href=
string		URL to open when a public visitor clicks the logo.

Example Request

files-cli styles update \
  --path="path" \
  --logo-click-href="https://www.example.com"

Delete Style

Command

files-cli styles delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Flags

FlagDescription
--path=
string
Required		Style path.

Example Request

files-cli styles delete \
  --path="path"

The Style Object

Some of the commands above return a Style object. The attributes of this object are listed below.

AttributeDescription
id
int64		Style ID
path
string		Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
logo
Image		Logo
logo_click_href
string		URL to open when a public visitor clicks the logo
thumbnail
Image		Logo thumbnail