API:Filerepoinfo

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

MediaWiki version:

≥ 1.22

Get request that returns meta information about image repositories configured on the wiki.

API documentation

[edit ]

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

meta=filerepoinfo (fri)

(main | query | filerepoinfo)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0-or-later

Return meta information about image repositories configured on the wiki.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filerepoinfo

Specific parameter:

Other general parameters are available.

friprop

Which repository properties to get (properties available may vary on other wikis).

canUpload: Whether files can be uploaded to this repository, e.g. via CORS and shared authentication.
descBaseUrl: (no description)
descriptionCacheExpiry: (no description)
displayname: The human-readable name of the repository wiki.
favicon: Repository wiki's favicon URL, from $wgFavicon .
fetchDescription: Whether file description pages are fetched from this repository when viewing local file description pages.
initialCapital: Whether file names implicitly start with a capital letter.
local: Whether that repository is the local one or not.
name: The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
rootUrl: Root URL path for image paths.
scriptDirUrl: Root URL path for the repository wiki's MediaWiki installation.
thumbUrl: Root URL path for thumbnail paths.
url: Public zone URL path.

Values (separate with | or alternative): canUpload, descBaseUrl, descriptionCacheExpiry, displayname, favicon, fetchDescription, initialCapital, local, name, rootUrl, scriptDirUrl, thumbUrl, url

Example:

Get information about file repositories.: api.php?action=query&meta=filerepoinfo&friprop=name|displayname [open in sandbox]

Example

[edit ]

GET request

[edit ]

Get information about file repositories.

api.php?action=query&meta=filerepoinfo&friprop=url|name|displayname [try in ApiSandbox]

Response

[edit ]

{
"batchcomplete":"",
"query":{
"repos":[
{
"name":"shared",
"displayname":"Commons",
"url":"//upload.wikimedia.org/wikipedia/commons"
},
{
"name":"local",
"displayname":"Wikipedia",
"url":"//upload.wikimedia.org/wikipedia/en"
}
]
}
}

Sample code

[edit ]

Python

[edit ]

#!/usr/bin/python3
"""
 file_repo_info.py
 MediaWiki API Demos
 Demo of `Filerepoinfo` module: Get information about file repositories.
 MIT License
"""
import requests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
PARAMS = {
 "action": "query",
 "meta": "filerepoinfo",
 "format": "json",
 "friprop": "url|name|displayname"
}
R = S.get(url=URL, params=PARAMS)
DATA = R.json()
print(DATA)

PHP

[edit ]

<?php
/*
 file_repo_info.php
 MediaWiki API Demos
 Demo of `Filerepoinfo` module: Get information about file repositories.
 MIT License
*/
$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
 "action" => "query",
 "meta" => "filerepoinfo",
 "format" => "json",
 "friprop" => "url|name|displayname"
];
$url = $endPoint . "?" . http_build_query( $params );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );
echo( $output );

JavaScript

[edit ]

/*
	file_repo_info.js
 MediaWiki API Demos
 Demo of `Filerepoinfo` module: Get information about file repositories.
 MIT License
*/
varurl="https://en.wikipedia.org/w/api.php";
varparams={
action:"query",
meta:"filerepoinfo",
format:"json",
friprop:"url|name|displayname"
};
request.get({url:url,qs:params},function(error,res,body){
if(error){
return;
}
console.log(body);
});

MediaWiki JS

[edit ]

/*
	file_repo_info.js
 MediaWiki API Demos
 Demo of `Filerepoinfo` module: Get information about file repositories.
 MIT License
*/
varparams={
action:"query",
meta:"filerepoinfo",
format:"json",
friprop:"url|name|displayname"
},
api=newmw.Api();
api.get(params).done(function(data){
console.log(data);
});

Additional notes

[edit ]

apiurl parameter is missing in MediaWiki 1.25.

API documentation

meta=filerepoinfo (fri)

Example

GET request

Response

Sample code

Python

PHP

JavaScript

MediaWiki JS

Additional notes

See also