GET /apipath/{uuid}/labels/

GET /apipath/{uuid}/labels/

/apipath/{uuid}/labels/

Request
URI
GET
https://{api_host}/api/apipath/{uuid}/labels
COPY
Path Parameters
string
uuid
Required  

UUID of the object to fetch

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

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.

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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ApiPathLabelEntry of type(s) application/json 
{
    "apipolicy_uuid": "string",
    "enabled": false,
    "http_method": "string",
    "inherited": false,
    "name": "string",
    "status": {
        "reason": "string",
        "state": "string"
    },
    "type": "string"
}
string
apipolicy_uuid
Optional

UUID of the ApiPolicy this entry is attributed to. Omitted only when no ApiPolicy references this ApiPath at all. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enabled
Optional

This entry's own enabled toggle the endpoint's own toggle when inherited is false, or the matched ApiPolicy container's toggle when inherited is true. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
http_method
Optional

HTTP method of the endpoint this label applies to. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
inherited
Optional

false when set directly on the endpoint, true when inherited from the parent ApiPolicy's type-based container. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Optional

The label name. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object
status
Optional

status

string
type
Optional

System-defined or user-defined, from this label's own definition. Omitted when this label is not defined in any LabelProfile reachable from this ApiPath. Enum options - LABEL_SYSTEM_DEFINED, LABEL_USER_DEFINED. 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

404

object not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/apipath/{uuid}/labels
On This Page
Api Path Operations
GET
GET /apipath
POST
POST /apipath
GET
GET /apipath/{uuid}
PUT
PUT /apipath/{uuid}
PATCH
PATCH /apipath/{uuid}
DELETE
DELETE /apipath/{uuid}
GET
GET /apipath/{uuid}/labels/