--- updatedAt: 2026-03-01T18:22:49.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/etp-config/llms.txt --- # Update a custom response Modifies a custom response's features. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Custom responses", "version": "v3" }, "openapi": "3.0.0", "paths": { "/configs/{configId}/honeypots/{honeypotId}": { "put": { "description": "Modifies a custom response's features.", "externalDocs": { "description": "See documentation for this operation in Akamai's Secure Internet Access Enterprise Configuration API", "url": "https://techdocs.akamai.com/etp-config/reference/put-custom-response" }, "operationId": "put-custom-response", "parameters": [ { "description": "Use the `x_etag` value included in the GET response. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "in": "header", "name": "If-Match", "required": true, "schema": { "example": "\"a9dfe78cf93090516bde891d009eaf57\"", "type": "string" }, "x-akamai": { "file-path": "headers/if-match-header.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "updated custom response 2023", "ipv4Addrs": [ "192.0.2.36", "192.0.2.189" ], "ipv6Addrs": [ "2019:D30::88/124", "2021:D32::88/124" ], "name": "custom response prod" }, "schema": { "additionalProperties": false, "description": "Lists the custom response update properties.", "properties": { "aliases": { "description": "Aliases for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "description": { "description": "Describes the custom response.", "minLength": 1, "type": "string" }, "ipv4Addrs": { "description": "Updates the IPv4 addresses for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "ipv6Addrs": { "description": "Updates the IPv6 addresses for the custom response.", "items": { "minLength": 1, "type": "string" }, "minItems": 0, "type": "array" }, "name": { "description": "The custom response name.", "minLength": 1, "type": "string" }, "policies": { "description": "Policies for the custom response.", "items": { "additionalProperties": false, "properties": { "id": { "description": "__Read-only__ A unique identifier for each policy.", "minimum": 1, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the policy.", "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "minItems": 0, "type": "array" } }, "required": [ "name", "description", "ipv4Addrs", "ipv6Addrs" ], "type": "object", "x-akamai": { "file-path": "schemas/honeypot-update.yaml" } } } }, "required": true }, "responses": { "200": { "content": {}, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "object has missing required properties ([\"exitPoints\",\"name\"])", "instance": "233ecac0-074b-4d7f-a352-375636ecf2a9", "status": 400, "title": "Bad Request", "type": "https://problems.omni.akamaiapis.net/http/bad-request" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Validation error.](https://techdocs.akamai.com/etp-config/reference/400)", "x-akamai": { "file-path": "errors/validation-error-400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "code": "missing_token", "incidentId": "29c07d12-6fef-3da7-b49d-0a693b696405", "solution": "request_token", "title": "Token cannot be empty" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the 401 error response from the SIA Config API.", "properties": { "code": { "description": "The problem type.", "minLength": 1, "type": "string" }, "incidentId": { "description": "The unique ID for this incident.", "type": "string" }, "solution": { "description": "A short, human-readable problem solution.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "incidentId", "solution" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-401.yaml" } } } }, "description": "[Authentication error](https://techdocs.akamai.com/etp-config/reference/401). See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/unauthorized-401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "Insufficient permissions. Code-01", "instance": "3e3f11da-e205-409a-be77-24e459f29fa8", "status": 403, "title": "Forbidden", "type": "https://problems.omni.akamaiapis.net/http/forbidden" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Insufficient permissions](https://techdocs.akamai.com/etp-config/reference/403) See [Get started](https://techdocs.akamai.com/etp-config/reference/get-started) for help setting up your API token.", "x-akamai": { "file-path": "errors/insufficient-permissions-403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Code-090209", "instance": "aeb030ed-0645-484d-93e2-77e88566312c", "status": 404, "title": "Not Found", "type": "https://problems.omni.akamaiapis.net/http/not-found" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "title": { "description": "A short, human-readable summary of the problem type.", "minLength": 1, "type": "string" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "title", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Configuration not Found.](https://techdocs.akamai.com/etp-config/reference/404)", "x-akamai": { "file-path": "errors/not-found-404.yaml" } }, "412": { "content": { "application/problem+json": { "example": { "detail": "Cannot modify the Roaming site. Code-090414", "instance": "3a9af914-5050-42d8-9e89-3eb4483b6583", "status": 412, "type": "https://problems.omni.akamaiapis.net/unknown" }, "schema": { "additionalProperties": true, "description": "The problem indicated by the error response from the SIA Config API.", "properties": { "detail": { "description": "A human-readable explanation specific to the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "HTTP problem details. The error response includes this list if there are several problems with a single request, to call out each of them separately.", "items": { "description": "A nested problem object.", "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array" }, "instance": { "description": "The URI for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code generated by the origin server.", "minimum": 0, "type": "integer" }, "type": { "description": "A URI reference that identifies the problem type.", "minLength": 1, "type": "string" } }, "required": [ "type", "detail", "instance", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-412.yaml" } } } }, "description": "[Precondition failed](https://techdocs.akamai.com/etp-config/reference/412). Use the `x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/etp-config/reference/concurrency-control) for details.", "x-akamai": { "file-path": "errors/precondition-failed-412.yaml" } } }, "summary": "Update a custom response", "tags": [ "Custom responses" ] }, "parameters": [ { "description": "A unique identifier for a custom response.", "in": "path", "name": "honeypotId", "required": true, "schema": { "example": 1234, "type": "integer" }, "x-akamai": { "file-path": "parameters/honeypot-id-path.yaml" } }, { "description": "A unique identifier for the configuration.", "in": "path", "name": "configId", "required": true, "schema": { "example": 456, "type": "integer" }, "x-akamai": { "file-path": "parameters/config-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/honeypot.yaml", "path-info": "/configs/{configId}/honeypots/{honeypotId}" } } }, "servers": [ { "url": "https://{hostname}/etp-config/v3" } ], "tags": [ { "description": "A custom response configuration allows you to direct suspicious traffic to a machine in your network where activity is recorded. Information about the user device that made the request is captured to discover the internal IP addresses of infected machines on the corporate network.", "name": "Custom responses" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "06-custom-responses.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Create a custom response](https://techdocs.akamai.com/etp-config/reference/post-custom-response.md) * [List custom responses](https://techdocs.akamai.com/etp-config/reference/get-custom-responses.md) * [Get a custom response](https://techdocs.akamai.com/etp-config/reference/get-custom-response.md) * [Delete a custom response](https://techdocs.akamai.com/etp-config/reference/delete-custom-response.md)