PATCH /analyticsprofile/{uuid}

PATCH /analyticsprofile/{uuid}

/analyticsprofile/{uuid}

Request
URI
PATCH
https://{api_host}/api/analyticsprofile/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

AnalyticsProfile object creation

AnalyticsProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "apdex_response_threshold": 0,
    "apdex_response_tolerated_factor": "number",
    "apdex_rtt_threshold": 0,
    "apdex_rtt_tolerated_factor": "number",
    "apdex_rum_threshold": 0,
    "apdex_rum_tolerated_factor": "number",
    "apdex_server_response_threshold": 0,
    "apdex_server_response_tolerated_factor": "number",
    "apdex_server_rtt_threshold": 0,
    "apdex_server_rtt_tolerated_factor": "number",
    "client_log_config": {
        "enable_significant_log_collection": false,
        "filtered_log_processing": "string",
        "non_significant_log_processing": "string",
        "significant_log_processing": "string"
    },
    "client_log_streaming_config": {
        "external_server": "string",
        "external_server_port": 0,
        "format_config": {
            "format": "string",
            "included_fields": [
                "string"
            ]
        },
        "log_types_to_send": "string",
        "marker_keys": [
            {
                "key": "string",
                "values": [
                    "string"
                ]
            }
        ],
        "max_logs_per_second": 0,
        "protocol": "string",
        "syslog_config": {
            "facility": 0,
            "filtered_log_severity": 0,
            "hostname": "string",
            "msg_id": "string",
            "non_significant_log_severity": 0,
            "proc_id": "string",
            "significant_log_severity": 0
        }
    },
    "configpb_attributes": {
        "version": 0
    },
    "conn_lossy_ooo_threshold": 0,
    "conn_lossy_timeo_rexmt_threshold": 0,
    "conn_lossy_total_rexmt_threshold": 0,
    "conn_lossy_zero_win_size_event_threshold": 0,
    "conn_server_lossy_ooo_threshold": 0,
    "conn_server_lossy_timeo_rexmt_threshold": 0,
    "conn_server_lossy_total_rexmt_threshold": 0,
    "conn_server_lossy_zero_win_size_event_threshold": 0,
    "description": "string",
    "enable_adaptive_config": false,
    "enable_advanced_analytics": false,
    "enable_ondemand_metrics": false,
    "enable_se_analytics": false,
    "enable_server_analytics": false,
    "enable_vs_analytics": false,
    "exclude_client_close_before_request_as_error": false,
    "exclude_dns_policy_drop_as_significant": false,
    "exclude_gs_down_as_error": false,
    "exclude_http_error_codes": [
        0
    ],
    "exclude_invalid_dns_domain_as_error": false,
    "exclude_invalid_dns_query_as_error": false,
    "exclude_issuer_revoked_ocsp_responses_as_error": false,
    "exclude_no_dns_record_as_error": false,
    "exclude_no_valid_gs_member_as_error": false,
    "exclude_persistence_change_as_error": false,
    "exclude_revoked_ocsp_responses_as_error": false,
    "exclude_server_dns_error_as_error": false,
    "exclude_server_tcp_reset_as_error": false,
    "exclude_sip_error_codes": [
        0
    ],
    "exclude_stale_ocsp_responses_as_error": false,
    "exclude_syn_retransmit_as_error": false,
    "exclude_tcp_reset_as_error": false,
    "exclude_unavailable_ocsp_responses_as_error": false,
    "exclude_unsupported_dns_query_as_error": false,
    "healthscore_max_server_limit": 0,
    "hs_event_throttle_window": 0,
    "hs_max_anomaly_penalty": 0,
    "hs_max_resources_penalty": 0,
    "hs_max_security_penalty": 0,
    "hs_min_dos_rate": 0,
    "hs_performance_boost": 0,
    "hs_pscore_traffic_threshold_l4_client": "number",
    "hs_pscore_traffic_threshold_l4_server": "number",
    "hs_security_certscore_expired": "number",
    "hs_security_certscore_gt30d": "number",
    "hs_security_certscore_le07d": "number",
    "hs_security_certscore_le30d": "number",
    "hs_security_chain_invalidity_penalty": "number",
    "hs_security_cipherscore_eq000b": "number",
    "hs_security_cipherscore_ge128b": "number",
    "hs_security_cipherscore_lt128b": "number",
    "hs_security_encalgo_score_none": "number",
    "hs_security_encalgo_score_rc4": "number",
    "hs_security_hsts_penalty": "number",
    "hs_security_nonpfs_penalty": "number",
    "hs_security_ocsp_revoked_score": "number",
    "hs_security_selfsignedcert_penalty": "number",
    "hs_security_ssl30_score": "number",
    "hs_security_tls10_score": "number",
    "hs_security_tls11_score": "number",
    "hs_security_tls12_score": "number",
    "hs_security_tls13_score": "number",
    "hs_security_weak_signature_algo_penalty": "number",
    "latency_audit_props": {
        "conn_est_audit_mode": "string",
        "conn_est_threshold": 0,
        "latency_audit_mode": "string",
        "latency_threshold": 0
    },
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "ondemand_metrics_idle_timeout": 0,
    "ranges": [
        {
            "begin": 0,
            "end": 0
        }
    ],
    "resp_code_block": [
        "string"
    ],
    "sensitive_log_profile": {
        "header_field_rules": [
            {
                "action": "string",
                "enabled": false,
                "index": 0,
                "match": {
                    "match_criteria": "string",
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                },
                "name": "string"
            }
        ],
        "uri_query_field_rules": [
            {
                "action": "string",
                "enabled": false,
                "index": 0,
                "match": {
                    "match_criteria": "string",
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                },
                "name": "string"
            }
        ],
        "waf_field_rules": [
            {
                "action": "string",
                "enabled": false,
                "index": 0,
                "match": {
                    "match_criteria": "string",
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                },
                "name": "string"
            }
        ]
    },
    "sip_log_depth": 0,
    "tenant_ref": "string",
    "time_tracker_props": {
        "be_conn_est_audit_mode": "string",
        "be_conn_est_threshold": 0,
        "fe_conn_est_audit_mode": "string",
        "fe_conn_est_threshold": 0,
        "ingress_sig_log": false
    },
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns AnalyticsProfile of type(s) application/json
"AnalyticsProfile Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

