Skip to content

Commit 4b482c8

Browse files
committed
Add doc to access the /meta-data page of a build
1 parent 2ae59cb commit 4b482c8

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

pages/pipelines/build_meta_data.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,15 @@ Assuming that the "release-version" key was set with the value from the Setting
3838
3939
## Using meta-data on the dashboard
4040

41-
Meta-data is not widely exposed in the Buildkite dashboard, but it can be added to most builds URLs to filter down the list of builds shown to only those with certain meta-data.
41+
You can add `meta_data[…]=…` query parameters to most builds URLs to filter down the list of builds shown to only those with certain meta-data.
4242

43-
To list builds in a pipeline which have a "release-version" of "1.1" you could use:
43+
For example, to list builds in a pipeline which have a "release-version" of "1.1" you can use:
4444

45-
https://buildkite.com/my-organization/my-pipeline/builds?meta_data[release-version]=1.1
45+
https://buildkite.com/{my-organization}/{my-pipeline}/builds?meta_data[release-version]=1.1
46+
47+
You can also append `/meta-data` to the URL of a build to access a page that lists all the meta-data associated with that build:
48+
49+
https://buildkite.com/{my-organization}/{my-pipeline}/builds/{build-number}/meta-data
4650

4751
## Using meta-data in the REST API
4852

0 commit comments

Comments
 (0)