Endpoint: /server/security/tls

Returns and updates server TLS security settings.

Method & URL

GET https://[server URL]:[port]/admin/v2/server/security/tls

GET Body Sample

Copy 
GET https://{{host}}/admin/v2/server/security/tls HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy 
{
"data": {  
"type": "tlsServerSecuritySettings",  
"id": "1",  
"attributes": {  
"tlsSettings": {      
"minimumProtocolVersion": "TLSv1.3",      
"selectedAlgorithms": 
"TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:
EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:
RSA+3DES:EECDH+RC4:RSA+RC4:!MD5:!SRP:!PSK:!EXP:!RC4:!SSLv3:!SHA1",     
"resultingCipherList": 
"TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:
ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-CCM8:ECDHE-ECDSA-AES128-CCM:
ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-GCM-SHA256:AES128-CCM8:
AES128-CCM:AES128-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-CCM8:ECDHE-ECDSA-AES256-CCM:ECDHE-ECDSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA384:AES256-GCM-SHA384:AES256-CCM8:AES256-CCM:AES256-SHA256",     
"manuallySelectedAlgorithms": {       
"enabled": false,       
"algorithms": 
"TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:EECDH+CHACHA20:
EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:EECDH+RC4:RSA+RC4:!MD5:
!SRP:!PSK:!EXP:!RC4:!SSLv3:!SHA1"     
}   
},   
"tlsFipsEnabled": false   
}},   
"links": {      
"self": "admin/v2/server/security/tls"   
}
}

GET PowerShell Sample

Copy 
#get Server TLS Security Settings
Write-Output "Get Server TLS Settings"
Write-Output "-----"
$serverTLS = Invoke-RestMethod -Uri "$baseURL/v2/server/security/tls" -Method 
'GET' -Headers $authHeader
Write-Output $serverTLS | ConvertTo-Json
foreach ($server in $serverTLS.data)
{    
Write-Output ("Server $($serverTLS.data)")
}  

Method & URL

PATCH https://[server URL]:[port]/admin/v2/server/security/tls

PATCH Body Sample

Copy 
PATCH https://{{host}}/admin/v2/server/security/tls HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}} 
{  
"data": {    
"type": "tlsServerSecuritySettings",    
"id": "1",    
"attributes": {      
"tlsFipsEnabled": true    
}  
},  
"links": {    
"self": "admin/v2/server/security/tls"  
}
} 

PATCH Response Body Sample

The response will return the same response as the GET request, however, it will now include the updated PATCH request(s).

PATCH PowerShell Sample

Copy 
###(PATCH) TLS Security Settings (enable FIPS)
Write-Output "Server TLS Enable FIPS Patch"
Write-Output "-----"
$update = 
'{
 "data": {
    "type": "tlsServerSecuritySettings",
    "id": "1",
    "attributes": {
      "tlsFipsEnabled": true
    }
  },
  "links": {
    "self": "admin/v2/server/security/tls"
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/server/security/tls" -Method 'PATCH' 
-Headers $authHeader -Body $update