PATCH /applicationpersistenceprofile/{uuid}

PATCH /applicationpersistenceprofile/{uuid}

/applicationpersistenceprofile/{uuid}

Request
URI
PATCH
https://{api_host}/api/applicationpersistenceprofile/{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

ApplicationPersistenceProfile object creation

ApplicationPersistenceProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "persistence_type": "string"
}
{
    "_last_modified": "string",
    "app_cookie_persistence_profile": {
        "encryption_key": "string",
        "prst_hdr_name": "string",
        "timeout": 0
    },
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "diameter_app_persistence_profile": {
        "avp_key_type": "string",
        "timeout": 0
    },
    "hdr_persistence_profile": {
        "prst_hdr_name": "string"
    },
    "http_cookie_persistence_profile": {
        "always_send_cookie": false,
        "cookie_name": "string",
        "encryption_key": "string",
        "http_only": false,
        "is_persistent_cookie": false,
        "key": [
            {
                "aes_key": "string",
                "hmac_key": "string",
                "name": "string"
            }
        ],
        "timeout": 0
    },
    "ip_persistence_profile": {
        "ip_mask": 0,
        "ip_persistent_timeout": 0
    },
    "is_federated": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "persistence_type": "string",
    "server_hm_down_recovery": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

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

object
app_cookie_persistence_profile
Optional

app_cookie_persistence_profile

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

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

object
diameter_app_persistence_profile
Optional

diameter_app_persistence_profile

object
hdr_persistence_profile
Optional

hdr_persistence_profile

object
http_cookie_persistence_profile
Optional

http_cookie_persistence_profile

object
ip_persistence_profile
Optional

ip_persistence_profile

boolean
is_federated
Optional

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
markers
Optional

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

string
name
Required

A user-friendly name for the persistence profile. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
persistence_type
Required
Constraints: default: PERSISTENCE_TYPE_CLIENT_IP_ADDRESS

Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE, PERSISTENCE_TYPE_APP_DIAMETER. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Basic (Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition.

string
server_hm_down_recovery
Optional
Constraints: default: HM_DOWN_PICK_NEW_SERVER

Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- HM_DOWN_PICK_NEW_SERVER), Basic (Allowed values- HM_DOWN_PICK_NEW_SERVER) edition.

string
tenant_ref
Optional

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

string
url
Optional

url

string
uuid
Optional

UUID of the persistence profile. Allowed with any value in Enterprise, 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","persistence_type:"string"}'