j1.0.6
API Overview
Use the Timeouts API to manage SCAPI timeouts.
You can specify individual timeout values for specific APIs. Note that you can't set timeouts at the API family level.
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
You must include sfcc.timeouts.rw (read-write access) or sfcc.timeouts (read-only access) in the client ID used to generate the token. For a full list of permissions, see the Authorization Scopes Catalog.
For detailed setup instructions, see the Authorization for Admin APIs guide.
Response Details
Timeouts
Admin API requests must respond within 60 seconds. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see Timeouts and Limits.
Error Handling
Error responses follow the RFC 7807 problem detail format. To trace errors, include a correlation-id header in your request — the response returns it as x-correlation-id. For details, see HTTP Status Codes and Errors.
Use Cases
Manage Timeouts
Use the timeouts endpoint to retrieve, set, or delete your configuration for timeouts.
Usage Notes
- Timeout configuration is set globally for the realm, not per site.
- Configure timeouts for an individual API, not an API family.
- Wildcards are not allowed.
- Max timeout value is 120 seconds.
Let us know so we can improve!