@PLUGIN@ - /config/ REST API

This page describes the ‘/config/’ REST endpoint that is added by the @PLUGIN@ plugin.

Please also take note of the general information on the REST API.

@PLUGIN@ Endpoints

Get Config

GET /projects/ProjectName/@PLUGIN@~config

Gets per project configuration of the @PLUGIN@ plugin.

Request

  GET /projects/foo/@PLUGIN@~config HTTP/1.0

As response a ConfigInfo entity is returned that contains the configuration of the @PLUGIN@ plugin.

Response

  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json;charset=UTF-8

  )]}'
  {
    "enabled": true
  }

ProjectName

The name of the project.

If the name ends with .git, the suffix will be automatically removed.

ConfigInfo

The ConfigInfo entity contains the configuration of the @PLUGIN@ plugin.

Field NameDescription
enabledWhether the project is enabled for Zuul CI integration

SEE ALSO

GERRIT

Part of Gerrit Code Review