Skip to content

List environment variables

GET
/stores/{storeRef}/hosting/env
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/hosting/env \
--header 'x-api-key: <x-api-key>'

Returns the names, targets and last update times of the store’s environment variables, sorted by name. Values are write-only and are never returned by any route. Needs the admin:store scope.

Required scopes: admin:store

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
Array<object>
object
target
required

runtime: read by the running storefront. build: read while it is built.

string
Allowed values: runtime build
updated_at
required

When the variable was last set, as an ISO 8601 timestamp.

string format: date-time
name
required

The variable’s name.

string

Example

[
{
"target": "runtime"
}
]

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}