BootstrAPI is a series of plugins for providing additional REST APIs for Atlassian products with focus on initial and declarative instance configuration (also referred to as "bootstrapping", hence the name). Configuration documents are declarative and idempotent - applying the same document again is safe - which makes the API a natural fit for automated provisioning.
The same configuration models work across all products. A minimal configuration applying the general settings and an SMTP mail server, in a single request via the _all endpoint (the REST root) - YAML is accepted directly, JSON works just as well:
curl -u "$ADMIN_USERNAME:$ADMIN_PASSWORD" -X PUT -H "Content-Type: application/yaml" \
--data-binary @- https://confluence.example.com/rest/bootstrapi/1/ <<EOFsettings: general: title: Example baseUrl: https://confluence.example.commailServer: smtp: from: mail@example.com host: mail.example.com port: 25EOFThe very same document - with the product's own base URL - configures Jira via https://jira.example.com/rest/bootstrapi/1/ and Crowd via https://crowd.example.com/crowd/rest/bootstrapi/1/. Product-specific sub-fields (e.g. Jira's settings.branding.banner or Crowd's trustedProxies) can simply be added to the same document.
Every sub-field present in the request is applied independently: the response echoes the resulting configuration and reports each sub-field's outcome in its status map, keyed by the request's field paths (e.g. settings/general, mailServer/smtp), answering with the highest sub-field status code.
Instead of (or in addition to) calling the REST API, the plugins can apply a configuration automatically during application startup. Place a bootstrapi.yaml file with the same structure as the _all request body into the application's shared home directory (or local home directory) and it is applied as soon as the application has started.
The startup configuration is cluster-safe: only one node applies the file at a time, and the hash of the last successfully applied document is recorded in the database, so restarts and additional replicas skip an unchanged file.
A configuration that cannot be read, parsed or fully applied stops the application, so an instance never comes up with a configuration it could not reach - in a rolling deployment this blocks the rollout instead of hiding the failure. Since only successful applies are recorded, the configuration is retried when the instance is started again.
Download the plugin for your product from the releases and upload it in the product's administration under Manage apps → Upload app. The endpoints require a user with system administrator permissions.
The plugins are built and tested against Confluence 9.x, Jira 10.x and Crowd 6.x (Data Center).
BootstrAPI is an open source project of Deft Devs LLC. The project originated from the ConfAPI project. This fork has been created by ConfAPI's original maintainer.