NAV Navbar
Logo
Switch version:

Introduction

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

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.

Plugin packaging structure

Plugins can be packaged as standalone jar or a combination of multiple plugins in a jar know as plugin bundle. To know more about the packaging jar is explained in the following sections:

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 GoCD 21.3.0

No changes or deprecations.

Changes in GoCD 21.2.0

Deprecations (across extensions)

Changes in GoCD 21.1.0

Deprecations (across extensions)

Changes in GoCD 20.10.0

Deprecations (across extensions)

Changes in GoCD 20.9.0

Deprecations (across extensions)

Changes in GoCD 20.8.0

Config Repo (Changes)

Deprecations (across extensions)

Changes in GoCD 20.7.0

Deprecations (across extensions)

Changes in GoCD 20.6.0

Deprecations (across extensions)

Changes in GoCD 20.5.0

Deprecations (across extensions)

Changes in GoCD 20.4.0

Deprecations (across extensions)

Changes in GoCD 20.3.0

Deprecations (across extensions)

Changes in GoCD 20.02.0

Deprecations (across extensions)

Changes in GoCD 20.01.0

Deprecations (across extensions)

Changes in GoCD 19.12.0

Deprecations (across extensions)

Changes in GoCD 19.11.0

Deprecations (across extensions)

Changes in GoCD 19.10.0

Deprecations (across extensions)

Changes in GoCD 19.9.0

Elastic Agents (Changes)

Deprecations (across extensions)

Changes in GoCD 19.8.0

Deprecations (across extensions)

Changes in GoCD 19.7.0

Deprecations (across extensions)

Changes in GoCD 19.6.0

Secrets (New)

We have introduced v1 of the Secrets extension endpoint to look up for secrets defined outside of GoCD.

Deprecations (across extensions)

No deprecations in this release.

Changes in GoCD 19.5.0

Elastic Agents (Additions)

A new message which can be sent from the plugin to the GoCD server has been added:

Deprecations (across extensions)

No deprecations in this release.

Changes in GoCD 19.4.0

No additions and removals in this release.

Deprecations (across extensions)

Changes in GoCD 19.3.0

Elastic Agents (Additions)

We have released a new version v5 of the Elastic Agents extension. It introduces a new feature of multi cluster support.

The new messages added are:

Elastic Agents (Changes)

Endpoints defined in previous versions of this API have been enhanced, in the new version:

Deprecations (across extensions)

Changes in GoCD 19.2.0

Config repositories (Additions)

Authorization (Additions)

Authorization (Changes)

Deprecations (across extensions)