Skip to main content

install_plugin

Enable a plugin for this project — adds it to the project's plugin list, same as the Plugins view's Install button. Idempotent: installing an already-installed plugin succeeds unchanged, and builtin plugins are always on (a no-op).

Request

POST /api/v1/ops/projects/{project}/plugins/{slug}/install
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
slugpathstringyesThe plugin's catalog slug.
curl -X POST -H "Authorization: Bearer $TESTVIBE_API_KEY" \
"$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/plugins/mailslurp-email/install"

Response

200 OK — the plugin document, same shape as a list_plugins entry:

{
"slug": "mailslurp-email",
"name": "MailSlurp Email",
"installed": true,
"requires": [
{ "name": "MAILSLURP_API_KEY", "kind": "secret", "set": false }
]
}

Check requires for values still to configure with set_variable / set_secret.

Errors

HTTPWhen
404 not_foundNo such project, or no such plugin slug in the catalog.