.jpg)
04. Responce Time Timeout
04. Responce Time & Timeout
API response times
API response times can vary based on several factors, including the type of API, method used, the amount of information returned. The complexity of the request, backend data processing, and network conditions all play a role in determining the time it takes to receive a response.
API Timeout
All APis have a configured timeout with the appropriety responce.
For GET APIs, in case of a timeout, user will have to resend the request
Example Timeout Response for GET APIs: _API operation has Time out. Request has been received but it has timeout before we receive the response. Please try again later. _
For POST APIs, in case of a timeout, the system will continue to process the request and user has to verify if it has been completed.
Example Timeout Response for POST/PATCH APIs: API operation has Time out. Request has been received and is has timeout before we receive the response. Please verify the request has been completed successfully or not. using the appropriate APIs.
Timeout Value
The default value for the timeout is 30seconds. However there are some exceptions where the timeout is higher. For more information see table below.
API Name | Timeout |
|---|---|
Default Value | 30 |
Modify Destination Group | 180 |
Modify Roaming Profile | 180 |
Get Endpoint Profile | 180 |
Create Endpoint | 180 |
Link SIM | 180 |
De-Link SIM | 180 |
Endpoint Activation | 180 |
Endpoint LifeCycle Change | 180 |
Additional usage notes
GET timeout behavior: the client should retry the request.
POST/PATCH timeout behavior: the system may continue processing; the client must verify completion using the appropriate GET API.
Default timeout is 30 seconds.
APIs with extended 180-second timeout include Modify Destination Group, Modify Roaming Profile, Get Endpoint Profile, Create Endpoint, Link SIM, De-Link SIM, Endpoint Activation, and Endpoint LifeCycle Change.
For POST/PATCH APIs, a timeout does not necessarily mean failure.