@PLUGIN@ - /projects/ REST API

This page describes the project related REST endpoints that are added by the @PLUGIN@.

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

Project Endpoints

Delete Project

DELETE /projects/{project-name}

OR

POST /projects/{project-name}/@PLUGIN@~delete

Deletes a project.

Options for the deletion can be specified in the request body as a DeleteOptionsInput entity.

Please note that some proxies prohibit request bodies for DELETE requests. In this case, if you want to specify options, use POST to delete the project.

Caller must be a member of a group that is granted the ‘Delete Project’ capability (provided by this plugin) or be a member of the Administrators group.

Request

  DELETE /projects/MyProject HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "force": true
  }

Response

  HTTP/1.1 204 No Content

JSON Entities

DeleteOptionsInfo

The DeleteOptionsInfo entity contains options for the deletion of a project.

• force (optional): If set the project is deleted even if it has open changes.
• preserve (optional): If set the GIT repository of the project is not removed.

SEE ALSO

• Projects related REST endpoints

GERRIT

Part of Gerrit Code Review