System
Get System Configuration
Endpoint
GET /api/v1/systemRequired roles
admin:rDescription
This endpoint provides the current state of the device's configuration.
The response body will be a JSON encoded object, conforming to the system JSON-Schema:
Schema
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"airplay": {
"const": "password"
}
},
"required": [
"airplay"
]
},
"then": {
"required": [
"airplay_password"
]
}
},
{
"if": {
"properties": {
"device_show_own_guest_network": {
"const": true
}
},
"required": [
"device_show_own_guest_network"
]
},
"then": {
"required": [
"guest_network_ssid"
]
}
},
{
"if": {
"properties": {
"guest_network_ssid": {
"type": "string"
}
},
"required": [
"guest_network_ssid"
]
},
"then": {
"required": [
"guest_network_password"
]
}
},
{
"if": {
"properties": {
"8021x_username": {
"type": "string"
}
},
"required": [
"8021x_username"
]
},
"then": {
"required": [
"8021x_password"
]
}
},
{
"if": {
"properties": {
"proxy_hostname": {
"type": "string"
}
},
"required": [
"proxy_hostname"
]
},
"then": {
"required": [
"proxy_port"
]
}
},
{
"if": {
"properties": {
"systemd_journal_upload_hostname": {
"type": "string"
}
},
"required": [
"systemd_journal_upload_hostname"
]
},
"then": {
"required": [
"systemd_journal_upload_tls_authority",
"systemd_journal_upload_tls_certificate",
"systemd_journal_upload_tls_private_key"
]
}
},
{
"if": {
"properties": {
"webmanagement_tls_certificate": {
"type": "string"
}
},
"required": [
"webmanagement_tls_certificate"
]
},
"then": {
"required": [
"webmanagement_tls_key"
]
}
},
{
"if": {
"properties": {
"wifi_client_ssid": {
"type": "string"
}
},
"required": [
"wifi_client_ssid"
]
},
"then": {
"required": [
"wifi_client_password"
]
}
},
{
"if": {
"properties": {
"wifi_client_authentication_username": {
"type": "string"
}
},
"required": [
"wifi_client_authentication_username"
]
},
"then": {
"required": [
"wifi_client_authentication_password"
]
}
}
],
"properties": {
"8021x_password": {
"type": "string",
"writeOnly": true
},
"8021x_username": {
"type": "string"
},
"admin_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"airplay": {
"enum": [
"off",
"everyone",
"code",
"password",
"prompt"
],
"type": "string"
},
"airplay_audio_only_enabled": {
"type": "boolean"
},
"airplay_password": {
"maxLength": 32,
"type": "string"
},
"api_enabled": {
"type": "boolean"
},
"api_key": {
"minLength": 1,
"type": "string"
},
"audio_sample_rate": {
"enum": [
"44100 Hz",
"48000 Hz",
"96000 Hz",
"192000 Hz"
],
"type": "string"
},
"audio_usb": {
"type": "boolean"
},
"cloud_organization": {
"readOnly": true,
"type": "string"
},
"cloud_organization_key": {
"minLength": 1,
"type": "string"
},
"cloud_token": {
"readOnly": true,
"type": "string"
},
"device_background": {
"$comment": "Size limited to improve browser compatibility",
"maxLength": 2097152,
"pattern": "(^(http:|https:|data:(image/jpeg|image/png|image/svg\\+xml);base64,))|(^$)",
"type": "string"
},
"device_clock": {
"enum": [
"12-hour",
"24-hour"
],
"type": "string"
},
"device_country_code": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[a-z]+$",
"type": "string"
},
"device_homescreen_layout": {
"enum": [
"full",
"full-center",
"full-left",
"full-right",
"minimal",
"none"
],
"type": "string"
},
"device_hostname": {
"readOnly": true,
"type": "string"
},
"device_language": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[a-z]+$",
"type": "string"
},
"device_model": {
"readOnly": true,
"type": "string"
},
"device_name": {
"maxLength": 32,
"type": "string"
},
"device_serial": {
"readOnly": true,
"type": "string"
},
"device_session_layout": {
"enum": [
"default",
"grid",
"single"
],
"type": "string"
},
"device_show_airserver_logo": {
"type": "boolean"
},
"device_show_guest_access_while_in_use": {
"type": "boolean"
},
"device_show_how_to_connect": {
"type": "boolean"
},
"device_show_ip_address": {
"type": "boolean"
},
"device_show_own_guest_network": {
"type": "boolean"
},
"device_show_qr_code": {
"type": "boolean"
},
"device_system_boot_time": {
"readOnly": true,
"type": "string"
},
"device_system_version": {
"readOnly": true,
"type": "string"
},
"device_timezone": {
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"America/Adak",
"Africa/Addis_Ababa",
"Australia/Adelaide",
"Asia/Aden",
"Africa/Algiers",
"Asia/Almaty",
"Asia/Amman",
"Europe/Amsterdam",
"Asia/Anadyr",
"America/Anchorage",
"Europe/Andorra",
"America/Anguilla",
"Indian/Antananarivo",
"America/Antigua",
"Pacific/Apia",
"Asia/Aqtau",
"Asia/Aqtobe",
"America/Araguaina",
"America/Aruba",
"Asia/Ashgabat",
"Africa/Asmara",
"Europe/Astrakhan",
"America/Asuncion",
"Europe/Athens",
"America/Atikokan",
"Asia/Atyrau",
"Pacific/Auckland",
"Atlantic/Azores",
"Asia/Baghdad",
"America/Bahia",
"America/Bahia_Banderas",
"Asia/Bahrain",
"Asia/Baku",
"Africa/Bamako",
"Asia/Bangkok",
"Africa/Bangui",
"Africa/Banjul",
"America/Barbados",
"Asia/Barnaul",
"Asia/Beirut",
"America/Belem",
"Europe/Belgrade",
"America/Belize",
"Europe/Berlin",
"Atlantic/Bermuda",
"America/North_Dakota/Beulah",
"Asia/Bishkek",
"Africa/Bissau",
"America/Blanc-Sablon",
"Africa/Blantyre",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"Pacific/Bougainville",
"Europe/Bratislava",
"Africa/Brazzaville",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Asia/Brunei",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"America/Argentina/Buenos_Aires",
"Africa/Bujumbura",
"Europe/Busingen",
"Africa/Cairo",
"America/Cambridge_Bay",
"America/Campo_Grande",
"Atlantic/Canary",
"America/Cancun",
"Atlantic/Cape_Verde",
"America/Caracas",
"Africa/Casablanca",
"Antarctica/Casey",
"America/Argentina/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/North_Dakota/Center",
"Africa/Ceuta",
"Indian/Chagos",
"Pacific/Chatham",
"America/Chicago",
"America/Chihuahua",
"Europe/Chisinau",
"Asia/Chita",
"Asia/Choibalsan",
"Indian/Christmas",
"Pacific/Chuuk",
"America/Ciudad_Juarez",
"Indian/Cocos",
"Asia/Colombo",
"Indian/Comoro",
"Africa/Conakry",
"Europe/Copenhagen",
"America/Argentina/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"Africa/Dakar",
"Asia/Damascus",
"America/Danmarkshavn",
"Africa/Dar_es_Salaam",
"Australia/Darwin",
"Antarctica/Davis",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"Asia/Dhaka",
"Asia/Dili",
"Africa/Djibouti",
"America/Dominica",
"Africa/Douala",
"Asia/Dubai",
"Europe/Dublin",
"Antarctica/DumontDUrville",
"Asia/Dushanbe",
"Pacific/Easter",
"America/Edmonton",
"Pacific/Efate",
"America/Eirunepe",
"Africa/El_Aaiun",
"America/El_Salvador",
"Pacific/Enderbury",
"Australia/Eucla",
"Pacific/Fakaofo",
"Asia/Famagusta",
"Atlantic/Faroe",
"Pacific/Fiji",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"Africa/Freetown",
"Pacific/Funafuti",
"Africa/Gaborone",
"Pacific/Galapagos",
"Pacific/Gambier",
"Asia/Gaza",
"Europe/Gibraltar",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"Pacific/Guadalcanal",
"America/Guadeloupe",
"Pacific/Guam",
"America/Guatemala",
"America/Guayaquil",
"Europe/Guernsey",
"America/Guyana",
"America/Halifax",
"Africa/Harare",
"America/Havana",
"Asia/Hebron",
"Europe/Helsinki",
"America/Hermosillo",
"Asia/Ho_Chi_Minh",
"Australia/Hobart",
"Asia/Hong_Kong",
"Pacific/Honolulu",
"Asia/Hovd",
"America/Indiana/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"Asia/Irkutsk",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Asia/Jakarta",
"America/Jamaica",
"Asia/Jayapura",
"Europe/Jersey",
"Asia/Jerusalem",
"Africa/Johannesburg",
"Africa/Juba",
"America/Argentina/Jujuy",
"America/Juneau",
"Asia/Kabul",
"Europe/Kaliningrad",
"Asia/Kamchatka",
"Africa/Kampala",
"Pacific/Kanton",
"Asia/Karachi",
"Asia/Kathmandu",
"Indian/Kerguelen",
"Asia/Khandyga",
"Africa/Khartoum",
"Europe/Kiev",
"Africa/Kigali",
"Africa/Kinshasa",
"Pacific/Kiritimati",
"Europe/Kirov",
"America/Indiana/Knox",
"Asia/Kolkata",
"Pacific/Kosrae",
"America/Kralendijk",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Pacific/Kwajalein",
"Europe/Kyiv",
"America/La_Paz",
"America/Argentina/La_Rioja",
"Africa/Lagos",
"Africa/Libreville",
"America/Lima",
"Australia/Lindeman",
"Europe/Lisbon",
"Europe/Ljubljana",
"Africa/Lome",
"Europe/London",
"Arctic/Longyearbyen",
"Australia/Lord_Howe",
"America/Los_Angeles",
"America/Kentucky/Louisville",
"America/Lower_Princes",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Europe/Luxembourg",
"Asia/Macau",
"America/Maceio",
"Antarctica/Macquarie",
"Atlantic/Madeira",
"Europe/Madrid",
"Asia/Magadan",
"Indian/Mahe",
"Pacific/Majuro",
"Asia/Makassar",
"Africa/Malabo",
"Indian/Maldives",
"Europe/Malta",
"America/Managua",
"America/Manaus",
"Asia/Manila",
"Africa/Maputo",
"America/Indiana/Marengo",
"Europe/Mariehamn",
"America/Marigot",
"Pacific/Marquesas",
"America/Martinique",
"Africa/Maseru",
"America/Matamoros",
"Indian/Mauritius",
"Antarctica/Mawson",
"Indian/Mayotte",
"America/Mazatlan",
"Africa/Mbabane",
"Antarctica/McMurdo",
"Australia/Melbourne",
"America/Argentina/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"Pacific/Midway",
"Europe/Minsk",
"America/Miquelon",
"Africa/Mogadishu",
"Europe/Monaco",
"America/Moncton",
"Africa/Monrovia",
"America/Monterrey",
"America/Montevideo",
"America/Kentucky/Monticello",
"America/Montserrat",
"Europe/Moscow",
"Asia/Muscat",
"Africa/Nairobi",
"America/Nassau",
"Pacific/Nauru",
"Africa/Ndjamena",
"America/North_Dakota/New_Salem",
"America/New_York",
"Africa/Niamey",
"Asia/Nicosia",
"Pacific/Niue",
"America/Nome",
"Pacific/Norfolk",
"America/Noronha",
"Africa/Nouakchott",
"Pacific/Noumea",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"America/Nuuk",
"America/Ojinaga",
"Asia/Omsk",
"Asia/Oral",
"Europe/Oslo",
"Africa/Ouagadougou",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Antarctica/Palmer",
"America/Panama",
"America/Paramaribo",
"Europe/Paris",
"Australia/Perth",
"America/Indiana/Petersburg",
"Asia/Phnom_Penh",
"America/Phoenix",
"Pacific/Pitcairn",
"Europe/Podgorica",
"Pacific/Pohnpei",
"Asia/Pontianak",
"Pacific/Port_Moresby",
"America/Port_of_Spain",
"America/Port-au-Prince",
"America/Porto_Velho",
"Africa/Porto-Novo",
"Europe/Prague",
"America/Puerto_Rico",
"America/Punta_Arenas",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"America/Rankin_Inlet",
"Pacific/Rarotonga",
"America/Recife",
"America/Regina",
"America/Resolute",
"Indian/Reunion",
"Atlantic/Reykjavik",
"Europe/Riga",
"America/Rio_Branco",
"America/Argentina/Rio_Gallegos",
"Asia/Riyadh",
"Europe/Rome",
"Antarctica/Rothera",
"Pacific/Saipan",
"Asia/Sakhalin",
"America/Argentina/Salta",
"Europe/Samara",
"Asia/Samarkand",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"Europe/San_Marino",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"Africa/Sao_Tome",
"Europe/Sarajevo",
"Europe/Saratov",
"America/Scoresbysund",
"Asia/Seoul",
"Asia/Shanghai",
"Europe/Simferopol",
"Asia/Singapore",
"America/Sitka",
"Europe/Skopje",
"Europe/Sofia",
"Atlantic/South_Georgia",
"Asia/Srednekolymsk",
"America/St_Barthelemy",
"Atlantic/St_Helena",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"Atlantic/Stanley",
"Europe/Stockholm",
"America/Swift_Current",
"Australia/Sydney",
"Antarctica/Syowa",
"Pacific/Tahiti",
"Asia/Taipei",
"Europe/Tallinn",
"Pacific/Tarawa",
"Asia/Tashkent",
"Asia/Tbilisi",
"America/Tegucigalpa",
"Asia/Tehran",
"America/Indiana/Tell_City",
"Asia/Thimphu",
"America/Thule",
"America/Tijuana",
"Europe/Tirane",
"Asia/Tokyo",
"Asia/Tomsk",
"Pacific/Tongatapu",
"America/Toronto",
"America/Tortola",
"Africa/Tripoli",
"Antarctica/Troll",
"America/Argentina/Tucuman",
"Africa/Tunis",
"Asia/Ulaanbaatar",
"Europe/Ulyanovsk",
"Asia/Urumqi",
"America/Argentina/Ushuaia",
"Asia/Ust-Nera",
"UTC",
"Europe/Vaduz",
"America/Vancouver",
"Europe/Vatican",
"America/Indiana/Vevay",
"Europe/Vienna",
"Asia/Vientiane",
"Europe/Vilnius",
"America/Indiana/Vincennes",
"Asia/Vladivostok",
"Europe/Volgograd",
"Antarctica/Vostok",
"Pacific/Wake",
"Pacific/Wallis",
"Europe/Warsaw",
"America/Whitehorse",
"America/Indiana/Winamac",
"Africa/Windhoek",
"America/Winnipeg",
"America/Yakutat",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Europe/Zagreb",
"Europe/Zurich"
],
"type": "string"
},
"display_cec_enabled": {
"type": "boolean"
},
"display_limit_720": {
"type": "boolean"
},
"display_sleep_timer": {
"enum": [
"never",
"immediate",
"one_minute",
"fifteen_minutes",
"three_hours"
],
"type": "string"
},
"googlecast": {
"enum": [
"off",
"everyone",
"prompt"
],
"type": "string"
},
"guest_network_password": {
"type": "string"
},
"guest_network_ssid": {
"type": "string"
},
"hotspot_access": {
"enum": [
"none",
"lan",
"internet",
"internet+lan"
],
"type": "string"
},
"hotspot_channel_width": {
"enum": [
20,
40,
80,
160
],
"type": "number"
},
"hotspot_client_isolation": {
"type": "boolean"
},
"hotspot_enabled": {
"type": "boolean"
},
"hotspot_frequency": {
"minimum": 0,
"type": "integer"
},
"hotspot_password": {
"maxLength": 63,
"type": "string"
},
"livestreaming_enabled": {
"type": "boolean"
},
"livestreaming_password": {
"minLength": 1,
"type": "string"
},
"livestreaming_quality": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"livestreaming_rtsp": {
"type": "boolean"
},
"miracast": {
"enum": [
"off",
"everyone",
"pin8",
"pin4",
"prompt"
],
"type": "string"
},
"miracast_channel_width": {
"enum": [
20,
40,
80,
160
],
"type": "number"
},
"miracast_frequency": {
"minimum": 0,
"type": "integer"
},
"miracast_infracast": {
"type": "boolean"
},
"moderator_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"moderator_require_approval": {
"type": "boolean"
},
"proxy_hostname": {
"maxLength": 253,
"type": "string"
},
"proxy_port": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"systemd_journal_upload_hostname": {
"type": "string"
},
"systemd_journal_upload_port": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"systemd_journal_upload_tls_authority": {
"type": "string"
},
"systemd_journal_upload_tls_certificate": {
"type": "string"
},
"systemd_journal_upload_tls_private_key": {
"type": "string",
"writeOnly": true
},
"updater_allow_automatic_updates": {
"type": "boolean"
},
"updater_channel": {
"enum": [
"stable",
"release-candidate",
"preview"
],
"type": "string"
},
"webmanagement_tls_certificate": {
"minLength": 1,
"type": "string"
},
"webmanagement_tls_key": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_authentication_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_authentication_username": {
"minLength": 1,
"type": "string"
},
"wifi_client_enabled": {
"type": "boolean"
},
"wifi_client_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_ssid": {
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
HTTP response status codes
| Status code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
Example
- curl
- JavaScript
curl https://{your AirServer hostname}/api/v1/system \
-X GET \
-H 'Authorization: Bearer {your AirServer Connect API key or JWT token}'
const apiKey = "{your AirServer Connect API key or JWT token}";
const fetchOptions = {
headers: {
Authorization: "Bearer " + apiKey
}
};
const response = await fetch("https://{your AirServer hostname}/api/v1/system", fetchOptions);
if (!response.ok) {
console.log("Error while trying to read config")
}
Modify System Configuration
Endpoint
PATCH /api/v1/systemRequired roles
admin:wDescription
Here you can modify the current system configuration.
A change that fails to conform to the schema will be rejected atomically, so that no partial changes will be applied from a rejected object.
These changes will trigger events to be emitted from the Events endpoint,
with an event type of "system.changed".
JSON objects which do not conform to the schema, will result in a 400 error and
an error message that explains why the request was rejected.
Parameters
Body parameters
A JSON encoded object, conforming to the system JSON-Schema:
Schema
{
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"airplay": {
"const": "password"
}
},
"required": [
"airplay"
]
},
"then": {
"required": [
"airplay_password"
]
}
},
{
"if": {
"properties": {
"device_show_own_guest_network": {
"const": true
}
},
"required": [
"device_show_own_guest_network"
]
},
"then": {
"required": [
"guest_network_ssid"
]
}
},
{
"if": {
"properties": {
"guest_network_ssid": {
"type": "string"
}
},
"required": [
"guest_network_ssid"
]
},
"then": {
"required": [
"guest_network_password"
]
}
},
{
"if": {
"properties": {
"8021x_username": {
"type": "string"
}
},
"required": [
"8021x_username"
]
},
"then": {
"required": [
"8021x_password"
]
}
},
{
"if": {
"properties": {
"proxy_hostname": {
"type": "string"
}
},
"required": [
"proxy_hostname"
]
},
"then": {
"required": [
"proxy_port"
]
}
},
{
"if": {
"properties": {
"systemd_journal_upload_hostname": {
"type": "string"
}
},
"required": [
"systemd_journal_upload_hostname"
]
},
"then": {
"required": [
"systemd_journal_upload_tls_authority",
"systemd_journal_upload_tls_certificate",
"systemd_journal_upload_tls_private_key"
]
}
},
{
"if": {
"properties": {
"webmanagement_tls_certificate": {
"type": "string"
}
},
"required": [
"webmanagement_tls_certificate"
]
},
"then": {
"required": [
"webmanagement_tls_key"
]
}
},
{
"if": {
"properties": {
"wifi_client_ssid": {
"type": "string"
}
},
"required": [
"wifi_client_ssid"
]
},
"then": {
"required": [
"wifi_client_password"
]
}
},
{
"if": {
"properties": {
"wifi_client_authentication_username": {
"type": "string"
}
},
"required": [
"wifi_client_authentication_username"
]
},
"then": {
"required": [
"wifi_client_authentication_password"
]
}
}
],
"properties": {
"8021x_password": {
"type": "string",
"writeOnly": true
},
"8021x_username": {
"type": "string"
},
"admin_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"airplay": {
"enum": [
"off",
"everyone",
"code",
"password",
"prompt"
],
"type": "string"
},
"airplay_audio_only_enabled": {
"type": "boolean"
},
"airplay_password": {
"maxLength": 32,
"type": "string"
},
"api_enabled": {
"type": "boolean"
},
"api_key": {
"minLength": 1,
"type": "string"
},
"audio_sample_rate": {
"enum": [
"44100 Hz",
"48000 Hz",
"96000 Hz",
"192000 Hz"
],
"type": "string"
},
"audio_usb": {
"type": "boolean"
},
"cloud_organization": {
"readOnly": true,
"type": "string"
},
"cloud_organization_key": {
"minLength": 1,
"type": "string"
},
"cloud_token": {
"readOnly": true,
"type": "string"
},
"device_background": {
"$comment": "Size limited to improve browser compatibility",
"maxLength": 2097152,
"pattern": "(^(http:|https:|data:(image/jpeg|image/png|image/svg\\+xml);base64,))|(^$)",
"type": "string"
},
"device_clock": {
"enum": [
"12-hour",
"24-hour"
],
"type": "string"
},
"device_country_code": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[a-z]+$",
"type": "string"
},
"device_homescreen_layout": {
"enum": [
"full",
"full-center",
"full-left",
"full-right",
"minimal",
"none"
],
"type": "string"
},
"device_hostname": {
"readOnly": true,
"type": "string"
},
"device_language": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[a-z]+$",
"type": "string"
},
"device_model": {
"readOnly": true,
"type": "string"
},
"device_name": {
"maxLength": 32,
"type": "string"
},
"device_serial": {
"readOnly": true,
"type": "string"
},
"device_session_layout": {
"enum": [
"default",
"grid",
"single"
],
"type": "string"
},
"device_show_airserver_logo": {
"type": "boolean"
},
"device_show_guest_access_while_in_use": {
"type": "boolean"
},
"device_show_how_to_connect": {
"type": "boolean"
},
"device_show_ip_address": {
"type": "boolean"
},
"device_show_own_guest_network": {
"type": "boolean"
},
"device_show_qr_code": {
"type": "boolean"
},
"device_system_boot_time": {
"readOnly": true,
"type": "string"
},
"device_system_version": {
"readOnly": true,
"type": "string"
},
"device_timezone": {
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"America/Adak",
"Africa/Addis_Ababa",
"Australia/Adelaide",
"Asia/Aden",
"Africa/Algiers",
"Asia/Almaty",
"Asia/Amman",
"Europe/Amsterdam",
"Asia/Anadyr",
"America/Anchorage",
"Europe/Andorra",
"America/Anguilla",
"Indian/Antananarivo",
"America/Antigua",
"Pacific/Apia",
"Asia/Aqtau",
"Asia/Aqtobe",
"America/Araguaina",
"America/Aruba",
"Asia/Ashgabat",
"Africa/Asmara",
"Europe/Astrakhan",
"America/Asuncion",
"Europe/Athens",
"America/Atikokan",
"Asia/Atyrau",
"Pacific/Auckland",
"Atlantic/Azores",
"Asia/Baghdad",
"America/Bahia",
"America/Bahia_Banderas",
"Asia/Bahrain",
"Asia/Baku",
"Africa/Bamako",
"Asia/Bangkok",
"Africa/Bangui",
"Africa/Banjul",
"America/Barbados",
"Asia/Barnaul",
"Asia/Beirut",
"America/Belem",
"Europe/Belgrade",
"America/Belize",
"Europe/Berlin",
"Atlantic/Bermuda",
"America/North_Dakota/Beulah",
"Asia/Bishkek",
"Africa/Bissau",
"America/Blanc-Sablon",
"Africa/Blantyre",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"Pacific/Bougainville",
"Europe/Bratislava",
"Africa/Brazzaville",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Asia/Brunei",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"America/Argentina/Buenos_Aires",
"Africa/Bujumbura",
"Europe/Busingen",
"Africa/Cairo",
"America/Cambridge_Bay",
"America/Campo_Grande",
"Atlantic/Canary",
"America/Cancun",
"Atlantic/Cape_Verde",
"America/Caracas",
"Africa/Casablanca",
"Antarctica/Casey",
"America/Argentina/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/North_Dakota/Center",
"Africa/Ceuta",
"Indian/Chagos",
"Pacific/Chatham",
"America/Chicago",
"America/Chihuahua",
"Europe/Chisinau",
"Asia/Chita",
"Asia/Choibalsan",
"Indian/Christmas",
"Pacific/Chuuk",
"America/Ciudad_Juarez",
"Indian/Cocos",
"Asia/Colombo",
"Indian/Comoro",
"Africa/Conakry",
"Europe/Copenhagen",
"America/Argentina/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"Africa/Dakar",
"Asia/Damascus",
"America/Danmarkshavn",
"Africa/Dar_es_Salaam",
"Australia/Darwin",
"Antarctica/Davis",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"Asia/Dhaka",
"Asia/Dili",
"Africa/Djibouti",
"America/Dominica",
"Africa/Douala",
"Asia/Dubai",
"Europe/Dublin",
"Antarctica/DumontDUrville",
"Asia/Dushanbe",
"Pacific/Easter",
"America/Edmonton",
"Pacific/Efate",
"America/Eirunepe",
"Africa/El_Aaiun",
"America/El_Salvador",
"Pacific/Enderbury",
"Australia/Eucla",
"Pacific/Fakaofo",
"Asia/Famagusta",
"Atlantic/Faroe",
"Pacific/Fiji",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"Africa/Freetown",
"Pacific/Funafuti",
"Africa/Gaborone",
"Pacific/Galapagos",
"Pacific/Gambier",
"Asia/Gaza",
"Europe/Gibraltar",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"Pacific/Guadalcanal",
"America/Guadeloupe",
"Pacific/Guam",
"America/Guatemala",
"America/Guayaquil",
"Europe/Guernsey",
"America/Guyana",
"America/Halifax",
"Africa/Harare",
"America/Havana",
"Asia/Hebron",
"Europe/Helsinki",
"America/Hermosillo",
"Asia/Ho_Chi_Minh",
"Australia/Hobart",
"Asia/Hong_Kong",
"Pacific/Honolulu",
"Asia/Hovd",
"America/Indiana/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"Asia/Irkutsk",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Asia/Jakarta",
"America/Jamaica",
"Asia/Jayapura",
"Europe/Jersey",
"Asia/Jerusalem",
"Africa/Johannesburg",
"Africa/Juba",
"America/Argentina/Jujuy",
"America/Juneau",
"Asia/Kabul",
"Europe/Kaliningrad",
"Asia/Kamchatka",
"Africa/Kampala",
"Pacific/Kanton",
"Asia/Karachi",
"Asia/Kathmandu",
"Indian/Kerguelen",
"Asia/Khandyga",
"Africa/Khartoum",
"Europe/Kiev",
"Africa/Kigali",
"Africa/Kinshasa",
"Pacific/Kiritimati",
"Europe/Kirov",
"America/Indiana/Knox",
"Asia/Kolkata",
"Pacific/Kosrae",
"America/Kralendijk",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Pacific/Kwajalein",
"Europe/Kyiv",
"America/La_Paz",
"America/Argentina/La_Rioja",
"Africa/Lagos",
"Africa/Libreville",
"America/Lima",
"Australia/Lindeman",
"Europe/Lisbon",
"Europe/Ljubljana",
"Africa/Lome",
"Europe/London",
"Arctic/Longyearbyen",
"Australia/Lord_Howe",
"America/Los_Angeles",
"America/Kentucky/Louisville",
"America/Lower_Princes",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Europe/Luxembourg",
"Asia/Macau",
"America/Maceio",
"Antarctica/Macquarie",
"Atlantic/Madeira",
"Europe/Madrid",
"Asia/Magadan",
"Indian/Mahe",
"Pacific/Majuro",
"Asia/Makassar",
"Africa/Malabo",
"Indian/Maldives",
"Europe/Malta",
"America/Managua",
"America/Manaus",
"Asia/Manila",
"Africa/Maputo",
"America/Indiana/Marengo",
"Europe/Mariehamn",
"America/Marigot",
"Pacific/Marquesas",
"America/Martinique",
"Africa/Maseru",
"America/Matamoros",
"Indian/Mauritius",
"Antarctica/Mawson",
"Indian/Mayotte",
"America/Mazatlan",
"Africa/Mbabane",
"Antarctica/McMurdo",
"Australia/Melbourne",
"America/Argentina/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"Pacific/Midway",
"Europe/Minsk",
"America/Miquelon",
"Africa/Mogadishu",
"Europe/Monaco",
"America/Moncton",
"Africa/Monrovia",
"America/Monterrey",
"America/Montevideo",
"America/Kentucky/Monticello",
"America/Montserrat",
"Europe/Moscow",
"Asia/Muscat",
"Africa/Nairobi",
"America/Nassau",
"Pacific/Nauru",
"Africa/Ndjamena",
"America/North_Dakota/New_Salem",
"America/New_York",
"Africa/Niamey",
"Asia/Nicosia",
"Pacific/Niue",
"America/Nome",
"Pacific/Norfolk",
"America/Noronha",
"Africa/Nouakchott",
"Pacific/Noumea",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"America/Nuuk",
"America/Ojinaga",
"Asia/Omsk",
"Asia/Oral",
"Europe/Oslo",
"Africa/Ouagadougou",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Antarctica/Palmer",
"America/Panama",
"America/Paramaribo",
"Europe/Paris",
"Australia/Perth",
"America/Indiana/Petersburg",
"Asia/Phnom_Penh",
"America/Phoenix",
"Pacific/Pitcairn",
"Europe/Podgorica",
"Pacific/Pohnpei",
"Asia/Pontianak",
"Pacific/Port_Moresby",
"America/Port_of_Spain",
"America/Port-au-Prince",
"America/Porto_Velho",
"Africa/Porto-Novo",
"Europe/Prague",
"America/Puerto_Rico",
"America/Punta_Arenas",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"America/Rankin_Inlet",
"Pacific/Rarotonga",
"America/Recife",
"America/Regina",
"America/Resolute",
"Indian/Reunion",
"Atlantic/Reykjavik",
"Europe/Riga",
"America/Rio_Branco",
"America/Argentina/Rio_Gallegos",
"Asia/Riyadh",
"Europe/Rome",
"Antarctica/Rothera",
"Pacific/Saipan",
"Asia/Sakhalin",
"America/Argentina/Salta",
"Europe/Samara",
"Asia/Samarkand",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"Europe/San_Marino",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"Africa/Sao_Tome",
"Europe/Sarajevo",
"Europe/Saratov",
"America/Scoresbysund",
"Asia/Seoul",
"Asia/Shanghai",
"Europe/Simferopol",
"Asia/Singapore",
"America/Sitka",
"Europe/Skopje",
"Europe/Sofia",
"Atlantic/South_Georgia",
"Asia/Srednekolymsk",
"America/St_Barthelemy",
"Atlantic/St_Helena",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"Atlantic/Stanley",
"Europe/Stockholm",
"America/Swift_Current",
"Australia/Sydney",
"Antarctica/Syowa",
"Pacific/Tahiti",
"Asia/Taipei",
"Europe/Tallinn",
"Pacific/Tarawa",
"Asia/Tashkent",
"Asia/Tbilisi",
"America/Tegucigalpa",
"Asia/Tehran",
"America/Indiana/Tell_City",
"Asia/Thimphu",
"America/Thule",
"America/Tijuana",
"Europe/Tirane",
"Asia/Tokyo",
"Asia/Tomsk",
"Pacific/Tongatapu",
"America/Toronto",
"America/Tortola",
"Africa/Tripoli",
"Antarctica/Troll",
"America/Argentina/Tucuman",
"Africa/Tunis",
"Asia/Ulaanbaatar",
"Europe/Ulyanovsk",
"Asia/Urumqi",
"America/Argentina/Ushuaia",
"Asia/Ust-Nera",
"UTC",
"Europe/Vaduz",
"America/Vancouver",
"Europe/Vatican",
"America/Indiana/Vevay",
"Europe/Vienna",
"Asia/Vientiane",
"Europe/Vilnius",
"America/Indiana/Vincennes",
"Asia/Vladivostok",
"Europe/Volgograd",
"Antarctica/Vostok",
"Pacific/Wake",
"Pacific/Wallis",
"Europe/Warsaw",
"America/Whitehorse",
"America/Indiana/Winamac",
"Africa/Windhoek",
"America/Winnipeg",
"America/Yakutat",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Europe/Zagreb",
"Europe/Zurich"
],
"type": "string"
},
"display_cec_enabled": {
"type": "boolean"
},
"display_limit_720": {
"type": "boolean"
},
"display_sleep_timer": {
"enum": [
"never",
"immediate",
"one_minute",
"fifteen_minutes",
"three_hours"
],
"type": "string"
},
"googlecast": {
"enum": [
"off",
"everyone",
"prompt"
],
"type": "string"
},
"guest_network_password": {
"type": "string"
},
"guest_network_ssid": {
"type": "string"
},
"hotspot_access": {
"enum": [
"none",
"lan",
"internet",
"internet+lan"
],
"type": "string"
},
"hotspot_channel_width": {
"enum": [
20,
40,
80,
160
],
"type": "number"
},
"hotspot_client_isolation": {
"type": "boolean"
},
"hotspot_enabled": {
"type": "boolean"
},
"hotspot_frequency": {
"minimum": 0,
"type": "integer"
},
"hotspot_password": {
"maxLength": 63,
"type": "string"
},
"livestreaming_enabled": {
"type": "boolean"
},
"livestreaming_password": {
"minLength": 1,
"type": "string"
},
"livestreaming_quality": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"livestreaming_rtsp": {
"type": "boolean"
},
"miracast": {
"enum": [
"off",
"everyone",
"pin8",
"pin4",
"prompt"
],
"type": "string"
},
"miracast_channel_width": {
"enum": [
20,
40,
80,
160
],
"type": "number"
},
"miracast_frequency": {
"minimum": 0,
"type": "integer"
},
"miracast_infracast": {
"type": "boolean"
},
"moderator_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"moderator_require_approval": {
"type": "boolean"
},
"proxy_hostname": {
"maxLength": 253,
"type": "string"
},
"proxy_port": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"systemd_journal_upload_hostname": {
"type": "string"
},
"systemd_journal_upload_port": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"systemd_journal_upload_tls_authority": {
"type": "string"
},
"systemd_journal_upload_tls_certificate": {
"type": "string"
},
"systemd_journal_upload_tls_private_key": {
"type": "string",
"writeOnly": true
},
"updater_allow_automatic_updates": {
"type": "boolean"
},
"updater_channel": {
"enum": [
"stable",
"release-candidate",
"preview"
],
"type": "string"
},
"webmanagement_tls_certificate": {
"minLength": 1,
"type": "string"
},
"webmanagement_tls_key": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_authentication_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_authentication_username": {
"minLength": 1,
"type": "string"
},
"wifi_client_enabled": {
"type": "boolean"
},
"wifi_client_password": {
"minLength": 1,
"type": "string",
"writeOnly": true
},
"wifi_client_ssid": {
"minLength": 1,
"type": "string"
}
},
"type": "object"
}
- Example 1
- Example 2
{
"device_name": "Meeting Room"
}
{
"airplay": "password",
"airplay_password": "super secret"
}
HTTP response status codes
| Status code | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
Example
- curl
- JavaScript
curl https://{your AirServer hostname}/api/v1/system \
-X PATCH \
-H 'Authorization: Bearer {your AirServer Connect API key or JWT token}' \
-d '{"device_name":"Meeting Room"}'
const apiKey = "{your AirServer Connect API key or JWT token}";
const fetchOptions = {
method: "PATCH",
body: JSON.stringify({
device_name: "Meeting Room"
}),
headers: {
Authorization: "Bearer " + apiKey
}
};
const response = await fetch("https://{your AirServer hostname}/api/v1/system", fetchOptions);
if (!response.ok) {
console.log("Error while trying to change config")
}
Reboot
Endpoint
POST /api/v1/system/rebootRequired roles
admin:wDescription
Reboot the device.
HTTP response status codes
| Status code | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
Example
- curl
- JavaScript
curl https://{your AirServer hostname}/api/v1/system/reboot \
-X POST \
-H 'Authorization: Bearer {your AirServer Connect API key or JWT token}'
const apiKey = "{your AirServer Connect API key or JWT token}";
const fetchOptions = {
method: "POST",
headers: {
Authorization: "Bearer " + apiKey
}
};
const response = await fetch("https://{your AirServer hostname}/api/v1/system/reboot", fetchOptions);
if (!response.ok) {
console.log("Error while trying to reboot")
}
Power Off
Endpoint
POST /api/v1/system/powerOffRequired roles
admin:wDescription
Power the device off.
HTTP response status codes
| Status code | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
Example
- curl
- JavaScript
curl https://{your AirServer hostname}/api/v1/system/powerOff \
-X POST \
-H 'Authorization: Bearer {your AirServer Connect API key or JWT token}'
const apiKey = "{your AirServer Connect API key or JWT token}";
const fetchOptions = {
method: "POST",
headers: {
Authorization: "Bearer " + apiKey
}
};
const response = await fetch("https://{your AirServer hostname}/api/v1/system/powerOff", fetchOptions);
if (!response.ok) {
console.log("Error while trying to power off")
}
End Session
Endpoint
POST /api/v1/system/endSessionRequired roles
admin:wDescription
End the current session, disconnecting all currently connected users and rotating the Wi-Fi password.
HTTP response status codes
| Status code | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
Example
- curl
- JavaScript
curl https://{your AirServer hostname}/api/v1/system/endSession \
-X POST \
-H 'Authorization: Bearer {your AirServer Connect API key or JWT token}'
const apiKey = "{your AirServer Connect API key or JWT token}";
const fetchOptions = {
method: "POST",
headers: {
Authorization: "Bearer " + apiKey
}
};
const response = await fetch("https://{your AirServer hostname}/api/v1/system/endSession", fetchOptions);
if (!response.ok) {
console.log("Error while trying to end session")
}