servers/remove_tokens
1 minute read.
Last Modified 2021-02-04 11:38 ESTNamespace | Name | Admin Only | Log Summary | Generates Event | Version Added |
---|---|---|---|---|---|
servers | remove_tokens | yes | no | yes | 1.1 |
Remove special access tokens from server registrations.
NOTE: Administrator access only - all others will get a 403/Forbidden error
- Required:
- “tvid” (string) : System ID where the auth token needs to be removed
- “name” (string or Json Array of strings) : Name(s) of the tokens to remove
- Optional:
- none ({})
ARGUMENTS ONLY: See the basics of API requests for additional formatting information.
{
"tvid" : "server_id_1",
"names" : ["token_1", "token_2"]
}
{
"result" : "success",
"tokens" : {
"token_3" : "XXXXXXXXXXXXX"
}
}
This API call will emit a “servers/list_tokens” event to notify other administrators of the change. See the servers/list_tokens API reference for details.
This API call does not generate a detailed log summary item