Update a proxy

put

https://{hostname}/config-dns/v2/proxies/{proxyId}

Updates the proxy.

Path Params

proxyId

string

required

The proxy ID you're working with.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Proxy properties.

activationState

enum

The current proxy activation status. Either NEW, PENDING, ACTIVE, LOCKED, DELETED, or ERROR.

Allowed:

activeHealthcheck

object

Active health check settings for the proxy.

authorities

array of strings

The authoritative service IPs controlled by Akamai. Authority updates by customer are ignored.

authorities

contractId

string

required

The contract for this proxy.

createdTime

date-time

An ISO 8601 timestamp showing when the proxy was created.

ecsSetting

boolean

Whether ECS forwarding is enabled for this proxy.

fullIpPassthroughEnabled

boolean

Whether the full client IP is forwarded in ECS options (/32 for IPv4, /128 for IPv6) rather than a truncated prefix. Requires ecsSetting to be true.

healthCheck

object

required

The names or addresses of the master name servers to protect.

string

required

The unique proxy ID.

lastModifiedTime

date-time

An ISO 8601 timestamp showing when the proxy was last modified.

name

string

required

The proxy name.

originNameserverZoneTransferTargets

array of strings

deprecated

Deprecated The names or addresses to perform outbound zone transfers with AUTOMATIC filter_mode. If this field is omitted the originNameservers section is used.

originNameserverZoneTransferTargets

originNameservers

array of objects

required

The names or addresses of the master name servers to protect.

originNameservers*

zoneTransferNameservers

array of objects

The names or addresses to perform outbound zone transfers with filter_mode of AUTOMATIC. If this field is omitted the originNameserverZoneTransferTargets section is used.

zoneTransferNameservers

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successful response.

400Bad Request. The request body is missing required data or contains an invalid field value.

401Unauthorized. Your credentials are missing or invalid.

403Forbidden. You don't have permission to manage this proxy.

404Not Found. The specified proxy doesn't exist or isn't accessible.

409Conflict. The request conflicts with the current state of the proxy.

415Unsupported Media Type. The request's Content-Type header is not supported. Use application/json.

422Unprocessable Entity. The request body contains a semantically invalid field value.