GET /webapput/{uuid}

GET /webapput/{uuid}

/webapput/{uuid}

Request
URI
GET
https://{api_host}/api/webapput/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

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.


Responses
200

OK

Returns WebappUT of type(s) application/json
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "default_first_int": 0,
    "default_second_int": 0,
    "default_string": "string",
    "default_third_int": 0,
    "mandatory_test": {
        "mandatory_message": {
            "mandatory_message": {
                "optional_string": "string"
            },
            "mandatory_messages": [
                {
                    "optional_string": "string"
                }
            ],
            "mandatory_string": "string",
            "mandatory_strings": [
                "string"
            ]
        },
        "mandatory_messages": [
            {
                "mandatory_message": {
                    "optional_string": "string"
                },
                "mandatory_messages": [
                    {
                        "optional_string": "string"
                    }
                ],
                "mandatory_string": "string",
                "mandatory_strings": [
                    "string"
                ]
            }
        ],
        "mandatory_string": "string",
        "mandatory_strings": [
            "string"
        ]
    },
    "mandatory_tests": [
        {
            "mandatory_message": {
                "mandatory_message": {
                    "optional_string": "string"
                },
                "mandatory_messages": [
                    {
                        "optional_string": "string"
                    }
                ],
                "mandatory_string": "string",
                "mandatory_strings": [
                    "string"
                ]
            },
            "mandatory_messages": [
                {
                    "mandatory_message": {
                        "optional_string": "string"
                    },
                    "mandatory_messages": [
                        {
                            "optional_string": "string"
                        }
                    ],
                    "mandatory_string": "string",
                    "mandatory_strings": [
                        "string"
                    ]
                }
            ],
            "mandatory_string": "string",
            "mandatory_strings": [
                "string"
            ]
        }
    ],
    "name": "string",
    "sensitive_test": {
        "sensitive_message": {
            "sensitive_message": {
                "optional_sensitive_string": "string"
            },
            "sensitive_messages": [
                {
                    "optional_sensitive_string": "string"
                }
            ],
            "sensitive_string": "string"
        },
        "sensitive_messages": [
            {
                "sensitive_message": {
                    "optional_sensitive_string": "string"
                },
                "sensitive_messages": [
                    {
                        "optional_sensitive_string": "string"
                    }
                ],
                "sensitive_string": "string"
            }
        ],
        "sensitive_string": "string"
    },
    "sensitive_tests": [
        {
            "sensitive_message": {
                "sensitive_message": {
                    "optional_sensitive_string": "string"
                },
                "sensitive_messages": [
                    {
                        "optional_sensitive_string": "string"
                    }
                ],
                "sensitive_string": "string"
            },
            "sensitive_messages": [
                {
                    "sensitive_message": {
                        "optional_sensitive_string": "string"
                    },
                    "sensitive_messages": [
                        {
                            "optional_sensitive_string": "string"
                        }
                    ],
                    "sensitive_string": "string"
                }
            ],
            "sensitive_string": "string"
        }
    ],
    "skip_optional_check_tests": false,
    "string_length_test": {
        "string_length_message": {
            "string_length_message": {
                "test_string": "string"
            },
            "string_length_messages": [
                {
                    "test_string": "string"
                }
            ],
            "test_string": "string",
            "test_strings": [
                "string"
            ]
        },
        "string_length_messages": [
            {
                "string_length_message": {
                    "test_string": "string"
                },
                "string_length_messages": [
                    {
                        "test_string": "string"
                    }
                ],
                "test_string": "string",
                "test_strings": [
                    "string"
                ]
            }
        ],
        "test_string": "string",
        "test_strings": [
            "string"
        ]
    },
    "string_length_tests": [
        {
            "string_length_message": {
                "string_length_message": {
                    "test_string": "string"
                },
                "string_length_messages": [
                    {
                        "test_string": "string"
                    }
                ],
                "test_string": "string",
                "test_strings": [
                    "string"
                ]
            },
            "string_length_messages": [
                {
                    "string_length_message": {
                        "test_string": "string"
                    },
                    "string_length_messages": [
                        {
                            "test_string": "string"
                        }
                    ],
                    "test_string": "string",
                    "test_strings": [
                        "string"
                    ]
                }
            ],
            "test_string": "string",
            "test_strings": [
                "string"
            ]
        }
    ],
    "tenant_ref": "string",
    "test_sensitive_string": "string",
    "test_string": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

object
configpb_attributes
Optional

configpb_attributes

integer As uint64 As uint64
default_first_int
Optional
Constraints: default: 1

default uint64 field. Field introduced in 30.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int64 As int64
default_second_int
Optional
Constraints: default: 2

default int64 field. Field introduced in 30.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
default_string
Optional
Constraints: default: default string

Default string field. Field introduced in 30.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
default_third_int
Optional
Constraints: default: 3

default int32 field. Field introduced in 30.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
mandatory_test
Optional

mandatory_test

array of object
mandatory_tests
Optional

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.

string
name
Required

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.

object
sensitive_test
Optional

sensitive_test

array of object
sensitive_tests
Optional

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.

boolean
skip_optional_check_tests
Optional

Optional bool for nested skip_optional_check test cases-level1. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
string_length_test
Optional

string_length_test

array of object
string_length_tests
Optional

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.

string
tenant_ref
Optional

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.

string
test_sensitive_string
Optional

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.

string
test_string
Optional

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.

string
url
Optional

url

string
uuid
Optional

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.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/webapput/{uuid}