Get the SSL Configuration at the Domain Level

This URL gets the SSL configuration at the domain level.

Resource URL

GET /domain/<domainId>/sslconfiguration

Request Parameters

URL Parameters:


Field Name	Description	Data Type	Mandatory
`domainId`	Domain ID	Number	Yes

Response Parameters

Following fields are returned:


Field Name	Description	Data Type
`inheritSettings`	Inherit settings from parent domain.	Boolean
`decryptionState`	SSL state. Values can be: DISABLED INBOUND OUTBOUND PROXY_INBOUND (For Inbound Proxy) PROXY_INBOUND_OUTBOUND (For Inbound and Outbound Proxy)	String
`anticipatedSSLTrafficUsage`	Anticipated inbound SSL traffic usage. Values can be: VERY_LIGHT LIGHT MEDIUM HEAVY VERY_HEAVY	String
`maxFlow`	Maximum flow allowed in a Sensor	Number
`decryptedFlow`	Flows allocated to Sensor	Number
`sslInactivityTimeoutInMinutes`	The maximum amount of time a Sensor will keep an outbound SSL flow open when no data is seen on the Sensor.	Number
`includeDecryptedPCAPS`	Include decrypted packets while packet capture.	Boolean
`enableDhSupport`	DH support	Boolean
`maxConcurrent`	Maximum concurrent connections allowed between a Trellix Agent and a Sensor. The value can range from 1 to 1024.	Number
`permittedIPv4CIDRBlocks`	IPv4 CIDR blocks	Object
`permittedIPv6CIDRBlocks`	IPv6 CIDR blocks	Object
`failureHandling`	Failure handling	Object

Details of permittedIPv4CIDRBlocks and permittedIPv6CIDRBlocks:


Field Name	Description	Data Type
`id`	ID of the CIDR added	Number
`cidr`	CIDR block	String

Details of failureHandling:


Field Name	Description	Data Type
`untrustedOrExpiredServerCertificate`	Action to take if the target Web server's certificate is not on the sensor's trusted CA list. Used only in case of outbound SSL. The values can be: Block flow Decrypt	String

Example

Request

GET https://<NSM_IP>/sdkapi/domain/0/sslconfiguration

Response

{
"inheritSettings": false,
  "decryptionState": "INBOUND",
  "anticipatedSSLTrafficUsage": "VERY_HEAVY",
  "sslInactivityTimeoutInMinutes": 6,
  "enableDhSupport": true,
  "maxConcurrent": 210,
  "permittedIPv4CIDRBlocks": [
    {
     "id": 428,
     "cidr": "4.4.4.4/32",
     "action": null
    },
    {
     "id": 366,
     "cidr": "1.1.1.1/32",
     "action": null
    }
   ],
 "permittedIPv6CIDRBlocks": [
  {
   "id": 429,
   "cidr": "2001:0DB9:0000:0000:0000:0000:0000:0000/123",
   "action": null
  },
  {
   "id": 367,
   "cidr": "2001:0DB9:0000:0000:0000:0000:0000:0000/128",
   "action": null
  }
],
"includeDecryptedPCAPS": true
}

Error Information

Following error codes are returned by this URL:


S.No	HTTP Error Code	SDK API errorId	SDK API errorMessage
1	404	1105	Invalid domain
2	500	1001	Internal error