API:Tokens

This page is part of the MediaWiki API documentation.

Language:	English  • 日本語

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Cross-site requests
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Parsing wikitext and expanding templates
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Mark revisions of watched pages as visited
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
  • Tokens
  • Page language
• Watchlist feed
• Wikidata
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code
• Asserting

MediaWiki version:

1.20

Obtaining 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. Options:

• block
• centralauth
• delete
• deleteglobalaccount
• edit
• email
• import
• move
• options
• patrol
• protect
• setglobalaccountstatus
• unblock
• watch

Examples

Getting an edit token (default behavior)

api.php?action=tokens

Getting several tokens at once

api.php?action=tokens&type=edit|email|patrol|watch

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 'type': test</tokens>
   </warnings>
   <tokens/>
</api>

Possible errors include:

• Unrecognized value for parameter 'type'
• Action 'xxx' is not allowed for the current user

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 do call the api with the "tokens" action; otherwise you get the cryptic "readapidenied" error.

See also

• API:Extensions#Edit_token

Language:	English  • 日本語