ApiPathLabelEntry

ApiPathLabelEntry
ApiPathLabelEntry
JSON Example
{
    "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.

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.