integer As uint32 As uint32
apdex_response_threshold
Optional
Constraints: default: 500

If a client receives an HTTP response in less than the Satisfactory Latency Threshold, the request is considered Satisfied. It is considered Tolerated if it is not Satisfied and less than Tolerated Latency Factor multiplied by the Satisfactory Latency Threshold. Greater than this number and the client's request is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 500), Basic edition(Allowed values- 500), Enterprise with Cloud Services edition.

number As double As double
apdex_response_tolerated_factor
Optional
Constraints: default: 4

Client tolerated response latency factor. Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition.

integer As uint32 As uint32
apdex_rtt_threshold
Optional
Constraints: default: 250

Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 250), Basic edition(Allowed values- 250), Enterprise with Cloud Services edition.

number As double As double
apdex_rtt_tolerated_factor
Optional
Constraints: default: 4

Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition.

integer As uint32 As uint32
apdex_rum_threshold
Optional
Constraints: default: 5000

If a client is able to load a page in less than the Satisfactory Latency Threshold, the PageLoad is considered Satisfied. It is considered tolerated if it is greater than Satisfied but less than the Tolerated Latency multiplied by Satisifed Latency. Greater than this number and the client's request is considered Frustrated. A PageLoad includes the time for DNS lookup, download of all HTTP objects, and page render time. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5000), Basic edition(Allowed values- 5000), Enterprise with Cloud Services edition.

number As double As double
apdex_rum_tolerated_factor
Optional
Constraints: default: 4

Virtual service threshold factor for tolerated Page Load Time (PLT) as multiple of apdex_rum_threshold. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition.

integer As uint32 As uint32
apdex_server_response_threshold
Optional
Constraints: default: 400

A server HTTP response is considered Satisfied if latency is less than the Satisfactory Latency Threshold. The response is considered tolerated when it is greater than Satisfied but less than the Tolerated Latency Factor * S_Latency. Greater than this number and the server response is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 400), Basic edition(Allowed values- 400), Enterprise with Cloud Services edition.

number As double As double
apdex_server_response_tolerated_factor
Optional
Constraints: default: 4

Server tolerated response latency factor. Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition.

integer As uint32 As uint32
apdex_server_rtt_threshold
Optional
Constraints: default: 125

Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 125), Basic edition(Allowed values- 125), Enterprise with Cloud Services edition.

number As double As double
apdex_server_rtt_tolerated_factor
Optional
Constraints: default: 4

Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition.

object
client_log_config
Optional

client_log_config

object
client_log_streaming_config
Optional

client_log_streaming_config

object
configpb_attributes
Optional

configpb_attributes

integer As uint32 As uint32
conn_lossy_ooo_threshold
Optional
Constraints: default: 50

A connection between client and Avi is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_lossy_timeo_rexmt_threshold
Optional
Constraints: default: 20

A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_lossy_total_rexmt_threshold
Optional
Constraints: default: 50

A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_lossy_zero_win_size_event_threshold
Optional
Constraints: default: 2

A client connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2), Basic edition(Allowed values- 2), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_server_lossy_ooo_threshold
Optional
Constraints: default: 50

