Service-role (List)#

Path: /environments/environment/services/service-role

Keys: id

Parameters#

NameTypeRequiredDefaultDescription
idstringrequired-A given name of the service role
locationstringoptional-Where the service is located, physically
enabledbooleanoptionaltrueEnable or disable the entire daemon instance
zoneleafref → ../../zones/zone/idoptional-The zone that the service is in (which, if not set, will be the default zone)
listening-hostunion (string | string)optional0.0.0.0IP used for listening host
listening-portuint16optional8443The port the service listens on
protocolenumeration (http, https)optionalhttpsWhich protocol to use, almost always, https should be used
ssl-server-keystoreleafref → /facilities/crypto/ssl/server-keystore/idoptional-A pointer to the key used for the SSL server
enable-http-v2booleanoptionalfalseEnable HTTP 2 (H2)
jvm-optionsstringoptional-XX:+UseG1GC -XX:+UseStringDeduplicationThe options that should be passed to the Java Virtual Machine (JVM) when the service is started
disable-android-assetlinks-generationemptyoptional-Disable generation of assetlinks (’…/.well-known/assetlinks.json’) from configured Android App associations
endpointsmulti-value leafref → /profiles/profile/endpoints/endpoint/idoptional-A list of endpoints deployed on this service instance, no order implied

Subsections#

NameTypeDescription
dos-protection Section
hsts SectionEnable HSTS support for this role
content-security-policy Section
connections SectionSettings related to how the Server accepts client connections
server-tls Section
mutual-tls Section
thread-count Section
ciphers SectionWhite- and black-listing of ciphers used for incoming secure connections. Enabling this feature will disable any white- and black-lists automatically enforced by the server.
webfinger SectionEnable webfinger support for this service

Was this helpful?