hosting
GET /v1/sites/{siteId}/build-env
The build variable NAMES a site holds — never their values.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/build-env \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
A build variable is routinely an API key, so there is deliberately no endpoint anywhere in this API that reads one back. This returns the names, which is what a customer needs to see what is set and replace or remove it. The values live in Vault, per site. Requires sites.view. A site that has never had variables answers 200 with an empty list — that is not an error. A secret store that cannot be READ answers 503: the two are deliberately distinguishable, because a store we cannot reach reported as "no variables" is a build that silently ships without its keys.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
names | string[] | Yes | The variable names this site holds, sorted. |
applied | boolean | No | Present only on a save to a Node.js, Python or Ruby site on our own servers: true means the running application received the variables and was restarted, false that it is not… |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503