API:Checktoken

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e

Checks the validity of a token from the tokens module.

Parameters[edit]

  • type: Type of token being tested. Possible values: csrf, patrol, rollback, userrights, watch. On Mediawiki servers, CentralAuth also adds deleteglobalaccount and setglobalaccountstatus..
  • token: Token to test.
  • maxtokenage: Maximum allowed age of the token, in seconds.

Example[edit]

Check a CSRF token.




action=checktoken

(main | checktoken)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Check the validity of a token from action=query&meta=tokens.

Parameters:
type

Type of token being tested.

This parameter is required.
One of the following values: createaccount, csrf, deleteglobalaccount, login, patrol, rollback, setglobalaccountstatus, userrights, watch
token

Token to test.

This parameter is required.
maxtokenage

Maximum allowed age of the token, in seconds.

Type: integer
Example:
Test the validity of a csrf token.
api.php?action=checktoken&type=csrf&token=123ABC [open in sandbox]