POST /securechanneltoken

POST /securechanneltoken

/securechanneltoken

Request
URI
POST
https://api_host/api/securechanneltoken
COPY
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.

Request Body
SecureChannelToken of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "expiry_time": "number",
    "in_use": false,
    "metadata": [
        {
            "key": "string",
            "val": "string"
        }
    ],
    "name": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

number As double As double
expiry_time
Optional

Expiry time for auth_token. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
in_use
Optional

Whether this auth_token is used by some node(SE/controller). Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of SecureChannelMetadata
metadata
Optional

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

string
name
Required

Auth_token used for SE/controller authorization. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Auth_token used for SE/controller authorization. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Responses
200

OK

Returns SecureChannelToken of type(s) application/json 
{
    "_last_modified": "string",
    "expiry_time": "number",
    "in_use": false,
    "metadata": [
        {
            "key": "string",
            "val": "string"
        }
    ],
    "name": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

number As double As double
expiry_time
Optional

Expiry time for auth_token. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
in_use
Optional

Whether this auth_token is used by some node(SE/controller). Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of SecureChannelMetadata
metadata
Optional

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

string
name
Required

Auth_token used for SE/controller authorization. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Auth_token used for SE/controller authorization. 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

On This Page
Secure Channel Token Operations
DELETE
DELETE /securechanneltoken/{uuid}
GET
GET /securechanneltoken
GET
GET /securechanneltoken/{uuid}
PATCH
PATCH /securechanneltoken/{uuid}
POST
POST /securechanneltoken
PUT
PUT /securechanneltoken/{uuid}