PUT /apis/versions/{ApiVersionID}/implementations/{ImplCode}/timeout

Updates information about the client timeout value (in milliseconds) configured for the target service endpoint of the specified API version and implementation.

The client timeout API is not supported for the Orchestration pattern. This parameter applies only to the Proxy or Physical Service implementation patterns.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/apis/versions/{ApiVersionID}/implementations/{ImplCode}/timeout

Sample Request

The example below shows a request to modify the client timeout value for a specific API implementation.

Sample Request URL

https://{hostname}/apis/versions/5b388122-416b-4f06-95d4-0919636177f6.acmepaymentscorp/implementations/Sandbox/timout

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
   "ClientTimeout": 33
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json
Content-Type	application/json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
APIVersionID	Path	String	Required	The unique ID for a specific API version.
ImplCode	Path	String	Required	A code for a specific implementation. Valid values: Live or Sandbox.
APITimeout	Body	APITimeout	Required	Contains information about the client timeout for a specific API version.

Response

If successful, this operation returns HTTP status code 200, with the updated client timeout information.

Sample Response

Sample response headers

Status Code: 200 OK
Date: Mon, 2 Feb 2026 22:54:09 GMT
Content-Type: application/json

Sample response body

{
   "ClientTimeout": 33
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
APITimeout	APITimeout	Contains information about the client timeout for a specific API version.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if you have a typo in the URL or incorrect parameter value in the URL.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics