Skip to content

Rotate the forwarder secret

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

Replaces the secret the store’s hosted storefront uses to trust requests forwarded to it, and restarts production on the new one. The secret is never returned. Returns a 409 when the store has no hosted production yet. Needs the admin:store scope; a key with only deploy:storefront cannot call it.

Required scopes: admin:store

storeRef
required
string

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

Media typeapplication/json
object
rotated
required

Always true. The new secret is never returned.

number

Example

{
"rotated": true
}

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"
}

The request conflicts with the resource’s current state.

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"
}