PATCH /apiratelimitprofile/{uuid}

PATCH /apiratelimitprofile/{uuid}

/apiratelimitprofile/{uuid}/{uuid}

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

ApiRateLimitProfile object creation

ApiRateLimitProfile of type(s) application/json
Optional

Show optional properties

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

OK

Returns ApiRateLimitProfile of type(s) application/json 
{
    "_last_modified": "string",
    "description": "string",
    "enabled": false,
    "name": "string",
    "rate_limit_configuration_refs": [
        "string"
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
description
Optional

Description for the Api Rate Limit Profile. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
enabled
Optional
Constraints: default: true

Activate/Deactivate the Api Rate Limit Profile. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Required

Name of the Api Rate Limit Profile. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of string
rate_limit_configuration_refs
Optional

List of the Rate Limiter configuration UUIDs. It is a reference to an object of type RateLimitConfiguration. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 100 items allowed. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant ref for the Api Rate Limit Profile. It is a reference to an object of type Tenant. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the Api Rate Limit Profile. Field introduced in 31.2.1. Allowed with any value in Enterprise, 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 -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}'
On This Page
Api Rate Limit Profile Operations
GET
GET /apiratelimitprofile
POST
POST /apiratelimitprofile
GET
GET /apiratelimitprofile/{uuid}
PUT
PUT /apiratelimitprofile/{uuid}
PATCH
PATCH /apiratelimitprofile/{uuid}
DELETE
DELETE /apiratelimitprofile/{uuid}