API:Tokens

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.24

For the deprecated action module, see API:Tokens (action) .

Gets tokens required by data-modifying actions. If you request one of these actions without providing a token, the API returns an error code such as notoken. This module does not use a prefix. The csrf (cross-site request forgery) token corresponds to the majority of older tokens, like edit and move, that were retrieved using the API action tokens (deprecated in MediaWiki 1.24).

Parameters

• type: Type of token(s) to request. (Default: csrf)
  • csrf
  • watch
  • patrol
  • rollback
  • userrights
  • login 1.27+
  • createaccount 1.27+

Example

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

Result
{ "batchcomplete": "", "query": { "tokens": { "csrftoken": "70b9d5a379492c0a07da48650d8906915ad5dbad+\\" } } }

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

Result
{ "batchcomplete": "", "query": { "tokens": { "watchtoken": "585239d7acb985eca442a34abbebfbe25ad5dbd1+\\", "patroltoken": "74c5001ef3dd19723547070cab2707945ad5dbd1+\\" } } }

Possible errors

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

<?xml version="1.0"?>
<api batchcomplete="">
  <warnings>
    <tokens xml:space="preserve">Unrecognized value for parameter <var>type</var>: XXX.</tokens>
  </warnings>
  <query>
    <tokens />
  </query>
</api>

Possible errors include:

• Unrecognized value for parameter type: XXX.

See also

• API:Extensions#Edit token