PUT Update Secure Plus Node

The Update Secure Plus Node API used to update node or alias in secure plus parmfile.

Method URI

PUT

/cdwebconsole/svc/secureplusnode

The following example shows the Command:
curl -X 'PUT' \
  'https://172.20.186.131:9444/cdwebconsole/svc/secureplusnode' \
  -H 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbmlzdHJhdG9yOjE3Mi4yMC4xODYuMTMxOjEzNjM6Mzg0MjM0YWUtNzIxYy00ZDRhLTg3NGEtNjY1MjI1M2RkYjAzIiwiZXhwIjoxNzE0NzAzMTEzfQ.F_qhs1oEl6SFitjw282RLUqPbiDY_9E-K1asvng7GHAraO1mmxSwtzHzjbFNllx6sAmivaFJD4kkh2EW4ZCsdQ' \
  -H 'Content-Type: application/json' \
  -H 'X-XSRF-TOKEN: 158cbede-4199-46f9-b213-e5b60e8c3466' \
  -d '{"secureNodeName":"cddescnode","override":"n","securePlusProtocol":"TLS1.2","authenticationTimeout":"140","externalAuthCertificateValidationDefinition":"","externalAuthenticationServerAddress":"CDWLT-12","externalAuthenticationServerPort":"1364","enableExternalAuthentication":"n","enableDataEncryption":"n","enableStrongPasswordEncryption":"n","clientAuthentication":"n","certificateLabel":"cd demo id 1","securityModes":"n","commonName":"cdnodes","cipherSuites":"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","enableCache":"n","cacheValidityTime":"36hrs","graceValidityTime":"24hrs","showValidationResults":"no"}'
Table 1. Input Parameters
Parameter Name Required/Optional Description Valid values

secureNodeName

Required

Specifies the name of the node.

override Optional

Specifies options for override in Secure Plus node

Valid values : y, n, DefaultToLN

securePlusProtocol Optional

Specifies protocol options for Secure Plus node

Valid values till CD v6.2 : SSL or TLS1.0 or TLS1.1 or TLS1.2 or TLS1.3 or DISABLE or DefaultToLN.

Valid values from CD v6.3 : TLS1.2 or TLS1.3 or DISABLE or DefaultToLN.

authenticationTimeout Optional Specifies the authentication timeout  
externalAuthCertificateValidationDefinition Optional Specifies external authentication certificate validation defined  
externalAuthenticationServerAddress Optional Specifies external authentication hostname  
externalAuthenticationServerPort Optional Specifies external authentication port  
enableExternalAuthentication Optional

Specifies options to enable external authentication

Valid values : y, n, DefaultToLN

enableStrongPasswordEncryption Optional

Specifies options to use strong password encryption

Valid values : y or n.

enableDataEncryption Optional

Specifies options to enable data encryption

Valid values : y, n, DefaultToLN

clientAuthentication Optional

Specifies whether or not client authentication is requested

Valid values : y, n, DefaultToLN

certificateLabel Optional Specifies the label to be given to the key certificate  
securityModes Optional

Specifies security modes available

Valid values : y, n, DefaultToLN, SP800-131A_TRANSITION, SP800-131A_STRICT, SUITE_B-128, SUITE_B-192, FIPS140-2

commonName Optional Specifies the common name to be checked in the client's certificate  
cipherSuites Optional Specifies a cipher suites for protocol defined in Secure Plus node  
enableCache Optional

Specifies options to enable cache

Valid values : y or n.

cacheValidityTime Optional

Specifies cache validity per certificate in hours

Valid values: 1-720(1 hour to 30 days)

Default value: 24hrs

graceValidityTime Optional

Specifies cache grace validity time per certificate in hours

Should be greater than or equal to Cache Validity per certificate

Valid values: 0-720(0 hour to 30 days)

Default value: 0

showValidationResults Optional

Specify to get validation result in the response.

Valid values : yes, no

Default value : no

The following example shows the Request payload:
{
 "secureNodeName": "cddescnode",
 "override": "n",
 "securePlusProtocol": "TLS1.2",
 "authenticationTimeout": "140",
 "externalAuthCertificateValidationDefinition": "",
 "externalAuthenticationServerAddress": "CDWLT-12",
 "externalAuthenticationServerPort": "1364",
 "enableExternalAuthentication": "n",
 "enableDataEncryption": "n",
 "enableStrongPasswordEncryption": "n",
 "clientAuthentication": "n",
 "certificateLabel": "cd demo id 1",
 "securityModes": "n", 
 "commonName": "cdnodes",
 "cipherSuites": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
 "enableCache": "n",
 "cacheValidityTime": "36hrs",
 "graceValidityTime": "24hrs",
 "showValidationResults": "no"
}
The following example shows the Sample Response:
[
  {
    "messageCode": 200,
    "message": "The Secure Plus node has been successfully updated"
  }
]