Build metadata links
Add administrator-managed links to Environment details using build environment variables as templates.
Build metadata links place deployment-specific destinations on an Environment’s details page. Examples include logs, traces, dashboards, and runbooks. Lifecycle renders each link with that build’s environment-variable context.
Plan a link
Each link has:
| Field | Purpose |
|---|---|
text | User-facing label |
icon | Icon identifier used by the UI |
link | Absolute URL template |
position | Integer used to order links |
Use Mustache placeholders for values available in the build environment:
Lifecycle renders double- and triple-brace placeholders as unescaped URL text. Unknown variables render as empty strings. Test the link with build data.
Metadata links are global and can give deployment context to an external
service. Use only trusted http or https destinations. Do not put secrets
in query strings. Before you publish the link, check the rendered host.
Manage links
Build metadata configuration is an administrator operation. Use these v2 routes:
| Operation | Route |
|---|---|
| List templates | GET /api/v2/config/metadata |
| Create a template | POST /api/v2/config/metadata |
| Update selected fields | PATCH /api/v2/config/metadata/{id} |
| Delete a template | DELETE /api/v2/config/metadata/{id} |
Only an authenticated administrator browser session can use these routes. They do not accept API keys. Use the deployment API reference from an approved administrator session. Do not copy a browser session token into a shell.
A create request accepts only text, icon, link, and optional position.
Lifecycle generates the id:
A patch changes only the supplied fields:
Check the result
- Create or update the link.
- Open an Environment that defines all referenced variables.
- Check the label, icon, and ordering.
- Before you follow the link, examine the rendered destination.
- Test a build that has no optional variable.
The build-specific read route renders configured templates:
See API overview for the supported API version and deployment-local reference.