Sign in

v1

latestOpenAPI 3.1.0Eclipse Public License 2.02026-07-172520131.8 KB
registry-api

Provides metadata of a specific version of an extension

get/api/{namespace}/{extension}/{targetPlatform}/{version}

Path parameters

namespacestring required

Extension namespace

extensionstring required

Extension name

targetPlatform'win32-x64' | 'win32-ia32' | 'win32-arm64' | 'linux-x64' | 'linux-arm64' | 'linux-armhf' | 'alpine-x64' | 'alpine-arm64' | 'darwin-x64' | 'darwin-arm64' | 'web' | 'universal' required

Target platform

versionstring required

Extension version

Response

The extension metadata are returned in JSON format

successstring

Indicates success of the operation (omitted if a more specific result type is returned)

warningstring

Indicates a warning; when this is present, other properties can still be used

errorstring

Indicates an error; when this is present, all other properties should be ignored

namespaceUrlstring required

URL to get metadata of the extension's namespace

reviewsUrlstring required

URL to get the list of reviews of this extension

filesobject

Map of file types (download, manifest, icon, readme, license, changelog) to their respective URLs

namestring required

Name of the extension

namespacestring required

Namespace of the extension

targetPlatform'win32-x64' | 'win32-ia32' | 'win32-arm64' | 'linux-x64' | 'linux-arm64' | 'linux-armhf' | 'alpine-x64' | 'alpine-arm64' | 'darwin-x64' | 'darwin-arm64' | 'web' | 'universal'

Name of the target platform

versionstring required

Selected version, or the latest version if none was specified

preReleaseboolean

Indicates whether this is a pre-release version

verifiedboolean required

The value 'true' means the publishing user is a privileged user or the publishing user is a member of the extension's namespace and the namespace has at least one owner.

unrelatedPublisherboolean required

Deprecated: use 'verified' instead (this property is just the negation of 'verified')

namespaceAccess'public' | 'restricted' required

Access level of the extension's namespace. Deprecated: namespaces are now always restricted

allVersionsobject

Map of available versions to their metadata URLs. Deprecated: only returns the last 100 versions. Use allVersionsUrl instead.

allVersionsUrlstring

URL to get a map of available versions to their metadata URLs.

averageRatingnumber double

Average rating

downloadCountinteger

Number of downloads of the extension package

reviewCountinteger

Number of reviews

versionAliasstring[]

Available version aliases ('latest' or 'pre-release')

timestampstring required

Date and time when this version was published (ISO-8601)

previewboolean

Indicates whether this is a preview extension

displayNamestring

Name to be displayed in user interfaces

namespaceDisplayNamestring required

Namespace name to be displayed in user interfaces

descriptionstring
enginesobject

Map of engine names to the respective version constraints

categoriesstring[]
extensionKindstring[]

A list that indicates where the extension should run in remote configurations. Values are "ui" (run locally), "workspace" (run on remote machine) and "web"

tagsstring[]
licensestring

License identifier

homepagestring

URL of the extension's homepage

repositorystring

URL of the extension's source repository

sponsorLinkstring

URL to sponsor the extension

bugsstring

URL of the extension's bug tracker

markdown'standard' | 'github'

Markdown rendering engine to use in user interfaces

galleryColorstring

CSS color to use as background in user interfaces

galleryTheme'light' | 'dark'

Theme type for user interfaces

localizedLanguagesstring[]

Languages the extension has been translated in

qnastring

URL of the extension's Q&A page

downloadsobject

Map of download links by target platform

urlstring

version metadata URL

deprecatedboolean

Indicates whether the extension is deprecated

downloadableboolean

Whether to show downloads in user interfaces