API:Tokens (action)

From mediawiki.org
Jump to navigation Jump to search
For the current method of obtaining tokens via a meta module, see: API:Tokens.
Since MW 1.24, the action=tokens is deprecated and includes a warning "Please use action=query&meta=tokens instead".

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)

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

Getting several tokens at once

Result
<?xml version="1.0"?>
<api>
  <tokens edittoken="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>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[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]


Module "tokens" not found.