API:Tokens (action)

Languages:

This page is part of the MediaWiki Action API documentation.

MediaWiki Action API
Basics
Etiquette and usage guidelines All query modules All page properties All list modules All meta modules Output formats
Authentication
Get tokens for data modifying operations Login Logout Verifying authentication (assertions)
Accounts and Users
Create an account Block or unblock a user Get info about the current user Get the current user's watchlist as a feed Change user options Change user group membership Send an email
Page Operations
Create and edit a page Get the contents of a page Upload a file Import a page Delete a page Parse content of a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More...
Search
Search wiki pages by title (OpenSearch) Advanced search for wiki pages by title or text Search wiki pages near a location Search for a language name Perform a prefix search for page titles
Developer Utilities
Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation Strategy
Tutorials
Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer Holidays viewer
v · d · e

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

[edit ]

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

[edit ]

Getting an edit token (default behavior)

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

Result
<?xml version="1.0"?> <api> <tokensedittoken="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>
<tokensedittoken="6c82e3a4f17f52ff1e2e4a16b64fed10+\"emailtoken="6c82e3a4f17f52ff1e2e4a16b64fed10+\"patroltoken="0eaa2666f8c6c0779c43acbdf9703c4a+\"watchtoken="22dff2c0b0c1bef9ad34673b81b91f22+\"/>
</api>

Possible errors

[edit ]

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

<?xml version="1.0"?>
<api>
<warnings>
<tokens>Unrecognizedvalueforparameter<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

[edit ]

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.

API documentation

[edit ]

The following documentation is the output of Special:ApiHelp/tokens, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

Module "tokens" not found.

Retrieved from "https://www.mediawiki.org/w/index.php?title=API:Tokens_(action)&oldid=8318328"