Skip to content

ssl_cert_threshold

Configuration for SSL certificate Threshold configuration resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write name.
region <String> Read-write Region Code.

Maximum length = 256
rule <String> Read-write Rule.
stylebook_flag <Boolean> Read-write Stylebook threshold configuration true or false.
country <String> Read-write Country Code.

Maximum length = 256
sms_profile <String> Read-write SMS Profile.
slack_profile <String> Read-write Slack Profile.
feature <String> Read-write feature.
ctnsappname <String> Read-write AppName.
hide_default_certs <Boolean> Read-write Set the value to true if default certs in device need not be managed.
id <String> Read-write Id is system generated key for all the Thresholds configuration .

Maximum length = 256
resource_type <String> Read-write Resource Type.
mail_profile <String> Read-write Mail Profile.
is_enabled <String> Read-write true or false.
pagerduty_profile <String> Read-write PagerDuty Profile.
duration <String> Read-write duration of metric to be checked against threshold.
days_to_expiry <Integer> Read-write Days remaining for expiry.

Maximum value =
servicenow_profile <String> Read-write Servicenow Profile.
city <String> Read-write City.

Maximum length = 256
ip_address <String> Read-write Field to store the ip address as it is along with any extension.

Maximum length = 512
group_name <String> Read-write Group Name.
reference_key <String> Read-write Reference Key.
exporter_id <Double> Read-write Exporter Id.
approved_ssl_protocol_list <String[]> Read-write SSL Protocols List.
approved_key_strength_list <String[]> Read-write Key Strength List.
approved_issuers_list <String[]> Read-write Issuers List.
approved_signature_algo_list <String[]> Read-write Signature Algorithm List.
tenant_name <String> Read-only Tenant Name.

Operations

(click to see Properties )

  • GET (ALL)
  • GET
  • UPDATE

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ssl_cert_threshold resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold ?pagesize=#no;pageno=#no

Use this query-parameter to get the ssl_cert_threshold resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold ?count=yes

Use this query-parameter to get the count of ssl_cert_threshold resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ssl_cert_threshold":[{
      "name":<String_value>,
      "region":<String_value>,
      "rule":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "country":<String_value>,
      "issuers_list":<String_value>,
      "sms_profile":<String_value>,
      "signature_algo_list":<String_value>,
      "slack_profile":<String_value>,
      "feature":<String_value>,
      "ctnsappname":<String_value>,
      "hide_default_certs":<Boolean_value>,
      "id":<String_value>,
      "resource_type":<String_value>,
      "mail_profile":<String_value>,
      "is_enabled":<String_value>,
      "pagerduty_profile":<String_value>,
      "duration":<String_value>,
      "days_to_expiry":<Integer_value>,
      "servicenow_profile":<String_value>,
      "city":<String_value>,
      "key_strength_list":<String_value>,
      "ip_address":<String_value>,
      "ssl_protocol_list":<String_value>,
      "tenant_name":<String_value>,
      "group_name":<String_value>,
      "reference_key":<String_value>,
      "exporter_id":<Double_value>,
      "approved_ssl_protocol_list":<String_value>,
      "approved_key_strength_list":<String_value>,
      "approved_issuers_list":<String_value>,
      "approved_signature_algo_list":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ssl_cert_threshold":[{
      "name":<String_value>,
      "region":<String_value>,
      "rule":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "country":<String_value>,
      "issuers_list":<String_value>,
      "sms_profile":<String_value>,
      "signature_algo_list":<String_value>,
      "slack_profile":<String_value>,
      "feature":<String_value>,
      "ctnsappname":<String_value>,
      "hide_default_certs":<Boolean_value>,
      "id":<String_value>,
      "resource_type":<String_value>,
      "mail_profile":<String_value>,
      "is_enabled":<String_value>,
      "pagerduty_profile":<String_value>,
      "duration":<String_value>,
      "days_to_expiry":<Integer_value>,
      "servicenow_profile":<String_value>,
      "city":<String_value>,
      "key_strength_list":<String_value>,
      "ip_address":<String_value>,
      "ssl_protocol_list":<String_value>,
      "tenant_name":<String_value>,
      "group_name":<String_value>,
      "reference_key":<String_value>,
      "exporter_id":<Double_value>,
      "approved_ssl_protocol_list":<String_value>,
      "approved_key_strength_list":<String_value>,
      "approved_issuers_list":<String_value>,
      "approved_signature_algo_list":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/ssl_cert_threshold/id_value<String>

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ssl_cert_threshold":{
<b>      "id":<String_value></b>,
      "region":<String_value>,
      "name":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "rule":<String_value>,
      "country":<String_value>,
      "approved_key_strength_list":<String_value[]>,
      "sms_profile":<String_value>,
      "slack_profile":<String_value>,
      "feature":<String_value>,
      "hide_default_certs":<Boolean_value>,
      "ctnsappname":<String_value>,
      "mail_profile":<String_value>,
      "resource_type":<String_value>,
      "is_enabled":<String_value>,
      "pagerduty_profile":<String_value>,
      "days_to_expiry":<Integer_value>,
      "duration":<String_value>,
      "approved_issuers_list":<String_value[]>,
      "servicenow_profile":<String_value>,
      "city":<String_value>,
      "ip_address":<String_value>,
      "group_name":<String_value>,
      "approved_ssl_protocol_list":<String_value[]>,
      "reference_key":<String_value>,
      "exporter_id":<Double_value>,
      "approved_signature_algo_list":<String_value[]>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ssl_cert_threshold":[{
      "name":<String_value>,
      "region":<String_value>,
      "rule":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "country":<String_value>,
      "issuers_list":<String_value>,
      "sms_profile":<String_value>,
      "signature_algo_list":<String_value>,
      "slack_profile":<String_value>,
      "feature":<String_value>,
      "ctnsappname":<String_value>,
      "hide_default_certs":<Boolean_value>,
      "id":<String_value>,
      "resource_type":<String_value>,
      "mail_profile":<String_value>,
      "is_enabled":<String_value>,
      "pagerduty_profile":<String_value>,
      "duration":<String_value>,
      "days_to_expiry":<Integer_value>,
      "servicenow_profile":<String_value>,
      "city":<String_value>,
      "key_strength_list":<String_value>,
      "ip_address":<String_value>,
      "ssl_protocol_list":<String_value>,
      "tenant_name":<String_value>,
      "group_name":<String_value>,
      "reference_key":<String_value>,
      "exporter_id":<Double_value>,
      "approved_ssl_protocol_list":<String_value>,
      "approved_key_strength_list":<String_value>,
      "approved_issuers_list":<String_value>,
      "approved_signature_algo_list":<String_value>}]}
Was this article helpful?