The Authentication REST API
The Authentication API helps to enable and disable ASE sideband authentication. You can also retrieve the authentication status.
Enable or disable sideband authentication
URL |
|
|
Method |
POST |
|
Query Parameter |
|
Valid values:enable or disable |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> |
|
The following is a sample curl command:
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/authentication?status=enable
' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'The following are sample responses:
{
"status": "disabled",
"status_message": "Sideband authentication is disabled"
}{
"status": "enabled",
"status_message": "Sideband authentication is enabled"
}Get authentication status
URL |
/v5/ase/sideband/authentication |
Method |
GET |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> |
The following is a sample curl command:
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/authentication' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'The following are sample responses:
{
"status": "disabled",
"status_message": "Sideband authentication is disabled"
}{
"status": "enabled",
"status_message": "Sideband authentication is enabled"
}