Provides access to a unique userscript by its namespace, name, and version.

Path
/userscripts/{namespace}/{name}/{version}
HTTP Methods
GET
Type
Resource Operation
User Roles
Confluence Administrator, Userscripts Administrator
Since
1.0
Output Data Types
Userscript JSON

This operation provides access to a single userscript by providing the userscript identifier as part of the request URL.

Path Parameters

The web service defines the following path parameters.

Namespace

The namespace of a script makes the name of a userscript unique.

ID
script-namespace
Data Type
Token
Since
1.0

The namespace parameter encodes the namespace of a userscript to configure the macro. It is part of the userscript identifier to uniquely address a userscript instance.

Name

The name of a userscript is unique within its namespace.

ID
name
Data Type
Token
Since
1.0

The name the name of a userscript in the context of the HTTP protocol. It is part of the userscript identifier to uniquely address a userscript instance.

A HTTP name parameter should not contain dots ('.'). Per convention name parts are separated by dashes ('-').

Version

The semantic version of the userscript.

ID
script-version
Data Type
Semantic Version
Since
1.0

The version parameter encodes the version of a userscript to configure the macro. It is part of the userscript identifier to uniquely address a userscript instance.