This API specification is available for download as an Open API 3.0 YAML file:
Please configure your clients to use this authentication method to submit user name and password.
The permission "View return requests" is required to use the GET endpoints and must be assigned at the requested shop_name organization. The permission "Manage return requests" is required to use the POST endpoints and must be assigned at the requested shop_name organization.
Note
/caches
Returns the statuses for all cache for all server nodes.
200 - OK The request has succeeded.
401 - Unauthorized or Forbidden.
500 - Internal Server Error .
/caches/{cacheName}
Returns the statuses of the given cache name for all server nodes.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | cacheName | string | Required | Name of the cache the action should be processed for. |
200 - OK The request has succeeded.
401 - Unauthorized or Forbidden.
500 - Internal Server Error .
Requests to clear a given cache on all server nodes. The cache clear will be processed asynchronously from all server nodes.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | cacheName | string | Required | Name of the cache the action should be processed for. |
200 - OK The request has succeeded.
401 - Unauthorized or Forbidden
500 - Internal Server Error .
CacheStateDO
objects.CacheStateDO
: Represents the current status of a cache on a server.int64
bakery-cache-config
date-time
server startup
| Possible Values: server startup
requested
BACKEND_0.0.0.0
int32
FieldError
objects.FieldError
CodedException
objects.CodedException