PATCH /stringgroup/{uuid}

PATCH /stringgroup/{uuid}

/stringgroup/{uuid}

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

StringGroup object creation

StringGroup of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "type": "string"
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "kv": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "longest_match": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns StringGroup of type(s) application/json 
"StringGroup Object"
string
_last_modified
Optional

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

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
kv
Optional

Configure Key Value in the string group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
longest_match
Optional

Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name of the string group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

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

string
type
Required
Constraints: default: SG_TYPE_STRING

Type of StringGroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the string group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}'
On This Page
String Group Operations
GET
GET /stringgroup
POST
POST /stringgroup
GET
GET /stringgroup/{uuid}
PUT
PUT /stringgroup/{uuid}
PATCH
PATCH /stringgroup/{uuid}
DELETE
DELETE /stringgroup/{uuid}