GET /tenant/{uuid}

GET /tenant/{uuid}

/tenant/{uuid}

Request
URI
GET
https://{api_host}/api/tenant/{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 Tenant of type(s) application/json 
{
    "_last_modified": "string",
    "attrs": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "config_settings": {
        "se_in_provider_context": false,
        "tenant_access_to_provider_se": false,
        "tenant_vrf": false
    },
    "configpb_attributes": {
        "version": 0
    },
    "created_by": "string",
    "description": "string",
    "enforce_label_group": false,
    "label_group_refs": [
        "string"
    ],
    "local": false,
    "name": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

array of object
attrs
Optional

Key/value tenant attributes. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
config_settings
Optional

config_settings

object
configpb_attributes
Optional

configpb_attributes

string
created_by
Optional

Creator of this tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

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

boolean
enforce_label_group
Optional

The referred label groups are enforced on the tenant if this is set to true.If this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string
label_group_refs
Optional

The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to True. It is a reference to an object of type LabelGroup. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
local
Optional
Constraints: default: true

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

string
name
Required

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

string
url
Optional

url

string
uuid
Optional

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 -H 'Authorization: <value>' https://{api_host}/api/tenant/{uuid}
On This Page
Tenant Operations
GET
GET /tenant
POST
POST /tenant
GET
GET /tenant/{uuid}
PUT
PUT /tenant/{uuid}
PATCH
PATCH /tenant/{uuid}
DELETE
DELETE /tenant/{uuid}