API Reference - Anthias Digital Signage

assets

get 0List assets

Responses

Array of:

AssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer (int64) \| null
2	string (date-time) \| null
3	boolean	read-only
4	boolean
5	boolean
6	string \| null
7	string \| null
8	boolean
9	integer (int64)
10	boolean
11	string (date-time) \| null
12	string \| null

post 0Create asset

Request body application/json

Schema: CreateAssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer
2	string (date-time)
3	string	write-only
4	boolean
5	boolean
6	string
7	string
8	boolean
9	integer
10	boolean
11	string (date-time)
12	string

Responses

Schema: AssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer (int64) \| null
2	string (date-time) \| null
3	boolean	read-only
4	boolean
5	boolean
6	string \| null
7	string \| null
8	boolean
9	integer (int64)
10	boolean
11	string (date-time) \| null
12	string \| null

get 1Get asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Responses

Schema: AssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer (int64) \| null
2	string (date-time) \| null
3	boolean	read-only
4	boolean
5	boolean
6	string \| null
7	string \| null
8	boolean
9	integer (int64)
10	boolean
11	string (date-time) \| null
12	string \| null

put 1Update asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Request body application/json

Schema: UpdateAssetSerializerV2

Field	Type	Notes
0	integer
1	string (date-time)
2	boolean
3	boolean
4	string
5	boolean
6	integer
7	boolean
8	string (date-time)

Responses

Schema: AssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer (int64) \| null
2	string (date-time) \| null
3	boolean	read-only
4	boolean
5	boolean
6	string \| null
7	string \| null
8	boolean
9	integer (int64)
10	boolean
11	string (date-time) \| null
12	string \| null

patch 1Update asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Request body application/json

Schema: PatchedUpdateAssetSerializerV2

Field	Type	Notes
0	integer
1	string (date-time)
2	boolean
3	boolean
4	string
5	boolean
6	integer
7	boolean
8	string (date-time)

Responses

Schema: AssetSerializerV2

Field	Type	Notes
0	string	read-only
1	integer (int64) \| null
2	string (date-time) \| null
3	boolean	read-only
4	boolean
5	boolean
6	string \| null
7	string \| null
8	boolean
9	integer (int64)
10	boolean
11	string (date-time) \| null
12	string \| null

delete 1Delete asset

Parameters

Name	In	Type	Required
asset_id	path	string	yes

Responses

0 No response body

get 2Get 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

Field	Type	Notes
0	string
1	string
2	string
3	string
4	string

get 3Control 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

string

post 4Update playlist order

Request body application/json

Schema: PlaylistOrderSerializerMixin

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

Responses

0 No response body

backup

post 5Create 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

string

device settings

get 6Get device settings

Responses

Schema: DeviceSettingsSerializerV2

Field	Type	Notes
0	string
1	string
2	string
3	boolean
4	boolean
5	integer
6	integer
7	string
8	boolean
9	boolean
10	boolean
11	string

patch 6Update device settings

Request body application/json

Schema: PatchedUpdateDeviceSettingsSerializerV2

Field	Type	Notes
0	string
1	any
2	string
3	string
4	boolean
5	boolean
6	integer
7	integer
8	string
9	string
10	string
11	boolean
12	boolean
13	boolean
14	string

Responses

Field	Type	Notes
0	string

Field	Type	Notes
0	string

file asset

post 7Upload file asset

Request body 0

Field	Type	Notes
0	string (binary)

Responses

Field	Type	Notes
0	string
1	string

info

get 8Get system information

Responses

Field	Type	Notes
0	string
1	string
2	[string null]
3	string
4	string
5	string[]
6	number
7	string
8	object
9	boolean
10	object
11	string

integrations

get 9Get integrations information

Responses

Schema: IntegrationsSerializerV2

Field	Type	Notes
0	string \| null
1	string \| null
2	string \| null
3	string \| null
4	string \| null
5	string \| null
6	boolean

reboot

post 10Reboot system

Responses

0 No response body

recover

post 11Recover from backup

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

Request body 0

Field	Type	Notes
0	string (binary)

Responses

string

shutdown

post 12Shut down system

Responses

0 No response body

Field	Type	Notes
0	string \| null
1	string \| null
2	string \| null
3	string \| null
4	string \| null
5	string \| null
6	boolean