GET /securechannelmapping/{uuid}
/securechannelmapping/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
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.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
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.
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.
OK
{
"_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"
}
UNIX time since epoch in microseconds. Units(MICROSECONDS).
Auth_token used for SE authorization. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
IP of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Whether this entry used for controller. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Local ip on controller side reserved for SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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.
Metadata associated with auth_token. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Uuid of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Public key of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Public key pem of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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.
url
Uuid of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/securechannelmapping/{uuid}