Introduction

Welcome to the GoCD Plugin API! You can use this API to implement GoCD plugins for:

• Analytics
• Artifacts
• Authorization
• Config repositories
• Elastic agents
• Notifications
• Package repositories (old documentation)
• SCMs
• Tasks

Plugins, as the name implies, help in extending the functionality of GoCD. GoCD publishes a list of extension points for which plugins can be provided. An extension point published by the GoCD - defines the interface and the lifecycle that governs the respective plugin. At present only Java based extension points and plugins are supported by GoCD, but the interface is simple enough for anyone to build plugins in other languages using a simple HTTP bridge.

API Changelog

The changelog is maintained starting from version 19.2.0 of GoCD. For changes from previous versions, see the release notes at https://gocd.org/releases.

Changes in 19.2.0

Added

Config repositories

• This version adds support for v2 for Config repositories. v2 of Config repositories adds the following new messages,
  • Parse Content
  • Pipeline Export
  • Plugin Icon
  • Plugin Capabilities

Authorization

• This version adds support for v2 for Authorization Extension. v2 of authorization extension adds the following new messages,
  • Is Valid User
  • Get User Roles

Plugins Capabilities message is enhanced to add a new capablity can_get_user_roles.

Removed

No removals this release.

Deprecations

• The elastic agent plugin extension version 3 has been deprecated. This version will be removed in a release scheduled for Mar 2019. Plugin developers should use version 4 of the elastic agent plugin api to allow adding support for job completion request. The docker, docker swarm, kubernetes and ecs plugins have been migrated to the new versions, and users should upgrade their plugins to the latest version to see these new features.
• The notification plugin extension version 3 has been deprecated. This version will be removed in a release scheduled for Mar 2019. Plugin developers should use version 4 of the notification plugin api.
• The analytics plugin extension version 1 has been deprecated. This version will be removed in a release scheduled for Mar 2019. Plugin developers should use version 2 of the analytics plugin api.
• The Get Server Info processor version 1 has been deprecated. This version will be removed in a release scheduled for April 2019. Plugin developers should use version 2 of the Get Server Info processor.
• The authorization extension v1 has been deprecated. This version will be removed in a release scheduled for September 2019. Plugin developers should upgrade their plugins to the latest version.
• The config repositories extension v1 has been deprecated. This version will be removed in a release scheduled for September 2019. Plugin developers should upgrade their plugins to the latest version.