A connection between Avi and server is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_server_lossy_timeo_rexmt_threshold
Optional
Constraints: default: 20

A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_server_lossy_total_rexmt_threshold
Optional
Constraints: default: 50

A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition.

integer As uint32 As uint32
conn_server_lossy_zero_win_size_event_threshold
Optional
Constraints: default: 2

A server connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2), Basic edition(Allowed values- 2), Enterprise with Cloud Services edition.

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_adaptive_config
Optional
Constraints: default: true

Enable adaptive configuration for optimizing resource usage. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_advanced_analytics
Optional
Constraints: default: true

Enables Advanced Analytics features like Anomaly detection. If set to false, anomaly computation (and associated rules/events) for VS, Pool and Server metrics will be deactivated. However, setting it to false reduces cpu and memory requirements for Analytics subsystem. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

boolean
enable_ondemand_metrics
Optional
Constraints: default: true

Virtual Service (VS) metrics are processed only when there is live data traffic on the VS. In case, VS is idle for a period of time as specified by ondemand_metrics_idle_timeout then metrics processing is suspended for that VS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_se_analytics
Optional
Constraints: default: true

Enable node (service engine) level analytics forvs metrics. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_server_analytics
Optional
Constraints: default: true

Enables analytics on backend servers. This may be desired in container environment when there are large number of ephemeral servers. Additionally, no healthscore of servers is computed when server analytics is enabled. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
enable_vs_analytics
Optional
Constraints: default: true

Enable VirtualService (frontend) Analytics. This flag enables metrics and healthscore for Virtualservice. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
exclude_client_close_before_request_as_error
Optional

Exclude client closed connection before an HTTP request could be completed from being classified as an error. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_dns_policy_drop_as_significant
Optional

Exclude dns policy drops from the list of errors. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_gs_down_as_error
Optional

Exclude queries to GSLB services that are operationally down from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

array of integer
exclude_http_error_codes
Optional

List of HTTP status codes to be excluded from being classified as an error. Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a DoS attack. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
exclude_invalid_dns_domain_as_error
Optional

Exclude dns queries to domains outside the domains configured in the DNS application profile from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_invalid_dns_query_as_error
Optional

Exclude invalid dns queries from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_issuer_revoked_ocsp_responses_as_error
Optional
Constraints: default: true

Exclude the Issuer-Revoked OCSP Responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

boolean
exclude_no_dns_record_as_error
Optional

Exclude queries to domains that did not have configured services/records from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_no_valid_gs_member_as_error
Optional

Exclude queries to GSLB services that have no available members from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_persistence_change_as_error
Optional

Exclude persistence server changed while load balancing' from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_revoked_ocsp_responses_as_error
Optional
Constraints: default: true

Exclude the Revoked OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

boolean
exclude_server_dns_error_as_error
Optional

Exclude server dns error response from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_server_tcp_reset_as_error
Optional

Exclude server TCP reset from errors. It is common for applications like MS Exchange. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

array of integer
exclude_sip_error_codes
Optional

List of SIP status codes to be excluded from being classified as an error. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
exclude_stale_ocsp_responses_as_error
Optional
Constraints: default: true

Exclude the Stale OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

boolean
exclude_syn_retransmit_as_error
Optional

Exclude 'server unanswered syns' from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_tcp_reset_as_error
Optional

Exclude TCP resets by client from the list of potential errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

boolean
exclude_unavailable_ocsp_responses_as_error
Optional
Constraints: default: true

Exclude the unavailable OCSP Responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

boolean
exclude_unsupported_dns_query_as_error
Optional

Exclude unsupported dns queries from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

integer As uint32 As uint32
healthscore_max_server_limit
Optional
Constraints: default: 20

Skips health score computation of pool servers when number of servers in a pool is more than this setting. Allowed values are 0-5000. Special values are 0- server health score is deactivated. Field introduced in 17.2.13, 18.1.4. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. Special default for Essentials edition is 0, Basic edition is 0, Enterprise is 20.

integer As uint32 As uint32
hs_event_throttle_window
Optional
Constraints: default: 1209600

Time window (in secs) within which only unique health change events should occur. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1209600), Basic edition(Allowed values- 1209600), Enterprise with Cloud Services edition.

integer As uint32 As uint32
hs_max_anomaly_penalty
Optional
Constraints: default: 10

Maximum penalty that may be deducted from health score for anomalies. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 10), Basic edition(Allowed values- 10), Enterprise with Cloud Services edition.

integer As uint32 As uint32
hs_max_resources_penalty
Optional
Constraints: default: 25

Maximum penalty that may be deducted from health score for high resource utilization. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 25), Basic edition(Allowed values- 25), Enterprise with Cloud Services edition.

