ENentire
Management

Install a project plugin on a project

Changed on

Core checks redirect_uri and state, creates and provisions the installation, and returns redirect_to. An install started in Entire sends neither and gets no redirect_to. A project holds one installation of each plugin, so when it has one already this updates it instead, accepting accepted_permissions. Requires project manage or GitHub org owner.

post/api/v1/plugins/{plugin}/installations

Request

  • Base URL
    https://entire.io (the document declares no server; this is the origin it was published from)
  • URL
    https://entire.io/api/v1/plugins/{plugin}/installations
  • Auth
    none declared

Path parameters

pluginstring required

Request body

project_idstring required
repository_selection'all' | 'selected' required

Every repository in the project, including later ones, or only repository_ids.

repository_idsstring[]

Only with a selected repository_selection, where none selects no repositories.

redirect_uristring
statestring
accepted_permissionsstring[] required

The plugin's permissions as resource:access, exactly as the user was shown them. A list that no longer matches the plugin answers 409 with reason permissions_changed.

Response

Installed

installation_idstring required
redirect_tostring

Present when a redirect_uri was sent. Send the browser there unchanged.

Changes

  • b5f5651bc1a0Revision changes
    • breaking

      added the new required request property

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 7311ac3485c3Revision changes
    • info

      endpoint added