ASE provides REST APIs for authentication and sideband token management.
Authentication
The Authentication
API helps to enable and disable ASE sideband
authentication. You can also retrieve the authentication status.
Description: Enable or disable sideband authentication.
URL |
/v5/ase/sideband/authentication?status=<value>
|
|
Method | POST | |
Query Parameter | status | Valid values: enable or disable |
Request Headers |
|
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'
Sample Responses
{
"status": "disabled",
"status_message": "Sideband authentication is disabled"
}
{
"status": "enabled",
"status_message": "Sideband authentication is enabled"
}
Description: Get sideband authentication status.
URL |
|
Method | GET |
Request Headers |
|
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'
Sample Responses
{
"status": "disabled",
"status_message": "Sideband authentication is disabled"
}
{
"status": "enabled",
"status_message": "Sideband authentication is enabled"
}
Token
The Token
API helps to create, import, and delete ASE sideband
tokens. You can also retrieve the list of tokens issued by ASE.
Description: Create a new sideband token.
URL |
|
Method | POST |
Request Headers |
|
Sample curl
command
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
Sample Response
{
"status": "token_created",
"token": "dac5fkdfjdlfjdlfjldkfjd1ab08903453fec4c0"
}
Description: Import a sideband token. The token should be 32 character long,
and the allowable characters in the token are: alphabets in small case and digits
0-9.
Sample curl command
URL |
|
Method | PUT |
Request Headers |
|
curl --location --request PUT '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: admin' \
--header 'x-ase-secret-key: admin' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "dc6684370f014923b8a070c982601f7c"
}
Sample Request{ "token": "dc6684370f014923b8a070c982601f75"}
Sample Response{
"status": "success",
"status_message": "Sideband token dc6684370f014923b8a070c982601f75 imported."
}
Description: Delete a sideband token.
Sample curl command
URL |
|
Method | DELETE |
Request Headers |
|
curl --location --request DELETE '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: admin' \
--header 'x-ase-secret-key: admin' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "dc6684370f014923b8a070c982601f7c"
}
Sample Request{ "token": "dc6684370f014923b8a070c982601f75"}
Sample Response{
"status": "success",
"status_message": "Sideband token dc6684370f014923b8a070c982601f75 deleted."
}
Description: List all sideband token.
Sample curl command
URL |
|
Method | GET |
Request Headers |
|
curl --location --request GET '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
Sample Response{
"sideband_tokens": [
{
"token": "dac559bf75904141ab08903453fec4c0",
"created_at": "2021-May-06 14:02:44"
},
{
"token": "dc6684370f014923b8a070c982601c74",
"created_at": "2021-May-06 13:51:55"
}
]
}