Extensions

An extension is a way to give pipelines more functionality. This might include automatically running your pipeline or printing the results of a run to Slack or more. Pipelines can subscribe to one or more extensions (usually with some individual configuration) and those extensions perform actions on behalf of the pipeline.

List all extensions currently registered

Responses

Compare Gofer's config with the extensions currently running

Rereads Gofer's config file and reports, for each extension, what applying the config would change. Nothing is changed. This backs gofer extension reload. This route is only accessible for admin tokens.

Responses

Returns details about a specific extension

Path parameters

Responses

Permanently delete an extension along with its pipeline subscriptions and stored objects

Only extensions that have already been removed from Gofer's config can be purged; Gofer would just install a configured one again. This route is only accessible for admin tokens.

Path parameters

Responses

Bring one extension in line with Gofer's config

Rereads Gofer's config file and installs, updates, starts, or stops the extension to match. The request carries the plan_hash from the plan the operator reviewed; if anything changed since then (the config, the manifest, or a secret) the request is refused so the operator can look at a fresh plan. This route is only accessible for admin tokens.

Path parameters

Request body (required): ApplyExtensionRequest

Responses

Dump extension debug information

Path parameters

Responses

Retrieves logs from the extension container

This endpoint upgrades the connection to a websocket: after the 101 response the server streams data over the socket instead of returning a body.

Path parameters

Responses

Go back to the version of an extension that was running before the last apply

Meant for when a new version won't start. The extension stays different from Gofer's config until the config is fixed, so it'll show up in the next plan again. This route is only accessible for admin tokens.

Path parameters

Responses

List an extension's subscriptions

Leaves out disabled subscriptions unless include_disabled is set.

Path parameters

Query parameters

Responses