This page describes the config related REST endpoints. Please also take note of the general information on the REST API.
Config Endpoints
Get Version
'GET /config/server/version'
Returns the version of the Gerrit server.
GET /config/server/version HTTP/1.0
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 )]}' "2.7"
List Capabilities
'GET /config/server/capabilities'
Lists the capabilities that are available in the system. There are two kinds of capabilities: core and plugin-owned capabilities.
As result a map of CapabilityInfo entities is returned.
The entries in the map are sorted by capability ID.
GET /config/server/capabilities/ HTTP/1.0
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 )]}' { "accessDatabase": { "kind": "gerritcodereview#capability", "id": "accessDatabase", "name": "Access Database" }, "administrateServer": { "kind": "gerritcodereview#capability", "id": "administrateServer", "name": "Administrate Server" }, "createAccount": { "kind": "gerritcodereview#capability", "id": "createAccount", "name": "Create Account" }, "createGroup": { "kind": "gerritcodereview#capability", "id": "createGroup", "name": "Create Group" }, "createProject": { "kind": "gerritcodereview#capability", "id": "createProject", "name": "Create Project" }, "emailReviewers": { "kind": "gerritcodereview#capability", "id": "emailReviewers", "name": "Email Reviewers" }, "flushCaches": { "kind": "gerritcodereview#capability", "id": "flushCaches", "name": "Flush Caches" }, "killTask": { "kind": "gerritcodereview#capability", "id": "killTask", "name": "Kill Task" }, "priority": { "kind": "gerritcodereview#capability", "id": "priority", "name": "Priority" }, "queryLimit": { "kind": "gerritcodereview#capability", "id": "queryLimit", "name": "Query Limit" }, "runGC": { "kind": "gerritcodereview#capability", "id": "runGC", "name": "Run Garbage Collection" }, "streamEvents": { "kind": "gerritcodereview#capability", "id": "streamEvents", "name": "Stream Events" }, "viewCaches": { "kind": "gerritcodereview#capability", "id": "viewCaches", "name": "View Caches" }, "viewConnections": { "kind": "gerritcodereview#capability", "id": "viewConnections", "name": "View Connections" }, "viewQueue": { "kind": "gerritcodereview#capability", "id": "viewQueue", "name": "View Queue" } }
Get Top Menus
'GET /config/server/top-menus'
Returns the list of additional top menu entries.
GET /config/server/top-menus HTTP/1.0
As response a list of the additional top menu entries as TopMenuEntryInfo entities is returned.
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 )]}' [ { "name": "Top Menu Entry", "items": [ { "url": "http://gerrit.googlecode.com/", "name": "Gerrit", "target": "_blank" } ] } ]
JSON Entities
CapabilityInfo
The CapabilityInfo
entity contains information about a capability.
Field Name | Description |
---|---|
|
|
|
capability ID |
|
capability name |
TopMenuEntryInfo
The TopMenuEntryInfo
entity contains information about a top menu
entry.
Field Name | Description |
---|---|
|
Name of the top menu entry. |
|
List of menu items. |
TopMenuItemInfo
The TopMenuItemInfo
entity contains information about a menu item in
a top menu entry.
Field Name | Description | |
---|---|---|
|
The URL of the menu item link. |
|
|
The name of the menu item. |
|
|
Target attribute of the menu item link. |
|
|
optional |
The |
Part of Gerrit Code Review