Avi WebappUT Object API

CLI ``` - configure webapput - show webapput ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.6
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 /webapput
  2. post /webapput
  3. delete /webapput/{uuid}
  4. get /webapput/{uuid}
  5. patch /webapput/{uuid}
  6. put /webapput/{uuid}
Up
get /webapput
(webapputGet)

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

WebappUTApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "string_length_test" : {
      "string_length_messages" : [ "" ],
      "test_string" : "aeiou",
      "string_length_message" : {
        "string_length_messages" : [ "" ],
        "test_string" : "aeiou",
        "string_length_message" : {
          "test_string" : "aeiou"
        },
        "test_strings" : [ "aeiou" ]
      },
      "test_strings" : [ "aeiou" ]
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "sensitive_test" : {
      "sensitive_messages" : [ "" ],
      "sensitive_message" : {
        "sensitive_messages" : [ "" ],
        "sensitive_message" : {
          "optional_sensitive_string" : "aeiou"
        },
        "sensitive_string" : "aeiou"
      },
      "sensitive_string" : "aeiou"
    },
    "mandatory_test" : {
      "mandatory_messages" : [ "" ],
      "mandatory_string" : "aeiou",
      "mandatory_strings" : [ "aeiou" ],
      "mandatory_message" : {
        "mandatory_messages" : [ "" ],
        "mandatory_string" : "aeiou",
        "mandatory_strings" : [ "aeiou" ],
        "mandatory_message" : {
          "optional_string" : "aeiou"
        }
      }
    },
    "mandatory_tests" : [ "" ],
    "string_length_tests" : [ "" ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "sensitive_tests" : [ "" ],
    "test_string" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "test_sensitive_string" : "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

200

OK WebappUTApiResponse

401

log in failed

Up
post /webapput
(webapputPost)

Consumes

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

Request body

body (required)
Body Parameter — WebappUT object creation

Return type

WebappUT

Example data

Content-Type: application/json
{
  "string_length_test" : {
    "string_length_messages" : [ "" ],
    "test_string" : "aeiou",
    "string_length_message" : {
      "string_length_messages" : [ "" ],
      "test_string" : "aeiou",
      "string_length_message" : {
        "test_string" : "aeiou"
      },
      "test_strings" : [ "aeiou" ]
    },
    "test_strings" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "sensitive_test" : {
    "sensitive_messages" : [ "" ],
    "sensitive_message" : {
      "sensitive_messages" : [ "" ],
      "sensitive_message" : {
        "optional_sensitive_string" : "aeiou"
      },
      "sensitive_string" : "aeiou"
    },
    "sensitive_string" : "aeiou"
  },
  "mandatory_test" : {
    "mandatory_messages" : [ "" ],
    "mandatory_string" : "aeiou",
    "mandatory_strings" : [ "aeiou" ],
    "mandatory_message" : {
      "mandatory_messages" : [ "" ],
      "mandatory_string" : "aeiou",
      "mandatory_strings" : [ "aeiou" ],
      "mandatory_message" : {
        "optional_string" : "aeiou"
      }
    }
  },
  "mandatory_tests" : [ "" ],
  "string_length_tests" : [ "" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "sensitive_tests" : [ "" ],
  "test_string" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "test_sensitive_string" : "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

200

OK WebappUT

401

log in failed

Up
delete /webapput/{uuid}
(webapputUuidDelete)

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 /webapput/{uuid}
(webapputUuidGet)

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

WebappUT

Example data

Content-Type: application/json
{
  "string_length_test" : {
    "string_length_messages" : [ "" ],
    "test_string" : "aeiou",
    "string_length_message" : {
      "string_length_messages" : [ "" ],
      "test_string" : "aeiou",
      "string_length_message" : {
        "test_string" : "aeiou"
      },
      "test_strings" : [ "aeiou" ]
    },
    "test_strings" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "sensitive_test" : {
    "sensitive_messages" : [ "" ],
    "sensitive_message" : {
      "sensitive_messages" : [ "" ],
      "sensitive_message" : {
        "optional_sensitive_string" : "aeiou"
      },
      "sensitive_string" : "aeiou"
    },
    "sensitive_string" : "aeiou"
  },
  "mandatory_test" : {
    "mandatory_messages" : [ "" ],
    "mandatory_string" : "aeiou",
    "mandatory_strings" : [ "aeiou" ],
    "mandatory_message" : {
      "mandatory_messages" : [ "" ],
      "mandatory_string" : "aeiou",
      "mandatory_strings" : [ "aeiou" ],
      "mandatory_message" : {
        "optional_string" : "aeiou"
      }
    }
  },
  "mandatory_tests" : [ "" ],
  "string_length_tests" : [ "" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "sensitive_tests" : [ "" ],
  "test_string" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "test_sensitive_string" : "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

200

OK WebappUT

401

log in failed

Up
patch /webapput/{uuid}
(webapputUuidPatch)

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 — WebappUT object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

WebappUT

Example data

Content-Type: application/json
{
  "string_length_test" : {
    "string_length_messages" : [ "" ],
    "test_string" : "aeiou",
    "string_length_message" : {
      "string_length_messages" : [ "" ],
      "test_string" : "aeiou",
      "string_length_message" : {
        "test_string" : "aeiou"
      },
      "test_strings" : [ "aeiou" ]
    },
    "test_strings" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "sensitive_test" : {
    "sensitive_messages" : [ "" ],
    "sensitive_message" : {
      "sensitive_messages" : [ "" ],
      "sensitive_message" : {
        "optional_sensitive_string" : "aeiou"
      },
      "sensitive_string" : "aeiou"
    },
    "sensitive_string" : "aeiou"
  },
  "mandatory_test" : {
    "mandatory_messages" : [ "" ],
    "mandatory_string" : "aeiou",
    "mandatory_strings" : [ "aeiou" ],
    "mandatory_message" : {
      "mandatory_messages" : [ "" ],
      "mandatory_string" : "aeiou",
      "mandatory_strings" : [ "aeiou" ],
      "mandatory_message" : {
        "optional_string" : "aeiou"
      }
    }
  },
  "mandatory_tests" : [ "" ],
  "string_length_tests" : [ "" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "sensitive_tests" : [ "" ],
  "test_string" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "test_sensitive_string" : "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

200

OK WebappUT

401

log in failed

Up
put /webapput/{uuid}
(webapputUuidPut)

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 — WebappUT object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

WebappUT

Example data

Content-Type: application/json
{
  "string_length_test" : {
    "string_length_messages" : [ "" ],
    "test_string" : "aeiou",
    "string_length_message" : {
      "string_length_messages" : [ "" ],
      "test_string" : "aeiou",
      "string_length_message" : {
        "test_string" : "aeiou"
      },
      "test_strings" : [ "aeiou" ]
    },
    "test_strings" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "sensitive_test" : {
    "sensitive_messages" : [ "" ],
    "sensitive_message" : {
      "sensitive_messages" : [ "" ],
      "sensitive_message" : {
        "optional_sensitive_string" : "aeiou"
      },
      "sensitive_string" : "aeiou"
    },
    "sensitive_string" : "aeiou"
  },
  "mandatory_test" : {
    "mandatory_messages" : [ "" ],
    "mandatory_string" : "aeiou",
    "mandatory_strings" : [ "aeiou" ],
    "mandatory_message" : {
      "mandatory_messages" : [ "" ],
      "mandatory_string" : "aeiou",
      "mandatory_strings" : [ "aeiou" ],
      "mandatory_message" : {
        "optional_string" : "aeiou"
      }
    }
  },
  "mandatory_tests" : [ "" ],
  "string_length_tests" : [ "" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "sensitive_tests" : [ "" ],
  "test_string" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "test_sensitive_string" : "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

200

OK WebappUT

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ConfigPbAttributes
  2. L1FMandatoryTestCase
  3. L1FSensitiveTestCase
  4. L1StringLengthTestCase
  5. L2FMandatoryTestCase
  6. L2FSensitiveTestCase
  7. L2StringLengthTestCase
  8. SingleOptionalFieldMessage
  9. SingleOptionalSensitiveFieldMessage
  10. SingleOptionalStringField
  11. WebappUT
  12. WebappUTApiResponse

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

L1FMandatoryTestCase Up

mandatory_message
L2FMandatoryTestCase f_mandatory message for nested f_mandatory test cases-level2. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_messages
array[L2FMandatoryTestCase] Repeated f_mandatory_message for nested f_mandatory test cases-level2. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_string
String f_mandatory string field for nested f_mandatory test cases-level1. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_strings
array[String] Repeated f_mandatory string field for nested f_mandatory test cases-level1. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

L1FSensitiveTestCase Up

sensitive_message (optional)
L2FSensitiveTestCase f_sensitive message for nested f_sensitive test cases-level2. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_messages (optional)
array[L2FSensitiveTestCase] Repeated f_sensitive_message for nested f_sensitive test cases-level2. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_string (optional)
String f_sensitive string field for nested f_sensitive test cases-level1. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

L1StringLengthTestCase Up

string_length_message (optional)
L2StringLengthTestCase String length message for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string_length_messages (optional)
array[L2StringLengthTestCase] Repeated string length message for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_string (optional)
String String field for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_strings (optional)
array[String] Repeated field for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

L2FMandatoryTestCase Up

mandatory_message
SingleOptionalFieldMessage f_mandatory message for nested f_mandatory test cases-level3. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_messages
array[SingleOptionalFieldMessage] Repeated f_mandatory_message for nested f_mandatory test cases-level3. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_string
String f_mandatory string field for nested f_mandatory test cases-level2. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_strings
array[String] Repeated f_mandatory string field for nested f_mandatory test cases-level2. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

L2FSensitiveTestCase Up

sensitive_message (optional)
SingleOptionalSensitiveFieldMessage f_sensitive message for nested f_sensitive test cases-level3. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_messages (optional)
array[SingleOptionalSensitiveFieldMessage] Repeated f_sensitive_message for nested f_sensitive test cases-level3. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_string (optional)
String f_sensitive string field for nested f_sensitive test cases-level2. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

L2StringLengthTestCase Up

string_length_message (optional)
SingleOptionalStringField String length message for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string_length_messages (optional)
array[SingleOptionalStringField] Repeated string length message for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_string (optional)
String String field for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_strings (optional)
array[String] Repeated string field for nested string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SingleOptionalFieldMessage Up

optional_string (optional)
String Optional string field for nested f_mandatory test cases-level3. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SingleOptionalSensitiveFieldMessage Up

optional_sensitive_string (optional)
String Optional string field for nested f_mandatory test cases-level3. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SingleOptionalStringField Up

test_string (optional)
String Optional string field. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

WebappUT Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
mandatory_test (optional)
L1FMandatoryTestCase Optional message for nested f_mandatory test cases defined at level1. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mandatory_tests (optional)
array[L1FMandatoryTestCase] Repeated message for nested f_mandatory test cases-level1. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Name of the WebappUT object-level0. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_test (optional)
L1FSensitiveTestCase Optional message for nested f_sensitive test cases defined at level1. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sensitive_tests (optional)
array[L1FSensitiveTestCase] Repeated message for nested f_sensitive test cases-level1. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string_length_test (optional)
L1StringLengthTestCase Optional message for nested max string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string_length_tests (optional)
array[L1StringLengthTestCase] Repeated message for nested max string length test cases. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String Tenant of the WebappUT object-level0. It is a reference to an object of type Tenant. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_sensitive_string (optional)
String The string for sensitive (secret) field. object-level0. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
test_string (optional)
String The maximum string length. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String UUID of the WebappUT object-level0. Field introduced in 21.1.5, 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

WebappUTApiResponse Up

count
Integer format: int32
results
next (optional)