GET /virtualservice/{uuid}/csrfmetrics/

/virtualservice/{uuid}/csrfmetrics/

Request

URI

GET

https://{api_host}/api/virtualservice/{uuid}/csrfmetrics

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.

basicAuth

Responses

200

Returns CsrfMetrics of type(s) application/json

{
    "action_verify_executed": 0,
    "bypassed": 0,
    "label_matched_requests": 0,
    "passed": 0,
    "requests": 0,
    "verify_cookie_failed": 0,
    "verify_origin_failed": 0,
    "verify_token_failed": 0
}

integer As uint64 As uint64

action_verify_executed

Optional

Number of requests for which VERIFY_CSRF_TOKEN (or VERIFY_ORIGIN_AND_CSRF_TOKEN) action was executed. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

bypassed

Optional

Number of requests for which CSRF protection was bypassed. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

label_matched_requests

Optional

Number of requests for which a CSRF rule matched on label. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

passed

Optional

Number of requests for which csrf check passed. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

requests

Optional

Number of requests for which the CSRF policy was run. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

verify_cookie_failed

Optional

Number of requests for which the cookie validation failed. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

verify_origin_failed

Optional

Number of requests for which the origin validation failed. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

verify_token_failed

Optional

Number of requests for which the token validation failed. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

401

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/virtualservice/{uuid}/csrfmetrics

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Virtual Service Operations