API Reference - Anthias Digital Signage

assets

get /api/v2/assetsList assets

Responses

200

Array of:

AssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration	integer (int64) \| null
end_date	string (date-time) \| null
is_active*	boolean	read-only
is_enabled	boolean
is_processing	boolean
mimetype	string \| null
name	string \| null
nocache	boolean
play_order	integer (int64)
skip_asset_check	boolean
start_date	string (date-time) \| null
uri	string \| null

post /api/v2/assetsCreate asset

Request body application/json

Schema: CreateAssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration*	integer
end_date*	string (date-time)
ext	string	write-only
is_enabled*	boolean
is_processing	boolean
mimetype*	string
name*	string
nocache	boolean
play_order	integer
skip_asset_check	boolean
start_date*	string (date-time)
uri*	string

Responses

201

Schema: AssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration	integer (int64) \| null
end_date	string (date-time) \| null
is_active*	boolean	read-only
is_enabled	boolean
is_processing	boolean
mimetype	string \| null
name	string \| null
nocache	boolean
play_order	integer (int64)
skip_asset_check	boolean
start_date	string (date-time) \| null
uri	string \| null

get /api/v2/assets/control/{command}Control asset playback

Use any of the following commands to control asset playback: * `next` - Show the next asset * `previous` - Show the previous asset * `asset&{asset_id}` - Show the asset with the specified `asset_id`

Parameters

Name	In	Type	Required
command	path	string	yes

Responses

200

string

post /api/v2/assets/orderUpdate playlist order

Request body application/json

Schema: PlaylistOrderSerializerMixin

Field	Type	Notes
ids*	string	Comma-separated list of asset IDs in the order they should be played. For example: `793406aa1fd34b85aa82614004c0e63a,1c5cfa719d1f4a9abae16c983a18903b,9c41068f3b7e452baf4dc3f9b7906595`write-only

Responses

204 No response body

get /api/v2/assets/{asset_id}Get asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Responses

200

Schema: AssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration	integer (int64) \| null
end_date	string (date-time) \| null
is_active*	boolean	read-only
is_enabled	boolean
is_processing	boolean
mimetype	string \| null
name	string \| null
nocache	boolean
play_order	integer (int64)
skip_asset_check	boolean
start_date	string (date-time) \| null
uri	string \| null

put /api/v2/assets/{asset_id}Update asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Request body application/json

Schema: UpdateAssetSerializerV2

Field	Type	Notes
duration*	integer
end_date*	string (date-time)
is_enabled*	boolean
is_processing	boolean
name*	string
nocache	boolean
play_order	integer
skip_asset_check	boolean
start_date*	string (date-time)

Responses

200

Schema: AssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration	integer (int64) \| null
end_date	string (date-time) \| null
is_active*	boolean	read-only
is_enabled	boolean
is_processing	boolean
mimetype	string \| null
name	string \| null
nocache	boolean
play_order	integer (int64)
skip_asset_check	boolean
start_date	string (date-time) \| null
uri	string \| null

patch /api/v2/assets/{asset_id}Update asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Request body application/json

Schema: PatchedUpdateAssetSerializerV2

Field	Type	Notes
duration	integer
end_date	string (date-time)
is_enabled	boolean
is_processing	boolean
name	string
nocache	boolean
play_order	integer
skip_asset_check	boolean
start_date	string (date-time)

Responses

200

Schema: AssetSerializerV2

Field	Type	Notes
asset_id*	string	read-only
duration	integer (int64) \| null
end_date	string (date-time) \| null
is_active*	boolean	read-only
is_enabled	boolean
is_processing	boolean
mimetype	string \| null
name	string \| null
nocache	boolean
play_order	integer (int64)
skip_asset_check	boolean
start_date	string (date-time) \| null
uri	string \| null

delete /api/v2/assets/{asset_id}Delete asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Responses

204 No response body

get /api/v2/assets/{asset_id}/contentGet asset content

The content of the asset. `type` can either be `file` or `url`. In case of a file, the fields `mimetype`, `filename`, and `content` will be present. In case of a URL, the field `url` will be present.

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Responses

200

Field	Type	Notes
content	string
filename	string
mimetype	string
type	string
url	string

backup

post /api/v2/backupCreate backup

Create a backup of the current Anthias instance, which includes the following: * current settings * image and video assets * asset metadata (e.g. name, duration, play order, status), which is stored in a SQLite database

Responses

201

string

device settings

get /api/v2/device_settingsGet device settings

Responses

200

Schema: DeviceSettingsSerializerV2

Field	Type	Notes
audio_output*	string
auth_backend*	string
date_format*	string
debug_logging*	boolean
default_assets*	boolean
default_duration*	integer
default_streaming_duration*	integer
player_name*	string
show_splash*	boolean
shuffle_playlist*	boolean
use_24_hour_clock*	boolean
username*	string

patch /api/v2/device_settingsUpdate device settings

Request body application/json

Schema: PatchedUpdateDeviceSettingsSerializerV2

Field	Type	Notes
audio_output	string
auth_backend	any
current_password	string
date_format	string
debug_logging	boolean
default_assets	boolean
default_duration	integer
default_streaming_duration	integer
password	string
password_2	string
player_name	string
show_splash	boolean
shuffle_playlist	boolean
use_24_hour_clock	boolean
username	string

Responses

200

Field	Type	Notes
message	string

400

Field	Type	Notes
error	string

file asset

post /api/v2/file_assetUpload file asset

Request body multipart/form-data

Field	Type	Notes
file_upload	string (binary)

Responses

200

Field	Type	Notes
ext	string
uri	string

info

get /api/v2/infoGet system information

Responses

200

Field	Type	Notes
anthias_version	string
device_model	string
display_power	[string null]
free_space	string
host_user	string
ip_addresses	string[]
loadavg	number
mac_address	string
memory	object
up_to_date	boolean
uptime	object
viewlog	string

integrations

get /api/v2/integrationsGet integrations information

Responses

200

Schema: IntegrationsSerializerV2

Field	Type	Notes
balena_app_id	string \| null
balena_app_name	string \| null
balena_device_id	string \| null
balena_device_name_at_init	string \| null
balena_host_os_version	string \| null
balena_supervisor_version	string \| null
is_balena*	boolean

reboot

post /api/v2/rebootReboot system

Responses

200 No response body

recover

post /api/v2/recoverRecover from backup

Recover data from a backup file. The backup file must be a `.tar.gz` file.

Request body multipart/form-data

Field	Type	Notes
backup_upload	string (binary)

Responses

200

string

shutdown

post /api/v2/shutdownShut down system

Responses

200 No response body