API:Tokens (action)

tokens
Gets tokens for data-modifying actions. This module cannot be used as a generator.
Prefix
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.20

For the current method of obtaining tokens via a meta module, see: API:Tokens.

action=tokens was deprecated in MW 1.24 and removed in 1.37. Use action=query&meta=tokens instead. (See API:Tokens .)

Tokens can be obtained using action=tokens. These tokens can then be used in other API requests.

Parameters

• type: the type of token requested.
  • block
  • delete
  • edit
  • email
  • import
  • move
  • options
  • patrol
  • protect
  • rollback
  • unblock
  • watch
    
    The Central Auth extension on MediaWiki servers adds the following tokens:
  • deleteglobalaccount
  • setglobalaccountstatus

Examples

Getting an edit token (default behavior)

api.php?action=tokens [try in ApiSandbox]

Result
<?xml version="1.0"?> <api> <tokens edittoken="6c82e3a4f17f52ff1e2e4a16b64fed10+\" /> </api>

Getting several tokens at once

api.php?action=tokens&type=edit|email|patrol|watch [try in ApiSandbox]

Result
<?xml version="1.0"?> <api> <tokens edittoken="6c82e3a4f17f52ff1e2e4a16b64fed10+\" emailtoken="6c82e3a4f17f52ff1e2e4a16b64fed10+\" patroltoken="0eaa2666f8c6c0779c43acbdf9703c4a+\" watchtoken="22dff2c0b0c1bef9ad34673b81b91f22+\" /> </api>

Possible errors

In addition to the usual errors, other errors may be returned in the following format:

<?xml version="1.0"?>
<api>
   <warnings>
      <tokens>Unrecognized value for parameter <var>type</var>: test.</tokens>
   </warnings>
   <tokens/>
</api>

Possible errors include:

• Unrecognized value for parameter type: value.
• ⧼apiwarn-tokennotallowed⧽

Failing to urlencode the token can result in an invalid token error.

Important Note

You need to send the cookie obtained in the login phase when you call the api with the "tokens" action; otherwise you get the cryptic "readapidenied" error.