POST /labelprofile

POST /labelprofile

/labelprofile

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

LabelProfile object creation

LabelProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "description": "string",
    "label_definitions": [
        {
            "description": "string",
            "match_action_scopes": [
                "string"
            ],
            "name": "string",
            "type": "string"
        }
    ],
    "log_labels": false,
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LabelProfile of type(s) application/json 
{
    "_last_modified": "string",
    "description": "string",
    "label_definitions": [
        {
            "description": "string",
            "match_action_scopes": [
                "string"
            ],
            "name": "string",
            "type": "string"
        }
    ],
    "log_labels": false,
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Read-Only  

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

string
description
Optional

Description of this label profile. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
label_definitions
Optional

Labels available in this profile. Label names must be unique (case-insensitive). Field introduced in 32.1.4. Maximum of 256 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
log_labels
Optional
Constraints: default: true

Enables logging of WAAP labels effective for a request into ApiLog.effective_labels in the application log. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required  

Name of this object, unique per Tenant. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

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

string
url
Read-Only  

url

string
uuid
Optional

The object UUID. Field introduced in 32.1.4. 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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}' https://{api_host}/api/labelprofile
On This Page
Label Profile Operations
GET
GET /labelprofile
POST
POST /labelprofile
GET
GET /labelprofile/{uuid}
PUT
PUT /labelprofile/{uuid}
PATCH
PATCH /labelprofile/{uuid}
DELETE
DELETE /labelprofile/{uuid}
GET
GET /labelprofile/{uuid}/status/
GET
GET /labelprofile/{uuid}/usage/