Use the Access Point REST API properties to configure the security certificates, protocols, and cipher suites are used, set up smart card authentication, and more.

You can use the properties listed below to make configuration changes after the Access Point appliance is deployed, or you can alternatively use the OVF Tool property --X:enableHiddenProperties=settingsJSON in the list of properties to configure the appliance at deployment time. For more information about how to use Access Point with the OVF Tool, see Access Point Deployment Properties.

These settings are included in the SystemSettings resource. The URL is https://access-point-appliance.example.com:9443/rest/v1/config/system. In this URL, access-point-appliance.example.com is the fully qualified domain name of the Access Point appliance.

REST API Properties for the SystemSettings Resource

REST API Property

Description and Example

Default Value

adminPassword

Specifies the administrator password for accessing the REST API. Passwords must be at least 8 characters long, contain at least one uppercase and one lowercase letter, one digit, and one special character, which includes ! @ # $ % * ( ).

Not set unless set by the deployment wizard or OVF Tool.

cipherList

Configures the cipher list to restrict the use of certain cryptographic algorithms before establishing an encrypted TLS/SSL connection. This setting is used with the settings for enabling various security protocols.

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA

ssl30Enabled

Specifies whether the SSLv3.0 security protocol is enabled.

FALSE

tls10Enabled

Specifies whether the TLSv1.0 security protocol is enabled.

FALSE

tls11Enabled

Specifies whether the TLSv1.1 security protocol is enabled.

TRUE

tls12Enabled

Specifies whether the TLSv1.2 security protocol is enabled.

TRUE

locale

Specifies the local to use for localized messages.

en_US for English

ja_JP for Japanese

fr_FR for French

de_DE for German

zh_CN for Simplified Chinese

zh_TW for Traditional Chinese

ko_KR for Korean

en_US

syslogUrl

Specifies the Syslog server used for logging Access Point events.

This value can be a URL or a host name or IP address. The scheme and port number are optional (example: syslog://server.example.com:514). .

Not set unless set by the deployment wizard or OVF Tool.

healthCheckUrl

Specifies the URL that the load balancer connects and checks the health of Access Point.

/favicon.ico which is a graphic inbuilt in Access Point.

quiesceMode

Pause or alter a device or application to achieve a consistent state.

FALSE

monitorInterval

Monitors the interval that the backend systems take to respond to Access Point.

60 seconds

These settings are included in the ServerCertificate resource. The URL is

 https://access-point-appliance.example.com:9443/rest/v1/config/certs/ssl

In this URL, access-point-appliance.example.com is the fully qualified domain name of the Access Point appliance.

REST API Properties for the ServerCertificate Resource

REST API Property

Description and Example

Default Value

privateKeyPem

Specifies the private key for the certificate in PEM format.

System-generated

certChainPem

Specifies the certificate chain in PEM format

System-generated