Page tree
Skip to end of metadata
Go to start of metadata

Description

This function revokes an API token from the WHM account.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/api_token_revoke?api.version=1&token_name-1=subway&token_name-2=job
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/api_token_revoke?api.version=1&token_name-1=subway&token_Name-2=job
 Command Line
whmapi1 api_token_revoke token_name-1=subway token_name-2=job

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{  
   "data":{
   },
   "metadata":{  
      "result":1,
      "version":1,
      "command":"api_token_revoke",
      "reason":"OK"
   }
}
 Output (XML)
<result>
	<metadata>
		<version>1</version>
		<reason>OK</reason>
		<result>1</result>
		<command>api_token_revoke</command>
	</metadata>
	<data/>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
token_namestring

Required

The API token's name.

Notes:

  • To revoke multiple API tokens, increment this parameter's name. For example: token_name-1, token_name-2.
  • We added the ability to revoke multiple tokens in cPanel & WHM version 68.
A valid API token name.subway

Returns

This function only returns metadata.