GET /securechannelmapping/{uuid}

/securechannelmapping/{uuid}

Request

URI

GET

https://api_host/api/securechannelmapping/{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

Returns SecureChannelMapping of type(s) application/json

{
    "_last_modified": "string",
    "auth_token": "string",
    "ip": "string",
    "is_controller": false,
    "local_ip": "string",
    "marked_for_delete": false,
    "metadata": [
        {
            "key": "string",
            "val": "string"
        }
    ],
    "name": "string",
    "pub_key": "string",
    "pub_key_pem": "string",
    "status": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

string

auth_token

Optional

Auth_token used for SE authorization. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

Optional

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

boolean

is_controller

Optional

Whether this entry used for controller. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

local_ip

Optional

Local ip on controller side reserved for SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

marked_for_delete

Optional

Whether this entry is marked for delete (first step of deletion). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of SecureChannelMetadata

metadata

Optional

Metadata associated with auth_token. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

name

Required

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

string

pub_key

Optional

Public key of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

pub_key_pem

Optional

Public key pem of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

status

Optional

Authorization status of current secure channel. Enum options - SECURE_CHANNEL_NONE, SECURE_CHANNEL_CONNECTED, SECURE_CHANNEL_AUTH_SSH_SUCCESS, SECURE_CHANNEL_AUTH_SSH_FAILED, SECURE_CHANNEL_AUTH_TOKEN_SUCCESS, SECURE_CHANNEL_AUTH_TOKEN_FAILED, SECURE_CHANNEL_AUTH_ERRORS, SECURE_CHANNEL_AUTH_IGNORED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

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

401

Operation doesn't return any data structure

On This Page

Description