Download the deployment artifacts for an event broker service you want to deploy to a Customer-Controlled Container: a gzip-compressed tar archive that contains the Docker Compose file, the environment files that configure the event broker, and an empty certs/ directory for your Transport Layer Security (TLS) server certificate.

Extract the archive on your container host and run docker compose up -d from the directory it creates:

curl -H "Authorization: Bearer $SOLACE_CLOUD_TOKEN" \
"$SOLACE_CLOUD_API_HOST/api/v2/missionControl/eventBrokerServices/{serviceId}/deploymentArtifacts" 

| tar -xz

The artifacts are regenerated on every request and are available regardless of the state of your event broker service, so you can download them again after rebuilding your container host.

Upgrading the event broker: Specify the eventBrokerVersion to render the bundle for the event broker version you want to upgrade to. The Docker Compose file uses that version's event broker image and resource limits. Apply the upgrade with docker compose down && docker compose up -d. Then mark the maintenance activity complete in the console, so that the event broker service records the new event broker version. Only versions the event broker service can upgrade to are accepted.

Caution: The artifacts contain the event broker service's management credentials in plain text. The response is marked no-store, and each download is audited. Treat the extracted files as secrets.

Restricted to tokens with create or update access to the event broker service; read access alone is not enough. Your token must have one of the permissions listed in the Token Permissions and manage rights on this event broker service.

Insights: When your organization uses Insights (advanced monitoring), the artifacts also contain the Insights monitoring credentials of your organization. Your token then also needs the Organization Monitoring Read permission, or the request fails with 403.

Insights Forwarding: When your organization forwards Insights to its own backend, the artifacts also contain the Insights Forwarding credentials. Your token then also needs the Organization Monitoring Read permission, or the request fails with 403.