Service-role (List)#

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

Parameters#

NameTypeRequiredDefaultDescription
idstringrequiredA given name of the service role
locationstringoptionalWhere the service is located, physically
enabledbooleanoptionaltrueEnable or disable the entire daemon instance
zoneleafrefoptionalThe zone that the service is in (which, if not set, will be the default zone)
listening-hostip-addressoptional0.0.0.0IP used for listening host
listening-portport-numberoptional8443The port the service listens on
protocolenumerationoptionalhttpsWhich protocol to use, almost always, https should be used
ssl-server-keystoreleafrefoptionalA 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-generationemptyoptionalDisable generation of assetlinks (’…/.well-known/assetlinks.json’) from configured Android App associations
endpointsmulti-value, leafrefoptionalA list of endpoints deployed on this service instance, no order implied

Subsections#

NameTypeDescription
hsts SectionEnable HSTS support for this role
content-security-policy SectionNone
connections SectionSettings related to how the Server accepts client connections
server-tls SectionNone
mutual-tls SectionNone
thread-count SectionNone
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
dos-protection SectionNone

Was this helpful?