Skip to navigation
RESTAdminAuthenticationStorefront API TokensPrivate API Token

Revoke all private tokens

Revokes every active private API token that your API account has issued. Only tokens issued by the API account making the request are revoked, and only tokens in this family (matching the path segment); tokens issued by another API account and tokens of other families are unaffected.

Revocation can take up to approximately 60 seconds to fully propagate because revoked identifiers are held in a short-lived cache, so a revoked token may briefly continue to authenticate.

Required Scopes

  • Manage Storefront API Tokens

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Storefront API Customer Impersonation Tokensmanagestore_storefront_api_customer_impersonation
Storefront API Tokensmanagestore_storefront_api

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

All private API tokens issued by this API account have been revoked.