The Token REST API
The Token
API helps to create, import, and delete ASE sideband tokens. You can also retrieve the list of tokens issued by ASE.
Create a new sideband token
URL |
/v5/ase/sideband/token |
Method |
POST |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> |
The following is 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'
The following is a sample response:
{
"status": "token_created",
"token": "dac5fkdfjdlfjdlfjldkfjd1ab08903453fec4c0"
}
Import a sideband token
The token should be 32 character long, and the allowable characters in the token are alphabets in lowercase and digits 0-9.
URL |
/v5/ase/sideband/token |
Method |
PUT |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> Content-Type: application/json |
The following is a sample curl command:
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"
}
The following is a sample request:
{ "token": "dc6684370f014923b8a070c982601f75"}
The following is a sample response:
{
"status": "success",
"status_message": "Sideband token dc6684370f014923b8a070c982601f75 imported."
}
Delete a sideband token
URL |
/v5/ase/sideband/token |
Method |
DELETE |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> Content-Type: application/json |
The following is a sample curl command:
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"
}
The following is a sample request:
{ "token": "dc6684370f014923b8a070c982601f75"}
The following is a sample response:
{
"status": "success",
"status_message": "Sideband token dc6684370f014923b8a070c982601f75 deleted."
}
List all sideband tokens
URL |
/v5/ase/sideband/token |
Method |
GET |
Request Headers |
x-ase-access-key: <value> x-ase-secret-key: <value> |
The following is a sample curl command:
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'
The following is a sample response:
{
"sideband_tokens": [
{
"token": "dac559bf75904141ab08903453fec4c0",
"created_at": "2021-May-06 14:02:44"
},
{
"token": "dc6684370f014923b8a070c982601c74",
"created_at": "2021-May-06 13:51:55"
}
]
}