Avi StringGroup Object API

CLI ``` - configure stringgroup - show stringgroup ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /stringgroup
  2. post /stringgroup
  3. delete /stringgroup/{uuid}
  4. get /stringgroup/{uuid}
  5. patch /stringgroup/{uuid}
  6. put /stringgroup/{uuid}
Up
get /stringgroup
(stringgroupGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

StringGroupApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "longest_match" : true,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "kv" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ "" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StringGroupApiResponse

401

log in failed

Up
post /stringgroup
(stringgroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — StringGroup object creation

Return type

StringGroup

Example data

Content-Type: application/json
{
  "longest_match" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "kv" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StringGroup

401

log in failed

Up
delete /stringgroup/{uuid}
(stringgroupUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /stringgroup/{uuid}
(stringgroupUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

StringGroup

Example data

Content-Type: application/json
{
  "longest_match" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "kv" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StringGroup

401

log in failed

Up
patch /stringgroup/{uuid}
(stringgroupUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — StringGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

StringGroup

Example data

Content-Type: application/json
{
  "longest_match" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "kv" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StringGroup

401

log in failed

Up
put /stringgroup/{uuid}
(stringgroupUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — StringGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

StringGroup

Example data

Content-Type: application/json
{
  "longest_match" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "kv" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StringGroup

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. KeyValue
  2. StringGroup
  3. StringGroupApiResponse

KeyValue Up

key
String Key.
value (optional)
String Value.

StringGroup Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
description (optional)
String User defined description for the object.
kv (optional)
array[KeyValue] Configure Key Value in the string group.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
longest_match (optional)
Boolean Enable the longest match, default is the shortest match. Field introduced in 18.2.8.
name
String Name of the string group.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
type
String Type of StringGroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL.
url (optional)
String url
uuid (optional)
String UUID of the string group.

StringGroupApiResponse Up

count
Integer format: int32
results
next (optional)