POST /applicationprofile

POST /applicationprofile

/applicationprofile

Request
URI
POST
https://{api_host}/api/applicationprofile
COPY
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

ApplicationProfile object creation

ApplicationProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "type": "string"
}
{
    "_last_modified": "string",
    "app_service_type": "string",
    "cloud_config_cksum": "string",
    "configpb_attributes": {
        "version": 0
    },
    "created_by": "string",
    "description": "string",
    "dns_service_profile": {
        "aaaa_empty_response": false,
        "admin_email": "string",
        "client_dns_tcp_request_timeout": 0,
        "close_tcp_connection_post_response": false,
        "dns_over_tcp_enabled": false,
        "dns_zones": [
            {
                "admin_email": "string",
                "domain_name": "string",
                "name_server": "string"
            }
        ],
        "domain_names": [
            "string"
        ],
        "ecs_stripping_enabled": false,
        "edns": false,
        "edns_client_subnet_prefix_len": 0,
        "error_response": "string",
        "name_server": "string",
        "negative_caching_ttl": 0,
        "num_dns_ip": 0,
        "ttl": 0
    },
    "dos_rl_profile": {
        "dos_profile": {
            "thresh_info": [
                {
                    "attack": "string",
                    "max_value": 0,
                    "min_value": 0
                }
            ],
            "thresh_period": 0
        },
        "rl_profile": {
            "client_ip_connections_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "client_ip_failed_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "client_ip_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "client_ip_scanners_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "client_ip_to_uri_failed_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "client_ip_to_uri_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "custom_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "http_header_rate_limits": [
                {
                    "action": {
                        "file": {
                            "content_type": "string",
                            "file_content": "string",
                            "file_length": 0
                        },
                        "redirect": {
                            "add_string": "string",
                            "host": {
                                "tokens": [
                                    {
                                        "end_index": 0,
                                        "start_index": 0,
                                        "str_value": "string",
                                        "type": "string"
                                    }
                                ],
                                "type": "string"
                            },
                            "keep_query": false,
                            "path": {
                                "tokens": [
                                    {
                                        "end_index": 0,
                                        "start_index": 0,
                                        "str_value": "string",
                                        "type": "string"
                                    }
                                ],
                                "type": "string"
                            },
                            "port": 0,
                            "protocol": "string",
                            "status_code": "string"
                        },
                        "status_code": "string",
                        "type": "string"
                    },
                    "explicit_tracking": false,
                    "fine_grain": false,
                    "http_cookie": "string",
                    "http_header": "string",
                    "rate_limiter": {
                        "burst_sz": 0,
                        "count": 0,
                        "name": "string",
                        "period": 0
                    }
                }
            ],
            "uri_failed_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "uri_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            },
            "uri_scanners_requests_rate_limit": {
                "action": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "redirect": {
                        "add_string": "string",
                        "host": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "keep_query": false,
                        "path": {
                            "tokens": [
                                {
                                    "end_index": 0,
                                    "start_index": 0,
                                    "str_value": "string",
                                    "type": "string"
                                }
                            ],
                            "type": "string"
                        },
                        "port": 0,
                        "protocol": "string",
                        "status_code": "string"
                    },
                    "status_code": "string",
                    "type": "string"
                },
                "explicit_tracking": false,
                "fine_grain": false,
                "http_cookie": "string",
                "http_header": "string",
                "rate_limiter": {
                    "burst_sz": 0,
                    "count": 0,
                    "name": "string",
                    "period": 0
                }
            }
        }
    },
    "http_profile": {
        "allow_dots_in_header_name": false,
        "cache_config": {
            "age_header": false,
            "aggressive": false,
            "date_header": false,
            "default_expire": 0,
            "enabled": false,
            "heuristic_expire": false,
            "ignore_request_cache_control": false,
            "max_cache_size": 0,
            "max_object_size": 0,
            "mime_types_block_group_refs": [
                "string"
            ],
            "mime_types_block_lists": [
                "string"
            ],
            "mime_types_group_refs": [
                "string"
            ],
            "mime_types_list": [
                "string"
            ],
            "min_object_size": 0,
            "query_cacheable": false,
            "uri_non_cacheable": {
                "match_case": "string",
                "match_criteria": "string",
                "match_decoded_string": false,
                "match_str": [
                    "string"
                ],
                "string_group_refs": [
                    "string"
                ]
            },
            "xcache_header": false
        },
        "client_body_timeout": 0,
        "client_header_timeout": 0,
        "client_max_body_size": 0,
        "client_max_header_size": 0,
        "client_max_request_size": 0,
        "close_server_side_connection_on_error": false,
        "collect_client_tls_fingerprint": false,
        "compression_profile": {
            "buf_num": 0,
            "buf_size": 0,
            "compressible_content_ref": "string",
            "compression": false,
            "filter": [
                {
                    "devices_ref": "string",
                    "index": 0,
                    "ip_addr_prefixes": [
                        {
                            "ip_addr": {
                                "addr": "string",
                                "type": "string"
                            },
                            "mask": 0
                        }
                    ],
                    "ip_addr_ranges": [
                        {
                            "begin": {
                                "addr": "string",
                                "type": "string"
                            },
                            "end": {
                                "addr": "string",
                                "type": "string"
                            }
                        }
                    ],
                    "ip_addrs": [
                        {
                            "addr": "string",
                            "type": "string"
                        }
                    ],
                    "ip_addrs_ref": "string",
                    "level": "string",
                    "match": "string",
                    "name": "string",
                    "user_agent": [
                        "string"
                    ]
                }
            ],
            "hash_size": 0,
            "level_aggressive": 0,
            "level_normal": 0,
            "max_low_rtt": 0,
            "min_high_rtt": 0,
            "min_length": 0,
            "mobile_str_ref": "string",
            "remove_accept_encoding_header": false,
            "type": "string",
            "window_size": 0
        },
        "connection_multiplexing_enabled": false,
        "detect_ntlm_app": false,
        "disable_keepalive_posts_msie6": false,
        "disable_sni_hostname_check": false,
        "enable_chunk_merge": false,
        "enable_fire_and_forget": false,
        "enable_request_body_buffering": false,
        "enable_request_body_metrics": false,
        "fwd_close_hdr_for_bound_connections": false,
        "hsts_enabled": false,
        "hsts_max_age": 0,
        "hsts_subdomains_enabled": false,
        "http2_profile": {
            "enable_http2_server_push": false,
            "http2_initial_window_size": 0,
            "max_http2_concurrent_pushes_per_connection": 0,
            "max_http2_concurrent_streams_per_connection": 0,
            "max_http2_control_frames_per_connection": 0,
            "max_http2_empty_data_frames_per_connection": 0,
            "max_http2_header_field_size": 0,
            "max_http2_queued_frames_to_client_per_connection": 0,
            "max_http2_requests_per_connection": 0
        },
        "http_to_https": false,
        "http_upstream_buffer_size": 0,
        "httponly_enabled": false,
        "keepalive_header": false,
        "keepalive_timeout": 0,
        "max_bad_rps_cip": 0,
        "max_bad_rps_cip_uri": 0,
        "max_bad_rps_uri": 0,
        "max_header_count": 0,
        "max_keepalive_requests": 0,
        "max_response_headers_size": 0,
        "max_rps_cip": 0,
        "max_rps_cip_uri": 0,
        "max_rps_unknown_cip": 0,
        "max_rps_unknown_uri": 0,
        "max_rps_uri": 0,
        "pass_through_x_accel_headers": false,
        "pki_profile_ref": "string",
        "post_accept_timeout": 0,
        "reset_conn_http_on_ssl_port": false,
        "respond_with_100_continue": false,
        "secure_cookie_enabled": false,
        "server_side_redirect_to_https": false,
        "session_config": {
            "session_cookie_httponly": false,
            "session_cookie_name": "string",
            "session_cookie_samesite": "string",
            "session_cookie_secure": false,
            "session_establishment_timeout": 0,
            "session_idle_timeout": 0,
            "session_maximum_timeout": 0
        },
        "ssl_client_certificate_action": {
            "close_connection": false,
            "headers": [
                {
                    "request_header": "string",
                    "request_header_value": "string"
                }
            ]
        },
        "ssl_client_certificate_mode": "string",
        "true_client_ip": {
            "direction": "string",
            "headers": [
                "string"
            ],
            "index_in_header": 0
        },
        "use_app_keepalive_timeout": false,
        "use_true_client_ip": false,
        "websockets_enabled": false,
        "x_forwarded_proto_enabled": false,
        "xff_alternate_name": "string",
        "xff_enabled": false,
        "xff_update": "string"
    },
    "l4_ssl_profile": {
        "ssl_stream_idle_timeout": 0
    },
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "preserve_client_ip": false,
    "preserve_client_port": false,
    "preserve_dest_ip_port": false,
    "sip_service_profile": {
        "transaction_timeout": 0
    },
    "tcp_app_profile": {
        "ftp_profile": {
            "deactivate_active": false,
            "deactivate_passive": false
        },
        "pki_profile_ref": "string",
        "proxy_protocol_enabled": false,
        "proxy_protocol_version": "string",
        "ssl_client_certificate_mode": "string"
    },
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

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

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