integer As uint32 As uint32
hs_max_security_penalty
Optional
Constraints: default: 100

Maximum penalty that may be deducted from health score based on security assessment. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 100), Basic edition(Allowed values- 100), Enterprise with Cloud Services edition.

integer As uint32 As uint32
hs_min_dos_rate
Optional
Constraints: default: 1000

DoS connection rate below which the DoS security assessment will not kick in. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1000), Basic edition(Allowed values- 1000), Enterprise with Cloud Services edition.

integer As uint32 As uint32
hs_performance_boost
Optional

Adds free performance score credits to health score. It can be used for compensating health score for known slow applications. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition.

number As double As double
hs_pscore_traffic_threshold_l4_client
Optional
Constraints: default: 10

Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 10), Basic edition(Allowed values- 10), Enterprise with Cloud Services edition.

number As double As double
hs_pscore_traffic_threshold_l4_server
Optional
Constraints: default: 10

Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 10), Basic edition(Allowed values- 10), Enterprise with Cloud Services edition.

number As double As double
hs_security_certscore_expired
Optional

Score assigned when the certificate has expired. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_certscore_gt30d
Optional
Constraints: default: 5

Score assigned when the certificate expires in more than 30 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_certscore_le07d
Optional
Constraints: default: 2

Score assigned when the certificate expires in less than or equal to 7 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2.0), Basic edition(Allowed values- 2.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_certscore_le30d
Optional
Constraints: default: 4

Score assigned when the certificate expires in less than or equal to 30 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4.0), Basic edition(Allowed values- 4.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_chain_invalidity_penalty
Optional
Constraints: default: 1

Penalty for allowing certificates with invalid chain. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_cipherscore_eq000b
Optional

Score assigned when the minimum cipher strength is 0 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_cipherscore_ge128b
Optional
Constraints: default: 5

Score assigned when the minimum cipher strength is greater than equal to 128 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_cipherscore_lt128b
Optional
Constraints: default: 3.5

Score assigned when the minimum cipher strength is less than 128 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 3.5), Basic edition(Allowed values- 3.5), Enterprise with Cloud Services edition.

number As double As double
hs_security_encalgo_score_none
Optional

Score assigned when no algorithm is used for encryption. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_encalgo_score_rc4
Optional
Constraints: default: 2.5

Score assigned when RC4 algorithm is used for encryption. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2.5), Basic edition(Allowed values- 2.5), Enterprise with Cloud Services edition.

number As double As double
hs_security_hsts_penalty
Optional
Constraints: default: 1

Penalty for not enabling HSTS. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_nonpfs_penalty
Optional
Constraints: default: 1

Penalty for allowing non-PFS handshakes. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_ocsp_revoked_score
Optional

Score assigned when OCSP Certificate Status is set to Revoked or Issuer Revoked. Allowed values are 0.0-5.0. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_selfsignedcert_penalty
Optional
Constraints: default: 1

Deprecated. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_ssl30_score
Optional
Constraints: default: 3.5

Score assigned when supporting SSL3.0 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 3.5), Basic edition(Allowed values- 3.5), Enterprise with Cloud Services edition.

number As double As double
hs_security_tls10_score
Optional
Constraints: default: 5

Score assigned when supporting TLS1.0 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_tls11_score
Optional
Constraints: default: 5

Score assigned when supporting TLS1.1 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_tls12_score
Optional
Constraints: default: 5

Score assigned when supporting TLS1.2 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_tls13_score
Optional
Constraints: default: 5

Score assigned when supporting TLS1.3 encryption protocol. Allowed values are 0-5. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition.

number As double As double
hs_security_weak_signature_algo_penalty
Optional
Constraints: default: 1

Penalty for allowing weak signature algorithm(s). Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition.

object
latency_audit_props
Optional

latency_audit_props

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

The name of the analytics profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ondemand_metrics_idle_timeout
Optional
Constraints: default: 1800

This flag sets the time duration of no live data traffic after which Virtual Service metrics processing is suspended. It is applicable only when enable_ondemand_metrics is set to false. Field introduced in 18.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
ranges
Optional

List of HTTP status code ranges to be excluded from being classified as an error. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
resp_code_block
Optional

Block of HTTP response codes to be excluded from being classified as an error. Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
sensitive_log_profile
Optional

sensitive_log_profile

integer As uint32 As uint32
sip_log_depth
Optional
Constraints: default: 20

Maximum number of SIP messages added in logs for a SIP transaction. By default, this value is 20. Allowed values are 1-1000. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
time_tracker_props
Optional

time_tracker_props

string
url
Optional

url

string
uuid
Optional

UUID of the analytics profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'