GET
Get settings for the WLAN with the specified ID.
| Responses | |
| 200 | GET successful. |
| 404 | Resource does not exist. |
| Response (application/json): object | ||
| Member | Type | Description |
accessPoint | object | |
broadcastSsid | boolean | Indicates if the SSID will be broadcasted. |
channel | integer (int32) | The wireless connection channel that is currently in use. Re-pairing the Buttons is not required when changing the frequency band or wireless connection channel. The channel must be in the range of accepted channels for the current frequency. Example: 12 |
frequencyBand | string | The wireless network frequency band that is currently in use. It can be set to either '2.4 GHz' or '5 GHz'. Re-pairing the Buttons is not required when changing the frequency band or wireless connection channel. |
password | string (password) | The password for the wireless network of the Base Unit. write-only |
signalStrengthPercentage | integer | Set the signal strength of the wireless device. Example: 50 Since version: 2.10 |
ssid | string | The public name (SSID) for the wireless network of the Base Unit. Example: clickshare-1234 |
supportedChannels2400MHz | array | List of the available channels in the 2.4 GHz band. The channels available in the list vary depending on the country code of the Base Unit. Example: [10, 11, 12] read-only |
supportedChannels5000MHz | array | List of the available channels in the 5 GHz band. The channels available in the list vary depending on the country code of the Base Unit. Example: [36, 40] read-only |
supportedFrequencyBands | array | Example: ['2.4 GHz', '5 GHz'] read-only |
addressing | string | If this parameter is set to 'DHCP', the network connection is configured automatically through DHCP. If it is set to 'Static', a fixed IP address should be specified using the 'ipAddress' parameter. |
defaultGateway | string (ipv4) | The default gateway. This parameter should only be changed if Example: 192.168.2.1 |
dnsServers | array | The DNS servers used for resolving domain names. The children of this node should only be set if Example: ['192.168.2.10', '192.168.2.11'] |
id | integer | The ID for this WLAN. read-only |
ipAddress | string (ipv4) | The IP address of the Base Unit. This parameter should only be changed if Example: 192.168.2.3 |
macAddress | string (mac-address) | MAC address of the wireless adapter of the Base Unit. Example: 12:23:34:45:56 read-only |
operationMode | string | |
subnetMask | string | The subnet mask appropriate for the local subnet. This parameter should only be changed if Example: 255.255.255.0 |
supportedOperationModes | array | Example: ['AccessPoint', 'WirelessClient', 'Off'] read-only |
wirelessClient | object | Client mode settings for baseunit. Since version: 2.2 |
authentication | object | Settings for 802.1X authentication. |
anonymousIdentity | string | Used to select the correct authentication server to process the credentials. |
authenticationErrorCode | string | Wired Authentication error code. read-only |
authenticationMode | string | The 802.1X mode that is used. |
authenticationState | string | Wired Authentication State. read-only |
caCertificate | string | |
certificates | object | Since version: 2.8 read-only |
ca | object | Retrieve information about the ca certificate. Since version: 2.8 |
commonName | string | Common name of the active certificate. Example: ClickShare-1862300136 Since version: 2.8 |
country | string | Country of the active certificate. Example: BE Since version: 2.8 |
locality | string | Locality of the active certificate. Since version: 2.8 |
notAfter | string (date-time) | Indicate the end of the validity period of the certificate. Example: 2021-04-29 10:00:24 Since version: 2.8 |
notBefore | string (date-time) | Indicate the start of the validity period of the certificate. Example: 2020-04-29 10:00:24 Since version: 2.8 |
organization | string | Organization of the active certificate. Since version: 2.8 |
organizationalUnit | string | OrganizationalUnit of the active certificate. Since version: 2.8 |
serialNumber | string | SerialNumber of the active certificate. Since version: 2.8 |
state | string | State of the active certificate. Since version: 2.8 |
client | object | Retrieve information about the client certificate. Since version: 2.8 |
commonName | string | Common name of the active certificate. Example: ClickShare-1862300136 Since version: 2.8 |
country | string | Country of the active certificate. Example: BE Since version: 2.8 |
locality | string | Locality of the active certificate. Since version: 2.8 |
notAfter | string (date-time) | Indicate the end of the validity period of the certificate. Example: 2021-04-29 10:00:24 Since version: 2.8 |
notBefore | string (date-time) | Indicate the start of the validity period of the certificate. Example: 2020-04-29 10:00:24 Since version: 2.8 |
organization | string | Organization of the active certificate. Since version: 2.8 |
organizationalUnit | string | OrganizationalUnit of the active certificate. Since version: 2.8 |
serialNumber | string | SerialNumber of the active certificate. Since version: 2.8 |
state | string | State of the active certificate. Since version: 2.8 |
clientCertificate | string | |
clientCertificatePassword | string (password) | The password for the client certificate. Since version: 2.2 write-only |
domain | string | The domain used for connections in PEAP and EAP-TTLS mode. Example: barco.com |
eapIdentity | string | The identity used for connections in PEAP and EAP-TTLS mode. |
eapPassword | string (password) | The password used for connections in PEAP and EAP-TTLS mode. write-only |
enabled | boolean | Indicates if the 802.1X Authentication is enabled. |
passPhrase | string | Pass Phrase for WPA2-PSK authentication Example: passphrase Since version: 2.2 write-only |
scep | object | The SCEP settings that are used for EAP_TLS mode with automatic enrollment. |
challenge | string | Challenge token to prevent revocation by user without token. This token is only used when type is SCEP. Since version: 2.8 write-only |
city | string | Additional information about the city. This parameter is optional. Since version: 2.8 |
commonName | string | Optional custom common name for the client certificate. By default the BaseUnit's hostname will be used. Example: ClickShare-3083543628.barco.com Since version: 2.8 |
country | string | Additional information about the country. This parameter is optional. Since version: 2.8 |
department | string | Additional information about the department. This parameter is optional. Since version: 2.8 |
enabled | boolean | |
organisation | string | Additional information about the organisation. This parameter is optional. Since version: 2.8 |
password | string | Password parameter is needed for NDES. write-only |
serverType | string | SCEP RFC is an open source Linux certificate protocol. NDES is a certificate protocol developed by Microsoft. Before REST API v2.8 NDES was referred to as SCEP enrollment Since version: 2.8 |
serverUrl | string | The SCEP server to contact. Only http is currently supported. For NDES, you can omit the default /CertSrv/mscep/ path. Example: http://barco.com/scep |
state | string | Additional information about the state. This parameter is optional. Since version: 2.8 |
supportedServerTypes | array | Since version: 2.8 read-only |
username | string | Username parameter is needed for NDES. |
supportedAuthenticationModes | array | The different supported authentication modes. Example: ['None', 'PEAP', 'WPA2-PSK'] read-only |
ssid | string | The public name (SSID) for the wireless network of the Base Unit. Example: clickshare-0123456789 Since version: 2.2 |