string
app_service_type
Optional

Specifies app service type for an application. Enum options - APP_SERVICE_TYPE_L7_HORIZON, APP_SERVICE_TYPE_L4_BLAST, APP_SERVICE_TYPE_L4_PCOIP, APP_SERVICE_TYPE_L4_FTP. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
cloud_config_cksum
Optional

Checksum of application profiles. Internally set by cloud connector. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

string
created_by
Optional

Name of the application profile creator. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

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

object
dns_service_profile
Optional

dns_service_profile

object
dos_rl_profile
Optional

dos_rl_profile

object
http_profile
Optional

http_profile

object
l4_ssl_profile
Optional

l4_ssl_profile

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 application profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
preserve_client_ip
Optional

Specifies if client IP needs to be preserved for backend connection. Not compatible with Connection Multiplexing. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
preserve_client_port
Optional

Specifies if we need to preserve client port while preserving client IP for backend connections. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
preserve_dest_ip_port
Optional

Specifies if destination IP and port needs to be preserved for backend connection. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

object
sip_service_profile
Optional

sip_service_profile

object
tcp_app_profile
Optional

tcp_app_profile

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.

string
type
Required

Specifies which application layer proxy is enabled for the virtual service. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- APPLICATION_PROFILE_TYPE_L4), Basic edition(Allowed values- APPLICATION_PROFILE_TYPE_L4,APPLICATION_PROFILE_TYPE_HTTP), Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the application 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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}' https://{api_host}/api/applicationprofile