--- title: "Update Idempotency Settings" method: PATCH path: "/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/idempotency/" tags: ["ApiProxy"] --- # Update Idempotency Settings `PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/idempotency/` ## Request - Base URL: `http://167.86.118.166:32080` - URL: `http://167.86.118.166:32080/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/idempotency/` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates Idempotency-Key settings for the specified API Proxy ## Path parameters - `projectName` string, required - `apiProxyName` string, required ## Request body - ApiProxyIdempotencySettingsUpdateDTO - `deploy` boolean: If true, deploy the API Proxy after saving changes - `deployTargetEnvironmentNameList` string[]: List of environment names to deploy to (required when deploy=true) - `idempotencySettings` ApiOpsIdempotencySettingsPatchDTO: Partial update body for API Proxy Idempotency-Key settings. Every field is optional; an omitted (or null) field keeps the stored value. - `name` string: Name of the idempotency settings object. Omitted = unchanged. - `description` string: Description of the idempotency settings object. Omitted = unchanged. - `idempotencyActive` boolean: Enables Idempotency-Key handling for this API Proxy. Omitted = unchanged. - `keyType` 'HEADER' | 'CUSTOM': Where the idempotency key is read from (HEADER or VARIABLE). Omitted = unchanged. - `headerName` string: Request header carrying the idempotency key. Omitted = unchanged. - `variableList` Variable[]: Variables that make up the idempotency key when keyType is VARIABLE. Omitted = unchanged; an empty array clears the list. - `id` string - `projectId` string - `projectName` string - `name` string - `description` string - `type` 'HEADER' | 'PARAMETER' | 'BODY' | 'CONTEXT_VALUES' | 'CUSTOM' - `headerName` string - `paramType` 'QUERY' | 'PATH' | 'FORM' - `paramName` string - `paramPath` string - `formName` string - `xpathValue` string - `jsonPathValue` string - `messageContentType` 'XML' | 'JSON' | 'ALL_BODY' - `contextValue` 'REQUEST_REMOTE_ADDRESS' | 'REQUEST_HTTP_METHOD' | 'REQUEST_CONTENT_TYPE' | 'REQUEST_PATH_INFO' | 'REQUEST_CONTEXT_PATH' | 'REQUEST_QUERY_STRING' | 'REQUEST_REMOTE_USER' | 'REQUEST_USERNAME_KEY' | 'REQUEST_REQUESTED_SESSION_ID' | 'REQUEST_REQUEST_URI' | 'REQUEST_CHARACTER_ENCODING' | 'REQUEST_CHARSET' | 'REQUEST_CONTENT_LENGTH' | 'REQUEST_PROTOCOL' | 'REQUEST_SCHEME' | 'REQUEST_SERVER_NAME' | 'REQUEST_SERVER_PORT' | 'REQUEST_REMOTE_HOST' | 'REQUEST_REMOTE_PORT' | 'REQUEST_LOCAL_NAME' | 'REQUEST_LOCAL_ADDR' | 'REQUEST_LOCAL_PORT' | 'REQUEST_XFORWARDED_FOR' | 'REQUEST_ESTIMATED_TOKEN_COUNT' | 'REQUEST_MCP_TOOL_NAME' | 'REQUEST_OAUTH_CLIENT_ID' | 'REQUEST_IS_SOAP_TO_REST' | 'REQUEST_IS_APIPROXY' | 'REQUEST_IS_APIPROXYGROUP' | 'REQUEST_IS_XWWW_FORM_URL_ENCODED' | 'REQUEST_IS_FORM_DATA' | 'REQUEST_IS_BYTE_ARRAY' | 'REQUEST_HAS_ATTACHMENT' | 'REQUEST_GZIP' | 'REQUEST_DEFLATE' | 'REQUEST_BR' | 'REQUEST_ZSTD' | 'REQUEST_IDENTITY' | 'REQUEST_COMPRESS' | 'REQUEST_HTTP_SERVLET' | 'RESPONSE_IS_BYTE_ARRAY' | 'RESPONSE_GZIP' | 'RESPONSE_DEFLATE' | 'RESPONSE_BR' | 'RESPONSE_ZSTD' | 'RESPONSE_IDENTITY' | 'RESPONSE_COMPRESS' | 'RESPONSE_BACKEND_CONTENT_ENCODING' | 'RESPONSE_CHARSET' | 'RESPONSE_STATUS_CODE' | 'RESPONSE_HTTP_SERVLET' | 'ERROR_CATEGORY' | 'ERROR_TYPE' | 'ERROR_PARENT' | 'ERROR_RESULT_TYPE' | 'ERROR_MESSAGE' | 'ERROR_CODE' | 'ERROR_HTTP_CODE' | 'MESSAGE_CORRELATION_ID' | 'MESSAGE_CACHE_HIT' | 'ENVIRONMENT_ID' | 'ENVIRONMENT_NAME' | 'ENVIRONMENT_CERTIFICATE' | 'ENVIRONMENT_PRIVATEKEY' | 'ENVIRONMENT_PUBLICKEY' | 'ENVIRONMENT_SECRETKEY' | 'ENVIRONMENT_KEYSTORE' | 'ENVIRONMENT_JWK' | 'APIPROXYGROUP_ID' | 'APIPROXYGROUP_NAME' | 'APIPROXY_ID' | 'APIPROXY_NAME' | 'APIPROXY_RELATIVE_PATH' | 'APIMETHOD_ID' | 'APIMETHOD_NAME' | 'APIMETHOD_SOAP_ACTION' | 'APIMETHOD_HTTPMETHOD' | 'APIMETHOD_ENDPOINT' | 'APIMETHOD_BACKEND_HTTPMETHOD' | 'APIMETHOD_BACKEND_ENDPOINT' | 'DATETIME_YEAR' | 'DATETIME_MONTH' | 'DATETIME_DAY_OF_WEEK' | 'DATETIME_DAY_OF_MONTH' | 'DATETIME_HOUR' | 'DATETIME_MINUTE' | 'DATETIME_SECOND' | 'DATETIME_EPOCH_MILLIS' | 'DATETIME_FORMATTED_TEXT' | 'DATE_FORMATTED_TEXT' | 'TIME_FORMATTED_TEXT' | 'CREDENTIAL_USERNAME' | 'CREDENTIAL_EMAIL' | 'CREDENTIAL_FULLNAME' | 'CREDENTIAL_SECRETKEY' | 'CREDENTIAL_CERTIFICATE' | 'CREDENTIAL_PUBLICKEY' | 'CREDENTIAL_PRIVATEKEY' | 'CREDENTIAL_KEYSTORE' | 'CREDENTIAL_TRUSTSTORE' | 'CREDENTIAL_JWK_SIGNANDVALIDATION' | 'CREDENTIAL_JWK_ENCRYPTIONANDDECRYPTION' - `zoneId` string - `initWithScript` boolean - `scriptLanguage` 'GROOVY' | 'JAVASCRIPT' - `scriptBody` string - `keyRequired` boolean: Rejects requests that do not carry an idempotency key. Omitted = unchanged. - `missingKeyHttpStatus` integer: HTTP status returned when the key is required but missing. Omitted = unchanged. - `applicableHttpMethods` string[]: HTTP methods the idempotency check applies to. Omitted = unchanged; an empty array clears the list. - `payloadHashEnabled` boolean: Compares the request payload hash of a replayed key. Omitted = unchanged. - `processingTimeoutInSeconds` integer: How long an in-flight request may hold its key, in seconds. Omitted = unchanged. - `retentionInDays` integer: How long completed idempotency records are kept, in days (1-30). Omitted = unchanged. - `cacheStorageType` 'LOCAL' | 'DISTRIBUTED': Where idempotency records are stored (DISTRIBUTED or LOCAL). Omitted = unchanged. - `handlingAction` 'CONTINUE' | 'STOP': What the gateway does when the cache cannot be reached. Omitted = unchanged. - `cacheConnectionTimeoutInSeconds` integer: Connection timeout towards the distributed cache, in seconds. Omitted = unchanged. - `conflictHttpStatus` integer: HTTP status returned while the same key is still being processed. Omitted = unchanged. - `mismatchHttpStatus` integer: HTTP status returned when the key was used with a different payload. Omitted = unchanged. - `replayCompletedResponse` boolean: Replays the stored response of a completed request instead of calling the target. Omitted = unchanged. - `conflictMessage` string: Response body returned on an in-flight key conflict. Omitted = unchanged. - `mismatchMessage` string: Response body returned on a payload mismatch. Omitted = unchanged. - `missingKeyMessage` string: Response body returned when the key is required but missing. Omitted = unchanged. - `errorContentType` string: Content-Type of the three idempotency error bodies. Omitted = unchanged. - `missingKeyBodyEnabled` boolean: Returns a body with the missing-key error instead of an empty response. Omitted = unchanged. - `conflictBodyEnabled` boolean: Returns a body with the conflict error instead of an empty response. Omitted = unchanged. - `mismatchBodyEnabled` boolean: Returns a body with the payload-mismatch error instead of an empty response. Omitted = unchanged. ## Response `200` successful operation! - ApiOpsResponseSuccess - `status` 'SUCCESS' | 'FAILURE' - `resultMessage` string - `resultList` string[] - `resultCount` integer - `deploymentResult` DeploymentResult - `envName` string - `podName` string - `podIp` string - `success` boolean - `detail` string - `responseTime` integer - `detailList` unknown[] - unknown - `firstFromApiResultList` unknown - `unresolvedReferences` string[] - `advisories` ApiOpsAdvisoryDTO[] - `level` string - `key` string - `params` object ## Other responses - `401`: not authorized for this operation! - `500`: internal error! ## Changes - **2026-10-20** `d1a546deccf0`: 3 breaking - request property `idempotencySettings/cacheStorageType` was restricted to a list of enum values - request property `idempotencySettings/handlingAction` was restricted to a list of enum values - request property `idempotencySettings/keyType` was restricted to a list of enum values - …this revision’s changelog is incomplete - **2026-08-11** `9ae232e55479`: 1 info - endpoint added [Operation history](https://skmtc.dev/apinizer/apis/apinizer-management-apis/changes/apiops/projects/:projectName/apiProxies/:apiProxyName/settings/idempotency/patch.md) --- [API](https://skmtc.dev/apinizer/apis/apinizer-management-apis.md) - [All operations](https://skmtc.dev/apinizer/apis/apinizer-management-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/apinizer/apis/apinizer-management-apis/revisions/e083046b24cd?raw)