Waiting for engine...
Skip to main content

GatewayOutboundSslSettingsInput

Input parameters for configuring outbound (backend) SSL and mTLS settings on a gateway. All fields are optional (partial update): the three SSL flags (outboundMtlsEnabled, trustAllOutboundCertificate, hostnameVerificationEnabled) and the certificate fields (gatewayCertificate, addOutboundTrustedCertificate, deleteOutboundTrustedCertificate) all retain their current value when omitted. Trusted certificates are added/removed in the same call via addOutboundTrustedCertificate / deleteOutboundTrustedCertificate, mirroring GatewayCertificateAuthenticationInput.

input GatewayOutboundSslSettingsInput {
  outboundMtlsEnabled: Boolean
  trustAllOutboundCertificate: Boolean
  hostnameVerificationEnabled: Boolean
  gatewayCertificate: ID
  addOutboundTrustedCertificate: [ID!]
  deleteOutboundTrustedCertificate: [ID!]
}

Fields​

GatewayOutboundSslSettingsInput.outboundMtlsEnabled ● Boolean scalar miscellaneous {#outbound-mtls-enabled}

Enables outbound mTLS for backend connections: when true, the gateway presents its certificate to backends that require mTLS. Optional; if omitted, the current value is retained.

GatewayOutboundSslSettingsInput.trustAllOutboundCertificate ● Boolean scalar miscellaneous {#trust-all-outbound-certificate}

When true, the gateway trusts all backend certificates without validation; when false, it validates the backend certificate against the outbound trusted certificate store. Optional; if omitted, the current value is retained.

GatewayOutboundSslSettingsInput.hostnameVerificationEnabled ● Boolean scalar miscellaneous {#hostname-verification-enabled}

When true, the gateway verifies that the backend service hostname matches the certificate. Optional; if omitted, the current value is retained.

GatewayOutboundSslSettingsInput.gatewayCertificate ● ID scalar miscellaneous {#gateway-certificate}

The Certificate component ID for the gateway's certificate, presented to backends as the gateway's client identity during outbound mTLS. Provide a Certificate component ID to set or replace it; it may be omitted when one is already configured (the current value is retained). If neither provided here nor already configured, the request is rejected with OUTBOUND_CLIENT_CERTIFICATE_REQUIRED. To remove it, delete the outbound SSL settings.

GatewayOutboundSslSettingsInput.addOutboundTrustedCertificate ● [ID!] list scalar miscellaneous {#add-outbound-trusted-certificate}

To add Trusted Certificates for outbound backend validation, provide a list of Certificate component IDs.

GatewayOutboundSslSettingsInput.deleteOutboundTrustedCertificate ● [ID!] list scalar miscellaneous {#delete-outbound-trusted-certificate}

To delete outbound Trusted Certificates from the gateway, provide a list of trusted certificate IDs.

Member Of​

GatewayInput input

On this Page