User:Zaycodes/Sandbox/API:Managetags/en

From mediawiki.org

POST request to create a tag with a reason.

MediaWiki version:
1.25

API documentation[edit]


action=managetags

(main | managetags)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Perform management tasks relating to change tags.

Specific parameters:
Other general parameters are available.
operation

Which operation to perform:

create
Create a new change tag for manual use.
delete
Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.
activate
Activate a change tag, allowing users to apply it manually.
deactivate
Deactivate a change tag, preventing users from applying it manually.
This parameter is required.
One of the following values: activate, create, deactivate, delete
tag

Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.

This parameter is required.
reason

An optional reason for creating, deleting, activating or deactivating the tag.

Default: (empty)
ignorewarnings

Whether to ignore any warnings that are issued during the operation.

Type: boolean (details)
tags

Change tags to apply to the entry in the tag management log.

Values (separate with | or alternative): convenient-discussions, possible vandalism, repeating characters
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

Example[edit]

Making any POST request is a multi-step process:

  1. Log in, via one of the methods described on API:Login .
  2. GET an edit/CSRF token as shown here API:Tokens
  3. Send a POST request, with the CSRF token, to create a tag.

The sample codes below cover these steps.

POST request[edit]

Create a tag named spam with the reason For use in edit patrolling


Response[edit]

{
    "batchcomplete":""
}

Sample code[edit]

User:Zaycodes/Sandbox/API:Managetags/Sample code 1

Possible errors[edit]

Code Info
permissiondenied You do not have permission to manage change tags

See also[edit]

  • API:Tags - To add or remove tags from individual revisions or log entries.