{ "components": { "headers": { "location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } }, "parameters": { "activation-states-query": { "description": "Limits the list to zones in the specified activation states. Specify any combination of `ACTIVE`, `NEW`, `PENDING`, `LOCKED`, and `ERROR` values.", "explode": false, "in": "query", "name": "activationStates", "schema": { "example": [ "ACTIVE", "PENDING" ], "items": { "enum": [ "ACTIVE", "NEW", "PENDING", "LOCKED", "ERROR" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/activation-states-query.yaml" } }, "contract-id-query": { "description": "The contract to use for the new zone.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-query.yaml" } }, "contract-ids-zones-query": { "description": "Limits the list to those zones belonging to the specified contracts.", "in": "query", "name": "contractIds", "schema": { "example": "C-0N7RAC7,K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-ids-zones-query.yaml" } }, "dns-sec-status-query": { "description": "Limits the list to zones with the specified DNSSEC status. Specify any combination of `valid`, `warning`, and `error` values.", "explode": false, "in": "query", "name": "dnsSecStatus", "schema": { "example": [ "valid", "warning" ], "items": { "enum": [ "valid", "warning", "error" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/dns-sec-status-query.yaml" } }, "group-aware-gid": { "description": "The currently selected group ID to manage. ", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.yaml" } }, "pageable-page": { "description": "Which page of results to return. The first page is page `1`, the default value.", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, "pageable-page-size": { "description": "The number of results per page to return, `25` by default.", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, "pageable-show-all": { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.yaml" } }, "search-zones-query": { "description": "Limits the list to those zones whose name matches the specified search string.", "in": "query", "name": "search", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/search-zones-query.yaml" } }, "skip-sign-and-serve-safety-check-query": { "description": "If set to true, skips safety checks when disabling sign and serve.", "in": "query", "name": "skipSignAndServeSafetyCheck", "required": false, "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/skip-sign-and-serve-safety-check-query.yaml" } }, "sort-by-zones-query": { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Sorting is ignored if used with `showAll` parameter. Valid sort keys include `zone`, `contractId`, `comment`, `endCustomerId`, `lastModifiedDate`, and `lastActivatedDate`.", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "-contractId", "zone" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-zones-query.yaml" } }, "subzone-grant-query": { "description": "If included, limits the Edge DNS zones where `subzoneGrants` matches the specified boolean. Refer to [Subzone grants](https://techdocs.akamai.com/edge-dns/reference/subzone-grants) for more information.", "in": "query", "name": "subzoneGrants", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/subzone-grant-query.yaml" } }, "transfer-status-query": { "description": "Limits the list to zones matching the specified zone transfer status. Specify any combination of `success`, `warning`, `failure`, and `pending` values.", "explode": false, "in": "query", "name": "transferStatus", "schema": { "example": [ "success", "pending" ], "items": { "enum": [ "success", "warning", "failure", "pending" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/transfer-status-query.yaml" } }, "types-zones-query": { "description": "Limits the list to one or more Edge DNS zone types. Specify any combination of `PRIMARY`, `SECONDARY`, and `ALIAS` values.", "explode": false, "in": "query", "name": "types", "schema": { "example": [ "PRIMARY", "ALIAS" ], "items": { "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/types-zones-query.yaml" } }, "zone-path": { "description": "The name of the zone.", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } }, "schemas": { "bulk-secondary-zone-edit-request": { "additionalProperties": false, "properties": { "settings": { "additionalProperties": false, "description": "Secondary zone settings to apply to all listed zones.", "properties": { "comment": { "description": "Free-form comment about the change.", "type": "string" }, "masters": { "description": "List of primary name server IP addresses for zone transfer.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "zones": { "description": "List of secondary zones to edit, each identified by name and current version ID.", "items": { "additionalProperties": false, "properties": { "versionId": { "description": "The current `ETag` version identifier for the zone.", "type": "string" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone", "versionId" ], "type": "object" }, "type": "array" } }, "required": [ "zones", "settings" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-secondary-zone-edit-request.yaml" } }, "bulk-secondary-zone-edit-response": { "additionalProperties": false, "properties": { "zones": { "description": "List of zones successfully updated, each with its new version ID.", "items": { "additionalProperties": false, "properties": { "versionId": { "description": "The new `ETag` version identifier for the zone after the update.", "type": "string" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone", "versionId" ], "type": "object" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-secondary-zone-edit-response.yaml" } }, "contract-get": { "additionalProperties": false, "description": "A customer contract and associated permissions.", "properties": { "contractId": { "description": "The ID of the contract.", "type": "string" }, "contractName": { "description": "The name of the customer for this contract.", "type": "string" }, "contractTypeName": { "description": "An internal description of the contract type.", "type": "string" }, "features": { "description": "Edge DNS features that you have access to. Possible values are: `ALIAS_ZONES`, `DNSSEC_SELF_SIGN`, `DNSSEC_SIGN_AND_SERVE`, `FORCE_DELETE`, `PRIMARY_ZONES`, `SECONDARY_ZONES`, `SUBZONE_GRANTS` `TLD_ZONES`, or `ZONE_APEX_MAPPING`.", "items": { "enum": [ "ALIAS_ZONES", "DNSSEC_SELF_SIGN", "DNSSEC_SIGN_AND_SERVE", "FORCE_DELETE", "PRIMARY_ZONES", "SECONDARY_ZONES", "ZONE_APEX_MAPPING", "TLD_ZONES", "SUBZONE_GRANTS" ], "type": "string" }, "type": "array" }, "maximumZones": { "description": "The maximum number of zones you're able to create on this contract.", "type": "integer" }, "permissions": { "description": "The Edge DNS permissions that you have on this contract. Possible values are: `READ`, `WRITE`, `ADD`, and `DELETE`.", "items": { "enum": [ "READ", "WRITE", "ADD", "DELETE" ], "type": "string" }, "type": "array" }, "zoneCount": { "description": "The number of zones that currently exist on this contract.", "type": "integer" } }, "required": [ "contractId", "contractName", "contractTypeName", "features", "maximumZones", "permissions", "zoneCount" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-get.yaml" } }, "dns-sec-records": { "additionalProperties": false, "description": "Information about DNSSEC records auto-generated for an Edge DNS zone with Sign&Serve.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "dns-sec-status": { "additionalProperties": false, "description": "The status of the DNSSEC configuration for an Edge DNS zone.", "properties": { "alerts": { "description": "A set of existing problems with the current DNSSEC configuration, any of these values: `INCOMPATIBLE_AUTHORITIES`, `NON_AKAMAI_AUTHORITIES`, `PARENT_DS_MISSING`, `OLD_DNSKEY`, and `WRONG_DNSKEY`.", "items": { "enum": [ "INCOMPATIBLE_AUTHORITIES", "NON_AKAMAI_AUTHORITIES", "PARENT_DS_MISSING", "OLD_DNSKEY", "WRONG_DNSKEY" ], "type": "string" }, "type": "array" }, "currentRecords": { "additionalProperties": false, "description": "The currently active set of generated DNSSEC records.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "newRecords": { "additionalProperties": false, "description": "The newly generated set of DNSSEC records, if one exists.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "alerts", "currentRecords" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-status.yaml" } }, "dns-sec-status-list": { "additionalProperties": false, "description": "Statuses of DNSSEC configurations for Edge DNS zones.", "properties": { "dnsSecStatuses": { "description": "Statuses of the DNSSEC configuration for Edge DNS zones.", "items": { "additionalProperties": false, "description": "The status of the DNSSEC configuration for an Edge DNS zone.", "properties": { "alerts": { "description": "A set of existing problems with the current DNSSEC configuration, any of these values: `INCOMPATIBLE_AUTHORITIES`, `NON_AKAMAI_AUTHORITIES`, `PARENT_DS_MISSING`, `OLD_DNSKEY`, and `WRONG_DNSKEY`.", "items": { "enum": [ "INCOMPATIBLE_AUTHORITIES", "NON_AKAMAI_AUTHORITIES", "PARENT_DS_MISSING", "OLD_DNSKEY", "WRONG_DNSKEY" ], "type": "string" }, "type": "array" }, "currentRecords": { "additionalProperties": false, "description": "The currently active set of generated DNSSEC records.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "newRecords": { "additionalProperties": false, "description": "The newly generated set of DNSSEC records, if one exists.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "alerts", "currentRecords" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-status.yaml" } }, "type": "array" } }, "required": [ "dnsSecStatuses" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-status-list.yaml" } }, "ds-record-key-tag-response": { "additionalProperties": false, "properties": { "matchingKeyTags": { "description": "List of key tag values from DS records that match the zone's current DNSKEY records.", "items": { "type": "integer" }, "type": "array" } }, "required": [ "matchingKeyTags" ], "type": "object", "x-akamai": { "file-path": "schemas/ds-record-key-tag-response.yaml" } }, "get-zones-response": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "zones": { "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "items": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } }, "type": "array" } }, "required": [ "metadata", "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-response.yaml" } }, "get-zones-zone-aliases-response": { "additionalProperties": false, "description": "Zone names that alias to this zone.", "properties": { "aliases": { "description": "Zone names.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "aliases" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-zone-aliases-response.yaml" } }, "multi-provider-dnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outbound-zone-transfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "post-zones-zone-transfer-status-response": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "zones": { "description": "Statuses of any recent zone transfer attempts for Edge DNS secondary zones.", "items": { "additionalProperties": false, "description": "The status of any recent zone transfer attempts for an Edge DNS secondary zone.", "properties": { "masters": { "description": "Customer name servers that were contacted.", "items": { "additionalProperties": false, "description": "Customer name servers that were contacted.", "properties": { "masterIP": { "description": "__Read-only__ The IP address of the customer name server.", "readOnly": true, "type": "string" }, "zoneTransferAgents": { "description": "__Read-only__ Akamai zone transfer agents that performed zone transfers.", "items": { "additionalProperties": false, "description": "Akamai zone transfer agents that performed zone transfers.", "properties": { "actions": { "description": "__Read-only__ The zone transfer requests performed by the agent.", "items": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "readOnly": true, "type": "array" }, "agentIP": { "description": "__Read-only__ The IP address of the Akamai zone transfer agent.", "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last time a zone transfer failed for this agent.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "agentIP", "actions" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-agent.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "masterIP", "zoneTransferAgents" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-master.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Information about the most recent successful and failed zone transfer attempt.", "properties": { "lastFailureTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent failed zone transfer occurred.", "format": "date-time", "type": "string" }, "lastSuccessSerial": { "description": "The SOA serial number that was read during the most recent successful zone transfer.", "type": "integer" }, "lastSuccessTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent successful zone transfer occurred.", "format": "date-time", "type": "string" } }, "type": "object" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "metadata", "masters" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-status.yaml" } }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/post-zones-zone-transfer-status-response.yaml" } }, "propagation-status-response": { "additionalProperties": false, "properties": { "propagationStatuses": { "description": "Propagation status for each requested zone.", "items": { "additionalProperties": false, "properties": { "percentCurrent": { "description": "Percentage of name servers that have the current zone data.", "type": "integer" }, "percentInProgress": { "description": "Percentage of name servers currently receiving zone data.", "type": "integer" }, "percentNotReported": { "description": "Percentage of name servers that have not yet reported their status.", "type": "integer" }, "serial": { "description": "The current SOA serial number for the zone.", "format": "int64", "type": "integer" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone" ], "type": "object" }, "type": "array" } }, "required": [ "propagationStatuses" ], "type": "object", "x-akamai": { "file-path": "schemas/propagation-status-response.yaml" } }, "put-zones-zone-request": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "__Read-only__ Used for primary and secondary zones only. An ISO 8601 timestamp showing when the latest version was activated.", "format": "date-time", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The user that last edited this zone.", "readOnly": true, "type": "string" }, "lastModifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the zone's last modification.", "format": "date-time", "readOnly": true, "type": "string" }, "masters": { "description": "For secondary zones only. The names or addresses of the customer's name servers from which the zone data should be retrieved.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "__Read-only__ The UUID of the most recently activated version.", "readOnly": true, "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "type", "signAndServe" ], "type": "object", "x-akamai": { "file-path": "schemas/put-zones-zone-request.yaml" } }, "recordset": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } }, "tsigkey-get": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "zone-get": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } }, "zone-name-list": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } }, "zone-post": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "PRIMARY and SECONDARY zones only. An ISO 8601 timestamp showing when the latest version was activated.", "format": "date-time", "type": "string" }, "lastModifiedBy": { "description": "The user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "ISO 8601 timestamp marking when zone's last modification.", "format": "date-time", "type": "string" }, "masters": { "description": "For `SECONDARY` zones only. The names or addresses of the customer's name servers that the zone data should be retrieved from.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "For `PRIMARY` and `SECONDARY` zones only. Indicates whether DNSSEC Sign&Serve enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The UUID of the most recently activated version.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-post.yaml" } }, "zone-transfer-action": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "zone-transfer-agent": { "additionalProperties": false, "description": "Akamai zone transfer agents that performed zone transfers.", "properties": { "actions": { "description": "__Read-only__ The zone transfer requests performed by the agent.", "items": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "readOnly": true, "type": "array" }, "agentIP": { "description": "__Read-only__ The IP address of the Akamai zone transfer agent.", "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last time a zone transfer failed for this agent.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "agentIP", "actions" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-agent.yaml" } }, "zone-transfer-master": { "additionalProperties": false, "description": "Customer name servers that were contacted.", "properties": { "masterIP": { "description": "__Read-only__ The IP address of the customer name server.", "readOnly": true, "type": "string" }, "zoneTransferAgents": { "description": "__Read-only__ Akamai zone transfer agents that performed zone transfers.", "items": { "additionalProperties": false, "description": "Akamai zone transfer agents that performed zone transfers.", "properties": { "actions": { "description": "__Read-only__ The zone transfer requests performed by the agent.", "items": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "readOnly": true, "type": "array" }, "agentIP": { "description": "__Read-only__ The IP address of the Akamai zone transfer agent.", "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last time a zone transfer failed for this agent.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "agentIP", "actions" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-agent.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "masterIP", "zoneTransferAgents" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-master.yaml" } }, "zone-transfer-status": { "additionalProperties": false, "description": "The status of any recent zone transfer attempts for an Edge DNS secondary zone.", "properties": { "masters": { "description": "Customer name servers that were contacted.", "items": { "additionalProperties": false, "description": "Customer name servers that were contacted.", "properties": { "masterIP": { "description": "__Read-only__ The IP address of the customer name server.", "readOnly": true, "type": "string" }, "zoneTransferAgents": { "description": "__Read-only__ Akamai zone transfer agents that performed zone transfers.", "items": { "additionalProperties": false, "description": "Akamai zone transfer agents that performed zone transfers.", "properties": { "actions": { "description": "__Read-only__ The zone transfer requests performed by the agent.", "items": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "readOnly": true, "type": "array" }, "agentIP": { "description": "__Read-only__ The IP address of the Akamai zone transfer agent.", "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last time a zone transfer failed for this agent.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "agentIP", "actions" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-agent.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "masterIP", "zoneTransferAgents" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-master.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Information about the most recent successful and failed zone transfer attempt.", "properties": { "lastFailureTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent failed zone transfer occurred.", "format": "date-time", "type": "string" }, "lastSuccessSerial": { "description": "The SOA serial number that was read during the most recent successful zone transfer.", "type": "integer" }, "lastSuccessTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent successful zone transfer occurred.", "format": "date-time", "type": "string" } }, "type": "object" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "metadata", "masters" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-status.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference" }, "info": { "description": "Replace or augment your DNS infrastructure with a cloud-based\nauthoritative DNS solution.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Edge DNS API", "version": "v2" }, "openapi": "3.0.0", "paths": { "/changelists": { "post": { "description": "Creates a new change list based on the most recent version of a zone. No POST body is needed, since the object is read-only.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-changelists" }, "operationId": "post-changelists", "parameters": [ { "description": "The name of an Edge DNS zone.", "example": "{{zone}}", "in": "query", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-query.yaml" } }, { "description": "__Enum__ You can't create a change list if you've already created one for this zone. The default `none` raises an error if a change list exists. Use `any` to delete any existing change lists before running the create operation. Use `stale` to automatically delete stale change lists before running the create operation. The `stale` option raises an error if there's a change list attached to the current version.", "example": "{{overwrite}}", "in": "query", "name": "overwrite", "schema": { "default": "none", "enum": [ "any", "stale", "none" ], "example": "none", "type": "string" }, "x-akamai": { "file-path": "parameters/overwrite-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "example": { "changeTag": "476754f4-d605-479f-853b-db854d7254fa", "lastModifiedDate": "2021-02-01T12:00:12.524Z", "stale": false, "zone": "example.com", "zoneVersionId": "1d9c887c-49bb-4382-87a6-d1bf690aa58f" }, "schema": { "additionalProperties": false, "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "properties": { "changeTag": { "description": "An ETag for this change list.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 date indicating the last time the change list was modified.", "type": "string" }, "stale": { "description": "If the parent version isn't current, this change list is stale.", "type": "boolean" }, "zone": { "description": "The name of the zone.", "type": "string" }, "zoneVersionId": { "description": "The zone version identifier for the parent version of this change list.", "type": "string" } }, "required": [ "zone", "changeTag", "zoneVersionId", "stale", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-get.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Create a change list", "tags": [ "Change lists" ] }, "get": { "description": "Retrieves the change lists that you created. Otherwise, displays both stale change lists and change lists for zones you can no longer access.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists" }, "operationId": "get-changelists", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "changeLists": [ { "changeTag": "476754f4-d605-479f-853b-db854d7254fa", "lastModifiedDate": "2021-02-01T12:00:12.524Z", "stale": false, "zone": "example.com", "zoneVersionId": "1d9c887c-49bb-4382-87a6-d1bf690aa58f" }, { "changeTag": "17bfec8f-2b95-4aec-9959-518998b8b3c6", "lastModifiedDate": "2021-04-21T19:04:00Z", "stale": true, "zone": "example.net", "zoneVersionId": "82ffbdd6-d328-4b8a-aa7c-bc9319c51bf3" } ] }, "schema": { "additionalProperties": false, "properties": { "changeLists": { "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "items": { "additionalProperties": false, "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "properties": { "changeTag": { "description": "An ETag for this change list.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 date indicating the last time the change list was modified.", "type": "string" }, "stale": { "description": "If the parent version isn't current, this change list is stale.", "type": "boolean" }, "zone": { "description": "The name of the zone.", "type": "string" }, "zoneVersionId": { "description": "The zone version identifier for the parent version of this change list.", "type": "string" } }, "required": [ "zone", "changeTag", "zoneVersionId", "stale", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-get.yaml" } }, "type": "array" } }, "required": [ "changeLists" ], "type": "object", "x-akamai": { "file-path": "schemas/get-changelists-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List user's change lists", "tags": [ "Change lists" ] }, "x-akamai": { "file-path": "paths/change-lists.yaml", "path-info": "/changelists" } }, "/changelists/search": { "post": { "description": "Retrieves the change lists that you've created for the specified zone names. If the input list is empty, the response doesn't return any change lists. Note that it's possible to own a change list on a zone that you're no longer allowed to access.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-changelists-search" }, "operationId": "post-changelists-search", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "changeLists": [ { "changeTag": "476754f4-d605-479f-853b-db854d7254fa", "lastModifiedDate": "2021-02-01T12:00:12.524Z", "stale": false, "zone": "example.com", "zoneVersionId": "1d9c887c-49bb-4382-87a6-d1bf690aa58f" }, { "changeTag": "17bfec8f-2b95-4aec-9959-518998b8b3c6", "lastModifiedDate": "2021-04-21T19:04:00Z", "stale": true, "zone": "example.net", "zoneVersionId": "82ffbdd6-d328-4b8a-aa7c-bc9319c51bf3" } ] }, "schema": { "additionalProperties": false, "properties": { "changeLists": { "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "items": { "additionalProperties": false, "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "properties": { "changeTag": { "description": "An ETag for this change list.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 date indicating the last time the change list was modified.", "type": "string" }, "stale": { "description": "If the parent version isn't current, this change list is stale.", "type": "boolean" }, "zone": { "description": "The name of the zone.", "type": "string" }, "zoneVersionId": { "description": "The zone version identifier for the parent version of this change list.", "type": "string" } }, "required": [ "zone", "changeTag", "zoneVersionId", "stale", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-get.yaml" } }, "type": "array" } }, "required": [ "changeLists" ], "type": "object", "x-akamai": { "file-path": "schemas/get-changelists-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Search for change lists", "tags": [ "Change lists" ] }, "x-akamai": { "file-path": "paths/search.yaml", "path-info": "/changelists/search" } }, "/changelists/{zone}": { "get": { "description": "Describes a change list, showing its base zone version, last modified time, and current change tag.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone" }, "operationId": "get-changelists-zone", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "changeTag": "476754f4-d605-479f-853b-db854d7254fa", "lastModifiedDate": "2021-02-01T12:00:12.524Z", "stale": false, "zone": "example.com", "zoneVersionId": "1d9c887c-49bb-4382-87a6-d1bf690aa58f" }, "schema": { "additionalProperties": false, "description": "Metadata about a change list. Includes the zone version that the change list was derived from when it was created.", "properties": { "changeTag": { "description": "An ETag for this change list.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 date indicating the last time the change list was modified.", "type": "string" }, "stale": { "description": "If the parent version isn't current, this change list is stale.", "type": "boolean" }, "zone": { "description": "The name of the zone.", "type": "string" }, "zoneVersionId": { "description": "The zone version identifier for the parent version of this change list.", "type": "string" } }, "required": [ "zone", "changeTag", "zoneVersionId", "stale", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-get.yaml" } } } }, "description": "Successful response." }, "304": { "content": {}, "description": "Redirect - Not Modified." } }, "summary": "Get a change list", "tags": [ "Change lists" ] }, "delete": { "description": "Removes an unneeded change list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-changelists-zone" }, "operationId": "delete-changelists-zone", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Delete a change list", "tags": [ "Change lists" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-list-zone.yaml", "path-info": "/changelists/{zone}" } }, "/changelists/{zone}/diff": { "get": { "description": "Show [differences](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-diff) between this change list and its base version.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-diff" }, "operationId": "get-changelists-zone-diff", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "diffs": { "recordSetDiffs": [ { "fromValue": { "rdata": [ "192.0.2.73" ], "ttl": 100 }, "name": "www.example.com", "operation": "DELETE", "type": "A" } ], "settingsDiffs": [ { "fieldName": "comment", "fromValue": "old comment", "operation": "EDIT", "toValue": "new comment" } ] }, "metadata": { "fromVersionId": "9a274847-11b6-4589-b445-33c2de5b1747", "fromVersionLastModifiedDate": "2021-12-25T00:00:00Z", "toVersionId": "a41df66e-fd52-4da6-b963-c92d3f7db4d3", "toVersionLastModifiedDate": "2021-12-25T00:00:00Z" } }, "schema": { "additionalProperties": false, "description": "A report on the difference between two zone versions or a version and a change list.", "properties": { "diffs": { "additionalProperties": false, "description": "Collections of differences between the two versions.", "properties": { "recordSetDiffs": { "description": "Record sets that have changed between two versions.", "items": { "additionalProperties": false, "description": "The difference in a record set between two versions.", "properties": { "fromValue": { "description": "The prior value of the settings field or record set. This may be any type of data, depending on the field that changed. The value doesn't exist on an `ADD` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "name": { "description": "The name of the record set that changed.", "type": "string" }, "operation": { "description": "The type of difference. An `ADD` difference contains the `toValue` but not a `fromValue`. A `DELETE` difference is the other way around. An `EDIT` difference has both fields.", "enum": [ "ADD", "DELETE", "EDIT" ], "type": "string" }, "toValue": { "description": "The new value of the settings field or record set. This may be any type of data, depending on the field that changed. The value doesn't exist on an `DELETE` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "type": { "description": "The type of the record set that changed.", "type": "string" } }, "required": [ "name", "type", "operation" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-recordset.yaml" } }, "type": "array" }, "settingsDiffs": { "description": "Settings fields that have changed between two versions.", "items": { "additionalProperties": false, "description": "The difference in a settings value between two versions.", "properties": { "fieldName": { "description": "The name of the settings value that changed.", "type": "string" }, "fromValue": { "description": "The prior value of the settings field or record set. This may be any type of data, depending on the field that changed. The value isn't present for an `ADD` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "operation": { "description": "The type of difference. An `ADD` difference contains the `toValue` and a `DELETE` difference contains a `fromValue`. An `EDIT` difference contains both fields.", "enum": [ "ADD", "DELETE", "EDIT" ], "type": "string" }, "toValue": { "description": "The new value of the settings field or record set. This may be any type of data, depending on the field that changed. The value isn't present for a `DELETE` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] } }, "required": [ "fieldName", "operation" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-setting.yaml" } }, "type": "array" } }, "type": "object" }, "metadata": { "additionalProperties": false, "description": "Metadata about this diff report, describing the versions being diffed.", "properties": { "fromVersionId": { "description": "The version ID of the base version.", "type": "string" }, "fromVersionLastModifiedDate": { "description": "ISO 8601 timestamp indicating when the base version was last modified.", "format": "date-time", "type": "string" }, "toVersionId": { "description": "The version ID of the new version or change list.", "type": "string" }, "toVersionLastModifiedDate": { "description": "ISO 8601 timestamp indicating when the new change list version was last modified.", "format": "date-time", "type": "string" } }, "required": [ "fromVersionId", "toVersionId", "fromVersionLastModifiedDate", "toVersionLastModifiedDate" ], "type": "object" } }, "required": [ "metadata", "diffs" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-report.yaml" } } } }, "description": "Successful response." } }, "summary": "Show changes", "tags": [ "Change lists" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-diff.yaml", "path-info": "/changelists/{zone}/diff" } }, "/changelists/{zone}/names": { "get": { "description": "Retrieves existing record names on this zone, based on the change list. If a record is deleted in the change list, it doesn't appear on the records returned. If no record sets exist within the change list, this operation returns an empty list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names" }, "operationId": "get-changelists-zone-names", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "names": [ "example.com", "www.example.com", "ftp.example.com", "space.example.com", "web.example.com" ] }, "schema": { "additionalProperties": false, "description": "Record names.", "properties": { "names": { "description": "Record names.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "names" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset-name-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List record set names for a change list", "tags": [ "Change lists" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-list-names.yaml", "path-info": "/changelists/{zone}/names" } }, "/changelists/{zone}/names/{name}/types": { "get": { "description": "Retrieves existing record set types for a given name based on the selected change list. The record sets returned reflect the changes added to the change list. Records deleted in this change list don't appear. If the name doesn't exist within the change list, returns an empty list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names-name-types" }, "operationId": "get-changelists-zone-names-name-types", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "types": [ "A", "AAAA", "MX" ] }, "schema": { "additionalProperties": false, "description": "Record types.", "properties": { "types": { "description": "Record types.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "types" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset-type-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List record set types for name and change list", "tags": [ "Types" ] }, "parameters": [ { "description": "A domain name, including the parent zone.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "www.example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/name-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-list-types.yaml", "path-info": "/changelists/{zone}/names/{name}/types" } }, "/changelists/{zone}/names/{name}/types/{type}": { "get": { "description": "Returns an individual record set based on the selected change list. The record sets returned reflects any changes added to this change list. Record sets are annotated with the related change as clean, modified, new, or deleted. This call works even if the change list is stale.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names-name-types-type" }, "operationId": "get-changelists-zone-names-name-types-type", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.207", "192.0.2.184" ], "state": "PRISTINE", "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A modification of a record set inside a change list.", "properties": { "name": { "description": "The DNS name of this record.", "type": "string" }, "rdata": { "description": "Data strings, representing multiple records within a set. The format of the `rdata` strings depend on the `type` of this record. Not used When the `op` value for the PATCH request is DELETE.", "items": { "type": "string" }, "type": "array" }, "state": { "description": "The state of this record in the change list. A `PRISTINE` record hasn't been changed, otherwise it has been `ADDED`, `EDITED`, or `DELETED`.", "enum": [ "PRISTINE", "ADDED", "EDITED", "DELETED" ], "type": "string" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached. Not used when the `op` value for the PATCH request is `DELETE`.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata", "state" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-recordset-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a record set for a change list", "tags": [ "Types" ] }, "parameters": [ { "description": "The record set type.", "example": "{{type}}", "in": "path", "name": "type", "required": true, "schema": { "example": "A", "type": "string" }, "x-akamai": { "file-path": "parameters/type-path.yaml" } }, { "description": "A domain name, including the parent zone.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "www.example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/name-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-list-type.yaml", "path-info": "/changelists/{zone}/names/{name}/types/{type}" } }, "/changelists/{zone}/recordsets": { "post": { "description": "Replaces your change list's record sets with the contents of a master zone file.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-recordsets" }, "operationId": "post-changelists-zone-recordsets", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "text/dns": { "example": "\nexample.com. 10000 IN SOA ns1.akamaidns.com. webmaster.example.com. 1 28800 14400 2419200 86400\nexample.com. 10000 IN NS ns1.akamaidns.com.\nexample.com. 10000 IN NS ns2.akamaidns.com.\nexample.com. 300 IN A 10.0.0.1\nexample.com. 300 IN A 10.0.0.2\nwww.example.com. 300 IN A 10.0.0.1\nwww.example.com. 300 IN A 10.0.0.2", "schema": { "type": "string" } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Upload a master zone file to a change list", "tags": [ "Record sets" ] }, "get": { "description": "Retrieves the current record sets based on the selected change list. The record sets returned reflect any Changes added to this change list. This call works even if the change list is stale. This operation is (paginated](ref:use-pagination).", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-recordsets" }, "operationId": "get-changelists-zone-recordsets", "parameters": [ { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Allowed fields include `name` and `type`.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "name", "type" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-name-type-query.yaml" } }, { "description": "Displays only record sets that match one of the provided types. Specifies multiple fields as a comma-separated list. Ignores illegal or disallowed record types.", "example": "{{types}}", "explode": false, "in": "query", "name": "types", "schema": { "example": [ "A", "AAAA" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/types-record-sets-query.yaml" } }, { "description": "Displays only record sets whose NAME or RDATA field matches this value. All records with the same name and type are included if any record in the set has a NAME or RDATA that matches the value case-insensitively.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/search-name-rdata-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "page": 1, "pageSize": 25, "totalElements": 2, "types": [ "A" ], "zone": "example.com" }, "recordsets": [ { "name": "www.example.com", "rdata": [ "192.0.2.55", "192.0.2.127" ], "state": "PRISTINE", "ttl": 300, "type": "A" }, { "name": "mail.example.com", "rdata": [ "192.0.2.13", "192.0.2.129" ], "state": "DELETED", "ttl": 300, "type": "A" } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "recordsets": { "description": "A modification of a record set inside a change list.", "items": { "additionalProperties": false, "description": "A modification of a record set inside a change list.", "properties": { "name": { "description": "The DNS name of this record.", "type": "string" }, "rdata": { "description": "Data strings, representing multiple records within a set. The format of the `rdata` strings depend on the `type` of this record. Not used When the `op` value for the PATCH request is DELETE.", "items": { "type": "string" }, "type": "array" }, "state": { "description": "The state of this record in the change list. A `PRISTINE` record hasn't been changed, otherwise it has been `ADDED`, `EDITED`, or `DELETED`.", "enum": [ "PRISTINE", "ADDED", "EDITED", "DELETED" ], "type": "string" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached. Not used when the `op` value for the PATCH request is `DELETE`.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata", "state" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-recordset-get.yaml" } }, "type": "array" } }, "required": [ "metadata", "recordsets" ], "type": "object", "x-akamai": { "file-path": "schemas/get-changelists-zone-recordsets-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List record sets for a change list", "tags": [ "Record sets" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/change-list-record-sets.yaml", "path-info": "/changelists/{zone}/recordsets" } }, "/changelists/{zone}/recordsets/add-change": { "post": { "description": "Adds a record set change to this change list. Each change is an operation that affects a single record set: `ADD`, `EDIT`, or `DELETE`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-recordsets-add-change" }, "operationId": "post-changelists-zone-recordsets-add-change", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "ftp.example.com", "op": "ADD", "rdata": [ "192.0.2.72" ], "ttl": 100, "type": "A" }, "schema": { "additionalProperties": false, "description": "A modification of a record set inside a change list.", "properties": { "name": { "description": "The DNS name of this record.", "example": "{{name}}", "type": "string" }, "op": { "description": "The requested operation. You can `ADD`, `EDIT`, or `DELETE` a record set.", "enum": [ "ADD", "EDIT", "DELETE" ], "example": "{{op}}", "type": "string" }, "rdata": { "description": "Data strings, representing multiple records within a set. The format of the `rdata` strings depend on the `type` of this record. Not used when `PATCH`ing a `DELETE` operation.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached. Not used when `PATCH`ing a `DELETE` operation.", "example": "{{ttl}}", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "example": "{{type}}", "type": "string" } }, "required": [ "name", "type", "op" ], "type": "object", "x-akamai": { "file-path": "schemas/changelist-recordset-patch.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Modify record set for a change list", "tags": [ "Record sets" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/add-change.yaml", "path-info": "/changelists/{zone}/recordsets/add-change" } }, "/changelists/{zone}/settings": { "get": { "description": "Retrieves the zone's settings based on the selected change list. Zone settings include metadata about the zone, but not the record sets. The data returned reflects the zone setting changes included in the change list. This call works even if the change list is stale.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-settings" }, "operationId": "get-changelists-zone-settings", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "tyamada", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Get change list settings", "tags": [ "Change list settings" ] }, "put": { "description": "Updates the change list with new Zone settings. The entire Zone object is needed no matter how many fields you're updating.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-changelists-zone-settings" }, "operationId": "put-changelists-zone-settings", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "category": "general", "comment": "adding a single new zone with zto", "contractId": "K-0N7RAK71", "lastActivationDate": "2023-11-06T14:29:48.743796Z", "lastModifiedBy": "adevi", "lastModifiedDate": "2023-11-06T14:29:37.802253Z", "multiProviderDnssec": { "enabled": true, "webhook": "https://example.url/akamai_webhook" }, "outboundZoneTransfer": { "ACL": [ "192.0.2.156/24", "2001:db8:69e:6c67:506d:ae87:fed8:23a1/32" ], "enabled": true, "notifyTargets": [ "192.0.2.192", "2001:db8:5577:c820:205:5d81:d7c4:389d" ], "tsigKey": { "algorithm": "hmac-md5", "name": "other.com.akamai.com3", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" } }, "signAndServe": true, "signAndServeAlgorithm": "ECDSA_P256_SHA256", "subzoneGrants": false, "type": "PRIMARY", "versionId": "c101efcc-1bff-4d6d-9566-0471af6bfba6", "zone": "zto_emea.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "example": "{{category}}", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "example": "{{comment}}", "type": "string" }, "contractId": { "description": "The contract for this zone.", "example": "{{contractId}}", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "example": "{{endCustomerId}}", "type": "string" }, "lastActivationDate": { "description": "__Read-only__ Used for primary and secondary zones only. An ISO 8601 timestamp showing when the latest version was activated.", "example": "{{lastActivationDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The user that last edited this zone.", "example": "{{lastModifiedBy}}", "readOnly": true, "type": "string" }, "lastModifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the zone's last modification.", "example": "{{lastModifiedDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "masters": { "description": "For secondary zones only. The names or addresses of the customer's name servers from which the zone data should be retrieved.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "example": "{{signAndServe}}", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "example": "{{signAndServeAlgorithm}}", "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "example": "{{subzoneGrants}}", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "example": "{{target}}", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "example": "{{type}}", "type": "string" }, "versionId": { "description": "__Read-only__ The UUID of the most recently activated version.", "example": "{{versionId}}", "readOnly": true, "type": "string" }, "zone": { "description": "The name of the zone.", "example": "{{zone}}", "type": "string" } }, "required": [ "zone", "type", "signAndServe" ], "type": "object", "x-akamai": { "file-path": "schemas/put-zones-zone-request.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Update change list settings", "tags": [ "Change list settings" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/settings.yaml", "path-info": "/changelists/{zone}/settings" } }, "/changelists/{zone}/submit": { "post": { "description": "Applies all of the changes in this change list to the current zone. This operation fails if the change list has become stale.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-changelists-zone-submit" }, "operationId": "post-changelists-zone-submit", "parameters": [ { "description": "If set to true, skips safety checks when disabling sign and serve.", "example": "{{skipSignAndServeSafetyCheck}}", "in": "query", "name": "skipSignAndServeSafetyCheck", "required": false, "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/skip-sign-and-serve-safety-check-query.yaml" } }, { "description": "A new comment string that may be blank. If not included, the old comment is copied.", "example": "{{comment}}", "in": "query", "name": "comment", "schema": { "example": "Migrated from legacy DNS provider", "type": "string" }, "x-akamai": { "file-path": "parameters/comment-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Submit a change list", "tags": [ "Change lists" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/submit.yaml", "path-info": "/changelists/{zone}/submit" } }, "/data/authorities": { "get": { "description": "Retrieves the currently assigned Akamai authoritative name servers for one or more contracts.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-authorities" }, "operationId": "get-data-authorities", "parameters": [ { "description": "Show only the authoritative name servers for the specified contracts. Multiple values may be specified as a comma-separated list.", "example": "{{contractIds}}", "in": "query", "name": "contractIds", "schema": { "example": "C-0N7RAC7,K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-ids-nameservers-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "contracts": [ { "authorities": [ "a1-118.akam.net.", "a2-64.akam.net.", "a6-66.akam.net.", "a18-67.akam.net.", "a7-64.akam.net.", "a11-64.akam.net." ], "contractId": "K-0N7RAK71" }, { "authorities": [ "a1-112.akam.net.", "a4-67.akam.net.", "a14-66.akam.net.", "a16-65.akam.net.", "a9-66.akam.net.", "a7-67.akam.net." ], "contractId": "C-0N7RAC71" } ] }, "schema": { "additionalProperties": false, "description": "Akamai authoritative name server assignments by contract ID.", "properties": { "contracts": { "description": "Akamai assigns a unique set of authoritative name servers for each contract. These authorities should be used as the `NS` name server records on all zones belonging to this contract.", "items": { "additionalProperties": false, "description": "Akamai assigns a unique set of authoritative name servers for each contract. These authorities should be used as the `NS` name server records on all zones belonging to this contract.", "properties": { "authorities": { "description": "Akamai authoritative name servers for this contract.", "items": { "type": "string" }, "type": "array" }, "contractId": { "description": "The contract ID.", "type": "string" } }, "required": [ "contractId", "authorities" ], "type": "object", "x-akamai": { "file-path": "schemas/authorities-get.yaml" } }, "type": "array" } }, "required": [ "contracts" ], "type": "object", "x-akamai": { "file-path": "schemas/authorities-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List authoritative name servers", "tags": [ "Authorities" ] }, "x-akamai": { "file-path": "paths/authorities.yaml", "path-info": "/data/authorities" } }, "/data/contracts": { "get": { "description": "Lists the contracts accessible to the current user. Each contract includes the features and permissions that are available to you on that contract.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-contracts" }, "operationId": "get-data-contracts", "parameters": [ { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "contracts": [ { "contractId": "K-0N7RAK71", "contractName": "Acme Inc", "contractTypeName": "DIRECT_CUSTOMER", "features": [ "PRIMARY_ZONES", "ALIAS_ZONES", "SECONDARY_ZONES", "ZONE_APEX_MAPPING", "FORCE_DELETE" ], "maximumZones": 5000, "permissions": [ "READ", "WRITE", "ADD" ], "zoneCount": 92 }, { "contractId": "C-0N7RAC71", "contractName": "Acme Europe Ltd", "contractTypeName": "DIRECT_CUSTOMER", "features": [ "PRIMARY_ZONES", "SECONDARY_ZONES", "ZONE_APEX_MAPPING" ], "maximumZones": 2000, "permissions": [ "READ" ], "zoneCount": 1023 } ] }, "schema": { "additionalProperties": false, "properties": { "contracts": { "description": "A customer contract and associated permissions.", "items": { "additionalProperties": false, "description": "A customer contract and associated permissions.", "properties": { "contractId": { "description": "The ID of the contract.", "type": "string" }, "contractName": { "description": "The name of the customer for this contract.", "type": "string" }, "contractTypeName": { "description": "An internal description of the contract type.", "type": "string" }, "features": { "description": "Edge DNS features that you have access to. Possible values are: `ALIAS_ZONES`, `DNSSEC_SELF_SIGN`, `DNSSEC_SIGN_AND_SERVE`, `FORCE_DELETE`, `PRIMARY_ZONES`, `SECONDARY_ZONES`, `SUBZONE_GRANTS` `TLD_ZONES`, or `ZONE_APEX_MAPPING`.", "items": { "enum": [ "ALIAS_ZONES", "DNSSEC_SELF_SIGN", "DNSSEC_SIGN_AND_SERVE", "FORCE_DELETE", "PRIMARY_ZONES", "SECONDARY_ZONES", "ZONE_APEX_MAPPING", "TLD_ZONES", "SUBZONE_GRANTS" ], "type": "string" }, "type": "array" }, "maximumZones": { "description": "The maximum number of zones you're able to create on this contract.", "type": "integer" }, "permissions": { "description": "The Edge DNS permissions that you have on this contract. Possible values are: `READ`, `WRITE`, `ADD`, and `DELETE`.", "items": { "enum": [ "READ", "WRITE", "ADD", "DELETE" ], "type": "string" }, "type": "array" }, "zoneCount": { "description": "The number of zones that currently exist on this contract.", "type": "integer" } }, "required": [ "contractId", "contractName", "contractTypeName", "features", "maximumZones", "permissions", "zoneCount" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-get.yaml" } }, "type": "array" } }, "required": [ "contracts" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List contracts", "tags": [ "Contracts" ] }, "x-akamai": { "file-path": "paths/contracts.yaml", "path-info": "/data/contracts" } }, "/data/dns-sec-algorithms": { "get": { "description": "Retrieves DNSSEC algorithm names.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-dns-sec-algorithms" }, "operationId": "get-data-dns-sec-algorithms", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "algorithms": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ] }, "schema": { "additionalProperties": false, "description": "Supported encryption algorithms.", "properties": { "algorithms": { "description": "Supported encryption algorithms.", "items": { "type": "string" }, "type": "array" } }, "required": [ "algorithms" ], "type": "object", "x-akamai": { "file-path": "schemas/algorithm-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List DNSSEC algorithms", "tags": [ "DNSSEC algorithms" ] }, "x-akamai": { "file-path": "paths/dns-sec-algorithms.yaml", "path-info": "/data/dns-sec-algorithms" } }, "/data/edgehostnames": { "get": { "description": "Displays Edge hostnames that have been configured for the current customer.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-edgehostnames" }, "operationId": "get-data-edgehostnames", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "edgeHostnames": [ { "edgeHostname": "example1.com.edgesuite.net", "supportsZoneApexMapping": false }, { "edgeHostname": "example2.com.edgesuite.net", "supportsZoneApexMapping": true } ] }, "schema": { "additionalProperties": false, "properties": { "edgeHostnames": { "description": "This API uses edge hosts as the target of a Zone Apex Mapping or a Top-Level Redirect record. When using edge hosts as targets, only select hosts where `supportsZoneApexMapping` is `true`.", "items": { "additionalProperties": false, "description": "This API uses edge hosts as the target of a Zone Apex Mapping or a Top-Level Redirect record. When using edge hosts as targets, only select hosts where `supportsZoneApexMapping` is `true`.", "properties": { "edgeHostname": { "description": "The DNS name of this edge host.", "type": "string" }, "supportsZoneApexMapping": { "description": "If `true`, you can use this edge host as the target of a Zone Apex Mapping record.", "type": "boolean" } }, "required": [ "edgeHostname", "supportsZoneApexMapping" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-get.yaml" } }, "type": "array" } }, "required": [ "edgeHostnames" ], "type": "object", "x-akamai": { "file-path": "schemas/edge-hostname-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List edge hostnames", "tags": [ "Edge hostnames" ] }, "x-akamai": { "file-path": "paths/edge-hostnames.yaml", "path-info": "/data/edgehostnames" } }, "/data/groups": { "get": { "description": "Lists the groups accessible to the current user. Each group includes the contracts related to that group, as well as your permissions of `READ`, `WRITE`, `ADD`, or `DELETE` zone on that group.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-groups" }, "operationId": "get-data-groups", "parameters": [ { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "groups": [ { "contractIds": [ "C-0N7RAC71" ], "groupId": 54321, "groupName": "example-name", "permissions": [ "READ", "WRITE", "ADD", "DELETE" ] } ] }, "schema": { "additionalProperties": false, "properties": { "groups": { "description": "A customer group and associated permissions.", "items": { "additionalProperties": false, "description": "A customer group and associated permissions.", "properties": { "contractIds": { "description": "Contract IDs that this group contains.", "items": { "type": "string" }, "type": "array" }, "groupId": { "description": "The group ID.", "type": "integer" }, "groupName": { "description": "The name of this group.", "type": "string" }, "permissions": { "description": "Permissions that the current user has on this group: `ADD`, `DELETE`, `READ`, and `WRITE`.", "items": { "enum": [ "READ", "WRITE", "ADD", "DELETE" ], "type": "string" }, "type": "array" } }, "required": [ "groupId", "groupName", "contractIds", "permissions" ], "type": "object", "x-akamai": { "file-path": "schemas/group-get.yaml" } }, "type": "array" } }, "required": [ "groups" ], "type": "object", "x-akamai": { "file-path": "schemas/group-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List groups", "tags": [ "Groups" ] }, "x-akamai": { "file-path": "paths/groups.yaml", "path-info": "/data/groups" } }, "/data/recordset-types": { "get": { "description": "Retrieves record types you can add to the requested zone. Record types depend on both the zone type and the available contract features.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-record-set-types" }, "operationId": "get-record-set-types", "parameters": [ { "description": "The name of an Edge DNS zone.", "example": "{{zone}}", "in": "query", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "types": [ "A", "AAAA", "MX" ] }, "schema": { "additionalProperties": false, "description": "Record set types that can be used with a particular zone.", "properties": { "types": { "description": "Record set types that can be used with a particular zone.", "items": { "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object", "x-akamai": { "file-path": "schemas/recordtype-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List record types", "tags": [ "Record types" ] }, "x-akamai": { "file-path": "paths/recordset-types.yaml", "path-info": "/data/recordset-types" } }, "/data/tsig-algorithms": { "get": { "description": "Retrieves TSIG algorithm names.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-data-tsig-algorithms" }, "operationId": "get-data-tsig-algorithms", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "algorithms": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ] }, "schema": { "additionalProperties": false, "description": "Supported encryption algorithms.", "properties": { "algorithms": { "description": "Supported encryption algorithms.", "items": { "type": "string" }, "type": "array" } }, "required": [ "algorithms" ], "type": "object", "x-akamai": { "file-path": "schemas/algorithm-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List TSIG key algorithms", "tags": [ "TSIG key algorithms" ] }, "x-akamai": { "file-path": "paths/tsig-algorithms.yaml", "path-info": "/data/tsig-algorithms" } }, "/keys": { "get": { "description": "Get the TSIG keys used by zones that you're allowed to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-keys" }, "operationId": "get-keys", "parameters": [ { "description": "Limits the list to those keys belonging to the specified contracts. You can specify a comma-separated list with multiple contract IDs.", "example": "{{contractIds}}", "in": "query", "name": "contractIds", "schema": { "example": "C-0N7RAC7,K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-ids-keys-query.yaml" } }, { "description": "Limits the list to those keys whose key name or algorithm name contains the specified string.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "hmac-sha256", "type": "string" }, "x-akamai": { "file-path": "parameters/search-keys-query.yaml" } }, { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "name", "-algorithm" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-keys-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "keys": [ { "algorithm": "hmac-sha256", "name": "a.example.key.", "secret": "DjY16JfIi3JnSDosQWE7Xkx60MbCLo1K7hUCqng8ccg=", "zonesCount": 3 }, { "algorithm": "hmac-sha512", "name": "another.example.key.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==", "zonesCount": 7 } ], "metadata": { "totalElements": 2 } }, "schema": { "additionalProperties": false, "description": "A report of TSIG keys available to you.", "properties": { "keys": { "description": "This block contains keys that matched the request.", "items": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "This block contains information about the request, including any parameters, and the response, including its size.", "properties": { "contracts": { "description": "If the `contractIds` parameter was passed in, this field contains the contract IDs.", "items": { "type": "string" }, "type": "array" }, "gid": { "description": "If the `gid` parameter was passed in, this field displays its value.", "type": "integer" }, "search": { "description": "If the `search` parameter was passed in, this field displays its value.", "type": "string" }, "sortBy": { "description": "If the `sortBy` parameter was passed in, this field contains the sorting fields.", "items": { "type": "string" }, "type": "array" }, "totalElements": { "description": "The total number of TSIG keys that matched the request parameters.", "minimum": 0, "type": "integer" } }, "required": [ "totalElements" ], "type": "object" } }, "required": [ "metadata", "keys" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-report.yaml" } } } }, "description": "Successful operation." } }, "summary": "List TSIG keys", "tags": [ "TSIG keys" ] }, "x-akamai": { "file-path": "paths/keys.yaml", "path-info": "/keys" } }, "/keys/bulk-update": { "post": { "description": "This updates the key data for multiple zones at once. Keep in mind that this operation can only add zones to a TSIG key, not remove them. To safely remove the association between a zone and a TSIG key, update the zone to its new TSIG key or remove the key from the zone if you're sure it's no longer needed.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-keys-bulk-update" }, "operationId": "post-keys-bulk-update", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "key": { "algorithm": "hmac-sha512", "name": "brook.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "A TSIG key and zones using it.", "properties": { "key": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "zones": { "description": "Names of zones that should use the key.", "items": { "type": "string" }, "type": "array" } }, "required": [ "key", "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-bulk-post.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "The operation was successful. No response data is returned." } }, "summary": "Update a TSIG key across zones", "tags": [ "TSIG keys" ] }, "x-akamai": { "file-path": "paths/bulk-update.yaml", "path-info": "/keys/bulk-update" } }, "/keys/used-by": { "post": { "description": "Returns zone names that use the given TSIG key and for which the current user has READ access. If the zones returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-keys-used-by" }, "operationId": "post-keys-used-by", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "schema": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "example": "{{algorithm}}", "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "example": "{{name}}", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "example": "{{secret}}", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "description": "Successful operation." } }, "summary": "List zones using TSIG key", "tags": [ "TSIG keys" ] }, "x-akamai": { "file-path": "paths/key-used-by.yaml", "path-info": "/keys/used-by" } }, "/keys/used-by/zone-contract-map": { "post": { "description": "Zone names within a contract that use the given TSIG key for which the current user has READ access. If the list returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-keys-used-by-zone-contract-map" }, "operationId": "post-keys-used-by-zone-contract-map", "parameters": [ { "description": "__Enum__ Limits the response to zones of the specified TSIG key type. Either `inbound`, `outbound`, or `proxy`.", "example": "{{keyType}}", "in": "query", "name": "keyType", "schema": { "enum": [ "inbound", "outbound", "proxy" ], "example": "inbound", "type": "string" }, "x-akamai": { "file-path": "parameters/key-type-keys-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com." }, "schema": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "example": "{{algorithm}}", "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "example": "{{name}}", "type": "string" } }, "required": [ "name", "algorithm" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-no-secret-post.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "contracts": [ { "contractId": "K-0N7RAK7", "zoneNames": [ "example.com", "example.net" ] }, { "contractId": "C-0N7RAC7", "zoneNames": [ "example.org" ] } ] }, "schema": { "additionalProperties": false, "description": "Contracts and zones for a TSIG key.", "properties": { "contracts": { "description": "Contracts and zones for the TSIG key.", "items": { "additionalProperties": false, "description": "Maps contract IDs to zone names.", "properties": { "contractId": { "description": "The contract ID.", "type": "string" }, "zoneNames": { "description": "Names of zones that are using the key.", "items": { "type": "string" }, "type": "array" } }, "required": [ "contractId", "zoneNames" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-zone-map-response.yaml" } } } }, "required": [ "contracts" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-zone-map-report-response.yaml" } } } }, "description": "Successful operation." } }, "summary": "Zones to contract using TSIG key", "tags": [ "TSIG keys" ] }, "x-akamai": { "file-path": "paths/zone-contract-map.yaml", "path-info": "/keys/used-by/zone-contract-map" } }, "/proxies": { "post": { "description": "Creates a new proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy" }, "operationId": "post-proxy", "parameters": [ { "description": "The contract to use for the proxy.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-proxy-query.yaml" } }, { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "contractId": "C-0N7RAC7", "healthCheck": { "recordName": "example.com.", "recordType": "MX" }, "name": "F5", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.129", "port": 53 } ], "zoneTransferNameservers": [] }, "schema": { "additionalProperties": false, "description": "A Proxy.", "properties": { "activationState": { "description": "__Read-only__ The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "example": "{{activationState}}", "readOnly": true, "type": "string" }, "authorities": { "description": "__Read-only__ The authoritative service IPs set by Akamai. Any changes you make to `authorities` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "authoritiesDnsNames": { "description": "__Read-only__ NS records for the the authoritative service IPs set by Akamai. Any changes you make to `authoritiesDnsNames` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "contractId": { "description": "The contract for this proxy.", "example": "{{contractId}}", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "example": "{{createdTime}}", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The proxy ID.", "example": "{{id}}", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "example": "{{lastModifiedTime}}", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "example": "{{name}}", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers for `AUTOMATIC` filter mode. The default value is the `originNameservers` section.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "name", "contractId", "originNameservers", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "activationState": "NEW", "authorities": [], "authoritiesDnsNames": [], "contractId": "C-0N7RAC7", "createdTime": "2024-03-28T20:55:47.890229Z", "healthCheck": { "recordName": "example.com.", "recordType": "MX" }, "id": "4de9ce8e-4182-416c-a7d1-8252023df4d3", "lastModifiedTime": "2024-03-28T20:55:47.890229Z", "name": "F5", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [] }, "schema": { "additionalProperties": false, "description": "Proxy details.", "properties": { "activationState": { "description": "The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ] }, "authorities": { "description": "The authoritative service IPs.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "authoritiesDnsNames": { "description": "The authoritative service NS records.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The unique proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameservers` section is used.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "id", "name", "contractId", "activationState", "createdTime", "originNameservers", "authorities", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-get.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Create a proxy", "tags": [ "DNS proxies" ] }, "get": { "description": "Get all proxies that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy" }, "operationId": "get-proxy", "parameters": [ { "description": "Limits the list of proxies belonging to the specified name servers.", "example": "{{nameserver}}", "in": "query", "name": "nameserver", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/nameserver-proxy-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "activationState": "ACTIVE", "authorities": [ "192.0.2.161", "2001:db8:6b4e:3234:365e:6afe:54d6:9b32" ], "authoritiesDnsNames": [ "c1-25.akashield.net", "c2-30.akashield.net" ], "contractId": "C-0N7RAC7", "createdTime": "2024-12-20T00:00:00Z", "healthCheck": { "recordName": "example.com", "recordType": "SOA" }, "id": "dc33c6bf-801c-577d-b6f7-d9a058eaa7db", "lastModifiedTime": "2024-12-24T00:00:00Z", "name": "Rivers Shields", "originNameserverZoneTransferTargets": [ "192.0.2.167", "192.0.2.254" ], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [ { "name": "192.0.2.167", "port": 53 }, { "name": "192.0.2.254", "port": 53 } ] }, { "activationState": "NEW", "authorities": [], "contractId": "C-0N7RAC71", "createdTime": "2024-12-18T00:00:00Z", "healthCheck": { "recordName": "example.net", "recordType": "TXT" }, "id": "6ef0340d-5b93-4a9a-8fc3-0f3ba26f7443", "lastModifiedTime": "2024-12-18T00:00:00Z", "name": "Oceans Proxy", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.135", "port": 443 } ], "zoneTransferNameservers": [] } ] }, "schema": { "additionalProperties": false, "properties": { "items": { "description": "Proxies response.", "items": { "additionalProperties": false, "description": "A Proxy.", "properties": { "activationState": { "description": "__Read-only__ The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "readOnly": true, "type": "string" }, "authorities": { "description": "__Read-only__ The authoritative service IPs set by Akamai. Any changes you make to `authorities` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "authoritiesDnsNames": { "description": "__Read-only__ NS records for the the authoritative service IPs set by Akamai. Any changes you make to `authoritiesDnsNames` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers for `AUTOMATIC` filter mode. The default value is the `originNameservers` section.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "name", "contractId", "originNameservers", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post.yaml" } }, "type": "array" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxies-response.yaml" } } } }, "description": "Proxies that you own." } }, "summary": "List proxies", "tags": [ "DNS proxies" ] }, "x-akamai": { "file-path": "paths/proxies.yaml", "path-info": "/proxies" } }, "/proxies/healthcheck-recordset-types": { "get": { "description": "Lists the valid proxy health check record set types.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-healthcheck-recordset-types" }, "operationId": "get-proxy-healthcheck-recordset-types", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "types": [ "A", "AAAA", "AFSDB", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "NSEC", "NSEC3", "NSEC3PARAM", "PTR", "RP", "RRSIG", "SOA", "SPF", "SRV", "SSHFP", "SVCB", "TLSA", "TXT" ] }, "schema": { "additionalProperties": false, "properties": { "types": { "description": "Supported DNS resource record types. Refer to [Supported resource record types](https://techdocs.akamai.com/edge-dns/docs/features#supported-resource-record-types) for the complete list.", "items": { "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object", "x-akamai": { "file-path": "schemas/get-healthcheck-record-types-response.yaml" } } } }, "description": "The health check record set types allowed for proxies." } }, "summary": "List valid proxy health check record set types", "tags": [ "DNS proxies" ] }, "x-akamai": { "file-path": "paths/health-check-recordset-types.yaml", "path-info": "/proxies/healthcheck-recordset-types" } }, "/proxies/{proxyId}": { "get": { "description": "Get the proxy that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-id" }, "operationId": "get-proxy-id", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "activationState": "NEW", "authorities": [], "authoritiesDnsNames": [], "contractId": "C-0N7RAC7", "createdTime": "2024-03-28T20:55:47.890229Z", "healthCheck": { "recordName": "example.com.", "recordType": "MX" }, "id": "4de9ce8e-4182-416c-a7d1-8252023df4d3", "lastModifiedTime": "2024-03-28T20:55:47.890229Z", "name": "F5", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [] }, "schema": { "additionalProperties": false, "description": "Proxy details.", "properties": { "activationState": { "description": "The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ] }, "authorities": { "description": "The authoritative service IPs.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "authoritiesDnsNames": { "description": "The authoritative service NS records.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The unique proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameservers` section is used.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "id", "name", "contractId", "activationState", "createdTime", "originNameservers", "authorities", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-get.yaml" } } } }, "description": "Proxy details." } }, "summary": "Get a proxy", "tags": [ "DNS proxies" ] }, "put": { "description": "Updates the proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-proxy" }, "operationId": "put-proxy", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "authorities": [], "contractId": "C-0N7RAC7", "healthCheck": { "recordName": "example.com.", "recordType": "MX" }, "id": "4de9ce8e-4182-416c-a7d1-8252023df4d3", "name": "F5", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.120", "port": 53 } ], "zoneTransferNameservers": [] }, "schema": { "additionalProperties": false, "description": "Proxy properties.", "properties": { "activationState": { "description": "The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "example": "{{activationState}}" }, "authorities": { "description": "The authoritative service IPs controlled by Akamai. Authority updates by customer are ignored.", "items": { "type": "string" }, "type": "array" }, "contractId": { "description": "The contract for this proxy.", "example": "{{contractId}}", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "example": "{{createdTime}}", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The unique proxy ID.", "example": "{{id}}", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "example": "{{lastModifiedTime}}", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "example": "{{name}}", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers with AUTOMATIC filter_mode. If this field is omitted the `originNameservers` section is used.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "name", "contractId", "originNameservers", "healthCheck", "id" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-put.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "activationState": "NEW", "authorities": [], "authoritiesDnsNames": [], "contractId": "C-0N7RAC7", "createdTime": "2024-03-28T20:55:47.890229Z", "healthCheck": { "recordName": "example.com.", "recordType": "MX" }, "id": "4de9ce8e-4182-416c-a7d1-8252023df4d3", "lastModifiedTime": "2024-03-28T20:55:47.890229Z", "name": "F5", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [] }, "schema": { "additionalProperties": false, "description": "Proxy details.", "properties": { "activationState": { "description": "The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ] }, "authorities": { "description": "The authoritative service IPs.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "authoritiesDnsNames": { "description": "The authoritative service NS records.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The unique proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameservers` section is used.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "id", "name", "contractId", "activationState", "createdTime", "originNameservers", "authorities", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-get.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Update a proxy", "tags": [ "DNS proxies" ] }, "delete": { "description": "Delete the proxy as an asynchronous operation. Your proxy will continue to show with a `DELETED` status and continue to count against your maximum proxy cap until permanently removed.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-proxy" }, "operationId": "delete-proxy", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful delete response." } }, "summary": "Delete a proxy", "tags": [ "DNS proxies" ] }, "x-akamai": { "file-path": "paths/proxy.yaml", "path-info": "/proxies/{proxyId}" } }, "/proxies/{proxyId}/healthcheck/run": { "post": { "description": "Runs the health check currently defined on the proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-run-proxy-healthcheck" }, "operationId": "post-run-proxy-healthcheck", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failures": 3, "healthCheck": { "recordName": "www.customer.com", "recordType": "A" }, "healthcheckResults": [ { "name": "192.0.2.191", "port": 53, "resolved": "192.0.2.136", "responseCode": "NOERROR", "sourceIp": "192.0.2.12" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.110", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.130" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.40", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.95" }, { "name": "192.0.2.121", "port": 53, "resolved": "192.0.2.151", "responseCode": "SERVFAIL", "sourceIp": "192.0.2.46" } ], "proxyActivationStatus": "ACTIVE", "status": "WARNING", "tests": 4 }, "schema": { "additionalProperties": true, "description": "Results of running a proxy health check.", "properties": { "failures": { "description": "Number of failed health check tests.", "type": "integer" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "healthcheckResults": { "description": "Health check results.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name or address checked.", "type": "string" }, "port": { "description": "Port used for the health check.", "type": "integer" }, "resolved": { "description": "Resolved IP address.", "type": "string" }, "responseCode": { "description": "A set of DNS response code, any of these values: `NOERROR`, `NXDOMAIN`, and `SERVFAIL`.", "enum": [ "NOERROR", "NXDOMAIN", "SERVFAIL" ], "type": "string" }, "sourceIp": { "description": "Source IP address of the health check.", "type": "string" } }, "required": [ "name", "resolved", "port", "sourceIp", "responseCode" ], "type": "object" }, "type": "array" }, "proxyActivationStatus": { "description": "A set of Proxy activation status, any of these values: `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, and `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "type": "string" }, "status": { "description": "A set of health check status, any of these values: `OK`, `WARNING`, and `ERROR`.", "enum": [ "OK", "WARNING", "ERROR" ], "type": "string" }, "tests": { "description": "Number of health check tests run.", "type": "integer" } }, "required": [ "status", "tests", "failures", "proxyActivationStatus", "healthCheck", "healthcheckResults" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-run-healthcheck.yaml" } } } }, "description": "Successful response." } }, "summary": "Run existing proxy health check", "tags": [ "DNS proxy health check" ] }, "x-akamai": { "file-path": "paths/proxy-run-healthcheck.yaml", "path-info": "/proxies/{proxyId}/healthcheck/run" } }, "/proxies/{proxyId}/healthcheck/run-proposed": { "post": { "description": "Runs a proposed health check on the proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-run-proposed-proxy-healthcheck" }, "operationId": "post-run-proposed-proxy-healthcheck", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "healthCheck": { "recordName": "www.customer.com", "recordType": "A" }, "originNameservers": [ { "name": "192.0.2.78", "port": 53 }, { "name": "customer-hostname.customer.com", "port": 53 }, { "name": "192.0.2.90", "port": 53 } ] }, "schema": { "additionalProperties": false, "description": "Request to run a proposed proxy health check against a set of origin name servers.", "properties": { "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "originNameservers": { "description": "List of master name servers to check.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "healthCheck", "originNameservers" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post-run-proposed-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "failures": 3, "healthCheck": { "recordName": "www.customer.com", "recordType": "A" }, "healthcheckResults": [ { "name": "192.0.2.191", "port": 53, "resolved": "192.0.2.136", "responseCode": "NOERROR", "sourceIp": "192.0.2.12" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.110", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.130" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.40", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.95" }, { "name": "192.0.2.121", "port": 53, "resolved": "192.0.2.151", "responseCode": "SERVFAIL", "sourceIp": "192.0.2.46" } ], "proxyActivationStatus": "ACTIVE", "status": "WARNING", "tests": 4 }, "schema": { "additionalProperties": true, "description": "Results of running a proxy health check.", "properties": { "failures": { "description": "Number of failed health check tests.", "type": "integer" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "healthcheckResults": { "description": "Health check results.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name or address checked.", "type": "string" }, "port": { "description": "Port used for the health check.", "type": "integer" }, "resolved": { "description": "Resolved IP address.", "type": "string" }, "responseCode": { "description": "A set of DNS response code, any of these values: `NOERROR`, `NXDOMAIN`, and `SERVFAIL`.", "enum": [ "NOERROR", "NXDOMAIN", "SERVFAIL" ], "type": "string" }, "sourceIp": { "description": "Source IP address of the health check.", "type": "string" } }, "required": [ "name", "resolved", "port", "sourceIp", "responseCode" ], "type": "object" }, "type": "array" }, "proxyActivationStatus": { "description": "A set of Proxy activation status, any of these values: `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, and `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "type": "string" }, "status": { "description": "A set of health check status, any of these values: `OK`, `WARNING`, and `ERROR`.", "enum": [ "OK", "WARNING", "ERROR" ], "type": "string" }, "tests": { "description": "Number of health check tests run.", "type": "integer" } }, "required": [ "status", "tests", "failures", "proxyActivationStatus", "healthCheck", "healthcheckResults" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-run-healthcheck.yaml" } } } }, "description": "Successful response." } }, "summary": "Run proposed proxy health check for origin name servers", "tags": [ "DNS proxy health check" ] }, "x-akamai": { "file-path": "paths/proxy-run-proposed-healthcheck.yaml", "path-info": "/proxies/{proxyId}/healthcheck/run-proposed" } }, "/proxies/{proxyId}/zones": { "get": { "description": "Get all proxy zones that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones" }, "operationId": "get-proxy-zones", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "Limits the proxy zones belonging to the specified name.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/search-proxy-zone-query.yaml" } }, { "description": "Limits the proxy zones belonging to the specified filter modes. Specify any combination of `AUTOMATIC` and `MANUAL` values.", "example": "{{filterMode}}", "explode": false, "in": "query", "name": "filterMode", "schema": { "example": [ "AUTOMATIC" ], "items": { "enum": [ "AUTOMATIC", "MANUAL" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/filtermode-proxy-zone-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "name", "-algorithm" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-keys-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "lastPage": 0, "page": 1, "pageSize": 25, "totalElements": 3 }, "proxyZones": [ { "apexAlias": "swan.com", "filterMode": "MANUAL", "name": "example.com" }, { "filterMode": "MANUAL", "name": "example.net" }, { "filterMode": "AUTOMATIC", "name": "example.org", "tsigKey": { "algorithm": "hmac-md5", "name": "oceanTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "proxyZones": { "description": "Proxy zones.", "items": { "additionalProperties": false, "description": "Edge DNS proxy zone settings. The `tsigKey` is present is for `filterMode` `AUTOMATIC` only and is used for zone transfers.", "properties": { "apexAlias": { "description": "The apex alias of the proxy zone.", "type": "string" }, "filterMode": { "description": "The filter mode type. Either `NONE`, `ALL`, `MANUAL`, or `AUTOMATIC`.", "enum": [ "NONE", "ALL", "MANUAL", "AUTOMATIC" ], "type": "string" }, "name": { "description": "The name of the proxy zone.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } } }, "required": [ "name", "filterMode" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-post.yaml" } }, "type": "array" } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxies-response-paginated.yaml" } } } }, "description": "Proxies that you own." } }, "summary": "List proxy zones", "tags": [ "Proxy zones" ] }, "x-akamai": { "file-path": "paths/proxy-zones.yaml", "path-info": "/proxies/{proxyId}/zones" } }, "/proxies/{proxyId}/zones/create-requests": { "post": { "description": "Submits a request to create one or more new Proxy Zones asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to create a proxy zone. All proxy zones are created on the same contract and group. An offline task creates the new proxy zones. You can use the response's `requestId` to check the task's status and view its results once it completes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zones-create-requests" }, "operationId": "post-proxy-zones-create-requests", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "proxyZones": [ { "filterMode": "MANUAL", "name": "example.com" }, { "filterMode": "MANUAL", "name": "example.net" }, { "filterMode": "AUTOMATIC", "name": "example.net", "tsigKey": { "algorithm": "hmac-md5", "name": "oceanTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } } ] }, "schema": { "additionalProperties": false, "description": "A request to create multiple proxy zones at once.", "properties": { "proxyZones": { "description": "An Edge DNS proxy zone. This object contains proxy settings.", "items": { "additionalProperties": false, "description": "Edge DNS proxy zone settings. The `tsigKey` is present is for `filterMode` `AUTOMATIC` only and is used for zone transfers.", "properties": { "apexAlias": { "description": "The apex alias of the proxy zone.", "type": "string" }, "filterMode": { "description": "The filter mode type. Either `NONE`, `ALL`, `MANUAL`, or `AUTOMATIC`.", "enum": [ "NONE", "ALL", "MANUAL", "AUTOMATIC" ], "type": "string" }, "name": { "description": "The name of the proxy zone.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } } }, "required": [ "name", "filterMode" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-post.yaml" } }, "type": "array" } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/create-proxy-request-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Resource successfully created.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk proxy zone create request", "tags": [ "Create requests" ] }, "get": { "description": "Retrieves the results of requests for a given proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-result" }, "operationId": "get-proxy-zones-create-requests-result", "parameters": [ { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.yaml" } }, { "description": "Returns only completed requests.", "example": "{{isComplete}}", "in": "query", "name": "isComplete", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/is-complete-query.yaml" } }, { "description": "Returns requests based on request expiration.", "example": "{{isExpired}}", "in": "query", "name": "isExpired", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/is-expired-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "lastPage": 0, "page": 1, "pageSize": 25, "showAll": false, "totalElements": 2 }, "requests": [ { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, { "expirationDate": "2022-03-03T12:00:00Z", "failureCount": 1, "isComplete": false, "requestId": "d585a642-0849-4b87-8dd9-91afdaf8877a", "successCount": 1, "zonesSubmitted": 1 } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "requests": { "description": "Bulk requests for a proxy.", "items": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } }, "type": "array" } }, "required": [ "metadata", "requests" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxy-zone-requests-response.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a bulk proxy zone create results for a proxy", "tags": [ "Create requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-create-requests.yaml", "path-info": "/proxies/{proxyId}/zones/create-requests" } }, "/proxies/{proxyId}/zones/create-requests/{requestId}": { "get": { "description": "Retrieves the current status of a running or completed request. The `requestId` was returned when the create request was initiated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-requestid" }, "operationId": "get-proxy-zones-create-requests-requestid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, "schema": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } } } }, "description": "Successful operation." } }, "summary": "Check bulk proxy zone create status", "tags": [ "Create requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-create-request.yaml", "path-info": "/proxies/{proxyId}/zones/create-requests/{requestId}" } }, "/proxies/{proxyId}/zones/create-requests/{requestId}/result": { "get": { "description": "Retrieves the results from a completed request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-create-requests-requestid-result" }, "operationId": "get-proxy-zones-create-requests-requestid-result", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedZones": [ { "failureReason": "PROXY_ZONE_ALREADY_EXISTS", "zone": "example.org" } ], "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successfullyCreatedZones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Proxy zone creation response. Available only after offline processing is complete.", "properties": { "failedZones": { "description": "The proxy zones that failed to be created.", "items": { "additionalProperties": false, "properties": { "failureReason": { "description": "The reason for the proxy zone creation failure. Either `MALFORMED_ZONE`, `INTERNAL_ERROR`, `PROXY_ZONE_LIMIT_EXCEEDED`, `PROXY_ZONE_ALREADY_EXISTS`, or `PROXY_DOES_NOT_EXIST`.", "enum": [ "MALFORMED_ZONE", "INTERNAL_ERROR", "PROXY_ZONE_LIMIT_EXCEEDED", "PROXY_ZONE_ALREADY_EXISTS", "PROXY_DOES_NOT_EXIST" ], "type": "string" }, "zone": { "description": "The name of the proxy zone that failed to be created.", "type": "string" } }, "required": [ "zone", "failureReason" ], "type": "object" }, "type": "array" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successfullyCreatedZones": { "description": "Names of proxy zones that were successfully created.", "items": { "type": "string" }, "type": "array" } }, "required": [ "requestId" ], "type": "object", "x-akamai": { "file-path": "schemas/create-proxy-request-result.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a bulk proxy zone create result", "tags": [ "Create requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-create-result.yaml", "path-info": "/proxies/{proxyId}/zones/create-requests/{requestId}/result" } }, "/proxies/{proxyId}/zones/delete-requests": { "post": { "description": "Submits a request to delete one or more proxy zones asynchronously. Each element in the response array is the name of a proxy zone to be deleted. Before deleting a zone from the Edge DNS system, the API makes sure Akamai servers aren't receiving DNS requests for that proxy zone. It also checks that the proxy zone isn't currently delegated to Akamai's name servers. An offline task deletes the proxy zones. The result of this operation is a `requestId`, which you can use to check the task's status and view its results once it completes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zones-delete-requests" }, "operationId": "post-proxy-zones-delete-requests", "parameters": [ { "description": "If `true`, disables the delegation checks and deletes the zones as soon as possible. It's `false` by default.", "example": "{{bypassSafetyChecks}}", "in": "query", "name": "bypassSafetyChecks", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/bypass-safety-checks-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "proxyZones": [ "example.com", "example.com" ] }, "schema": { "additionalProperties": false, "description": "Proxy zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-name-list.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Successful operation.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk proxy zone delete request", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-delete-requests.yaml", "path-info": "/proxies/{proxyId}/zones/delete-requests" } }, "/proxies/{proxyId}/zones/delete-requests/results": { "get": { "description": "Retrieves the results for all requests for a given proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-result" }, "operationId": "get-proxy-zones-delete-requests-result", "parameters": [ { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.yaml" } }, { "description": "Returns only completed requests.", "example": "{{isComplete}}", "in": "query", "name": "isComplete", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/is-complete-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "lastPage": 0, "page": 1, "pageSize": 25, "showAll": false, "totalElements": 2 }, "requests": [ { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, { "expirationDate": "2022-03-03T12:00:00Z", "failureCount": 1, "isComplete": false, "requestId": "d585a642-0849-4b87-8dd9-91afdaf8877a", "successCount": 1, "zonesSubmitted": 1 } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "requests": { "description": "Bulk requests for a proxy.", "items": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } }, "type": "array" } }, "required": [ "metadata", "requests" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxy-zone-requests-response.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get all bulk proxy zone delete results", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-delete-results.yaml", "path-info": "/proxies/{proxyId}/zones/delete-requests/results" } }, "/proxies/{proxyId}/zones/delete-requests/{requestId}": { "get": { "description": "Retrieves the current status of a running or completed request. The `requestId` was returned when the delete request was initiated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-requestid" }, "operationId": "get-proxy-zones-delete-requests-requestid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, "schema": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } } } }, "description": "Successful operation." } }, "summary": "Check bulk proxy zone delete status", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-delete-request.yaml", "path-info": "/proxies/{proxyId}/zones/delete-requests/{requestId}" } }, "/proxies/{proxyId}/zones/delete-requests/{requestId}/result": { "get": { "description": "Retrieves the result from a completed request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-delete-requests-requestid-result" }, "operationId": "get-proxy-zones-delete-requests-requestid-result", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedZones": [ { "failureReason": "ZONE_HAS_TRAFFIC", "zone": "example.org" } ], "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successfullyDeletedZones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Result of a bulk proxy zone delete operation. This object is only available after offline processing has completed.", "properties": { "failedZones": { "description": "Proxy zones that failed to be deleted.", "items": { "additionalProperties": false, "properties": { "failureReason": { "description": "The reason for the proxy zone creation failure. Either `MALFORMED_ZONE`, `INTERNAL_ERROR`, `PROXY_ZONE_DOES_NOT_EXIST`, `ZONE_HAS_TRAFFIC`, `ZONE_DOES_NOT_EXIST` or `PROXY_DOES_NOT_EXIST`.", "enum": [ "ZONE_DOES_NOT_EXIST", "PROXY_DOES_NOT_EXIST", "PROXY_ZONE_DOES_NOT_EXIST", "ZONE_HAS_TRAFFIC", "INTERNAL_ERROR", "MALFORMED_ZONE" ], "type": "string" }, "zone": { "description": "The proxy zone name that failed to be deleted.", "type": "string" } }, "required": [ "zone", "failureReason" ], "type": "object" }, "type": "array" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successfullyDeletedZones": { "description": "Proxy zones that were successfully deleted.", "items": { "type": "string" }, "type": "array" } }, "required": [ "requestId" ], "type": "object", "x-akamai": { "file-path": "schemas/delete-proxy-request-result.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a bulk proxy zone delete result", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-delete-result.yaml", "path-info": "/proxies/{proxyId}/zones/delete-requests/{requestId}/result" } }, "/proxies/{proxyId}/zones/filter-mode-convert/to-all": { "post": { "description": "Converts a proxy zone filter mode to all.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-all" }, "operationId": "post-proxy-zone-manual-filter-mode-convert-all", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "manualFilterNames": [ "a.example.com", "b.example.com", "c.example.com" ], "proxyZones": [ "example.com" ], "tsigKey": { "algorithm": "hmac-md5", "name": "riverTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } }, "schema": { "additionalProperties": false, "description": "Proxy zone convert data.", "properties": { "manualFilterNames": { "description": "Manual filter names.", "items": { "type": "string" }, "type": "array" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-convert-list.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Convert a proxy zone filter mode to all", "tags": [ "Proxy zones filter mode conversion" ] }, "x-akamai": { "file-path": "paths/to-all.yaml", "path-info": "/proxies/{proxyId}/zones/filter-mode-convert/to-all" } }, "/proxies/{proxyId}/zones/filter-mode-convert/to-automatic": { "post": { "description": "Converts a proxy zone filter mode to automatic.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-automatic" }, "operationId": "post-proxy-zone-manual-filter-mode-convert-automatic", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "manualFilterNames": [ "a.example.com", "b.example.com", "c.example.com" ], "proxyZones": [ "example.com" ], "tsigKey": { "algorithm": "hmac-md5", "name": "riverTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } }, "schema": { "additionalProperties": false, "description": "Proxy zone convert data.", "properties": { "manualFilterNames": { "description": "Manual filter names.", "items": { "type": "string" }, "type": "array" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-convert-list.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Convert a proxy zone filter mode to automatic", "tags": [ "Proxy zones filter mode conversion" ] }, "x-akamai": { "file-path": "paths/to-automatic.yaml", "path-info": "/proxies/{proxyId}/zones/filter-mode-convert/to-automatic" } }, "/proxies/{proxyId}/zones/filter-mode-convert/to-manual": { "post": { "description": "Converts a proxy zone filter mode to manual.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-manual" }, "operationId": "post-proxy-zone-manual-filter-mode-convert-manual", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "manualFilterNames": [ "a.example.com", "b.example.com", "c.example.com" ], "proxyZones": [ "example.com" ], "tsigKey": { "algorithm": "hmac-md5", "name": "riverTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } }, "schema": { "additionalProperties": false, "description": "Proxy zone convert data.", "properties": { "manualFilterNames": { "description": "Manual filter names.", "items": { "type": "string" }, "type": "array" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-convert-list.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Convert a proxy zone filter mode to manual", "tags": [ "Proxy zones filter mode conversion" ] }, "x-akamai": { "file-path": "paths/to-manual.yaml", "path-info": "/proxies/{proxyId}/zones/filter-mode-convert/to-manual" } }, "/proxies/{proxyId}/zones/filter-mode-convert/to-none": { "post": { "description": "Converts a proxy zone filter mode to none.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-none" }, "operationId": "post-proxy-zone-manual-filter-mode-convert-none", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "manualFilterNames": [ "a.example.com", "b.example.com", "c.example.com" ], "proxyZones": [ "example.com" ], "tsigKey": { "algorithm": "hmac-md5", "name": "riverTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } }, "schema": { "additionalProperties": false, "description": "Proxy zone convert data.", "properties": { "manualFilterNames": { "description": "Manual filter names.", "items": { "type": "string" }, "type": "array" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-convert-list.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Convert a proxy zone filter mode to none", "tags": [ "Proxy zones filter mode conversion" ] }, "x-akamai": { "file-path": "paths/to-none.yaml", "path-info": "/proxies/{proxyId}/zones/filter-mode-convert/to-none" } }, "/proxies/{proxyId}/zones/keys": { "get": { "description": "Get all proxy zones keys that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-keys" }, "operationId": "get-proxy-zone-keys", "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "lastPage": 0, "page": 1, "pageSize": 25, "totalElements": 3 }, "proxyZones": [ "example.com", "example.net", "example.org" ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "proxyZones": { "description": "Proxy zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "proxyZones" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxy-zone-key-response.yaml" } } } }, "description": "Proxy zones for the key that you own." } }, "summary": "List proxy zone keys", "tags": [ "Proxy zones" ] }, "x-akamai": { "file-path": "paths/proxy-keys.yaml", "path-info": "/proxies/{proxyId}/zones/keys" } }, "/proxies/{proxyId}/zones/{name}": { "get": { "description": "Get a proxy zone that the current user has access to manage by proxy zone name.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name" }, "operationId": "get-proxy-zones-name", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apexAlias": "example.net", "filterMode": "AUTOMATIC", "name": "example.com", "tsigKey": { "algorithm": "hmac-md5", "name": "oceanTsigKeyName", "secret": "4X3EFiEHavHcE08ghN47jQ==" } }, "schema": { "additionalProperties": false, "description": "Edge DNS proxy zone settings. The `tsigKey` is present is for `filterMode` `AUTOMATIC` only and is used for zone transfers.", "properties": { "apexAlias": { "description": "The apex alias of the proxy zone.", "type": "string" }, "filterMode": { "description": "The filter mode type. Either `NONE`, `ALL`, `MANUAL`, or `AUTOMATIC`.", "enum": [ "NONE", "ALL", "MANUAL", "AUTOMATIC" ], "type": "string" }, "name": { "description": "The name of the proxy zone.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } } }, "required": [ "name", "filterMode" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-post.yaml" } } } }, "description": "A proxy zone that you own." } }, "summary": "Get a proxy zone by name", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/name.yaml", "path-info": "/proxies/{proxyId}/zones/{name}" } }, "/proxies/{proxyId}/zones/{name}/apex-alias": { "put": { "description": "Save the apex alias for a proxy zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-proxy-zone-apex-alias" }, "operationId": "put-proxy-zone-apex-alias", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "apexAlias": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS proxy zones apex alias record.", "properties": { "apexAlias": { "description": "An Edge DNS proxy zones apex alias record.", "example": "{{apexAlias}}", "type": "string" } }, "required": [ "apexAlias" ], "type": "object", "x-akamai": { "file-path": "schemas/update-proxy-zone-apex-alias-request.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Save the apex alias for a proxy zone", "tags": [ "Proxy zones" ] }, "delete": { "description": "Delete the apex alias for a proxy zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zone-apex-alias" }, "operationId": "delete-proxy-zone-apex-alias", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Delete apex alias for a proxy zone", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-zone-apex-alias.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/apex-alias" } }, "/proxies/{proxyId}/zones/{name}/key": { "get": { "description": "Get a TSIG key for a proxy zone that the current user has access to manage by proxy zone name.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name-key" }, "operationId": "get-proxy-zones-name-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "schema": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } } }, "description": "A proxy zone TSIG key that you own." } }, "summary": "Get a proxy zone TSIG key by name", "tags": [ "Proxy zones" ] }, "put": { "description": "Update the proxy zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-proxy-zones-name-key" }, "operationId": "put-proxy-zones-name-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "schema": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "example": "{{algorithm}}", "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "example": "{{name}}", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "example": "{{secret}}", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Update a proxy zone TSIG key by name", "tags": [ "Proxy zones" ] }, "delete": { "description": "Delete a TSIG key for a proxy zone that the current user has access to manage by proxy zone name.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zones-name-key" }, "operationId": "delete-proxy-zones-name-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Delete a proxy zone TSIG key by name", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-key.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/key" } }, "/proxies/{proxyId}/zones/{name}/key/used-by": { "get": { "description": "List proxies that use a TSIG key.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxies-key-used-by" }, "operationId": "get-proxies-key-used-by", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "activationState": "ACTIVE", "authorities": [ "192.0.2.161", "2001:db8:6b4e:3234:365e:6afe:54d6:9b32" ], "authoritiesDnsNames": [ "c1-25.akashield.net", "c2-30.akashield.net" ], "contractId": "C-0N7RAC7", "createdTime": "2024-12-20T00:00:00Z", "healthCheck": { "recordName": "example.com", "recordType": "SOA" }, "id": "dc33c6bf-801c-577d-b6f7-d9a058eaa7db", "lastModifiedTime": "2024-12-24T00:00:00Z", "name": "Rivers Shields", "originNameserverZoneTransferTargets": [ "192.0.2.167", "192.0.2.254" ], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [ { "name": "192.0.2.167", "port": 53 }, { "name": "192.0.2.254", "port": 53 } ] }, { "activationState": "NEW", "authorities": [], "contractId": "C-0N7RAC71", "createdTime": "2024-12-18T00:00:00Z", "healthCheck": { "recordName": "example.net", "recordType": "TXT" }, "id": "6ef0340d-5b93-4a9a-8fc3-0f3ba26f7443", "lastModifiedTime": "2024-12-18T00:00:00Z", "name": "Oceans Proxy", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.135", "port": 443 } ], "zoneTransferNameservers": [] } ] }, "schema": { "additionalProperties": false, "properties": { "items": { "description": "Proxies response.", "items": { "additionalProperties": false, "description": "A Proxy.", "properties": { "activationState": { "description": "__Read-only__ The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "readOnly": true, "type": "string" }, "authorities": { "description": "__Read-only__ The authoritative service IPs set by Akamai. Any changes you make to `authorities` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "authoritiesDnsNames": { "description": "__Read-only__ NS records for the the authoritative service IPs set by Akamai. Any changes you make to `authoritiesDnsNames` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "id": { "description": "The proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers for `AUTOMATIC` filter mode. The default value is the `originNameservers` section.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "name", "contractId", "originNameservers", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post.yaml" } }, "type": "array" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxies-response.yaml" } } } }, "description": "Proxies using a TSIG key." } }, "summary": "List proxies for a TSIG key", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-used-by.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/key/used-by" } }, "/proxies/{proxyId}/zones/{name}/manual-filter-names": { "get": { "description": "Get manual filter report for a proxy zone that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-manual-filter-report" }, "operationId": "get-proxy-zone-manual-filter-report", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "manualFilterNames": [ "a.example.com", "b.example.com", "c.example.com" ], "metadata": { "lastPage": 0, "page": 1, "pageSize": 25, "totalElements": 3 } }, "schema": { "additionalProperties": false, "description": "An Edge DNS proxy zone manual config report.", "properties": { "manualFilterNames": { "description": "Proxy zone manual config entities.", "items": { "type": "string" }, "type": "array" }, "metadata": { "description": "Information about the request.", "type": "object" } }, "required": [ "metadata", "manualFilterNames" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-manual-filter-report.yaml" } } } }, "description": "A proxy zone manual config entries that you own." } }, "summary": "Get a manual filter report", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/manual-filter-names.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/manual-filter-names" } }, "/proxies/{proxyId}/zones/{name}/manual-filter-names/manage": { "post": { "description": "Manage manual filter entries for a proxy zone that the current user has access to manage.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names" }, "operationId": "post-proxy-zone-manual-filter-names", "parameters": [ { "description": "Whether the API should skip manual config entities that currently exist and were requested to add. If set to `false`, a Conflict Exception will be returned.", "example": "{{addSkipExisting}}", "in": "query", "name": "addSkipExisting", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/add-skip-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "delete": [ "z.example.com", "y.example.com", "x.example.com" ], "add": [ "a.example.com", "b.example.com" ] }, "schema": { "additionalProperties": false, "description": "An Edge DNS proxy zone manual config entries to add and delete.", "properties": { "delete": { "description": "Proxy zone manual config entities to delete.", "items": { "type": "string" }, "type": "array" }, "add": { "description": "Proxy zone manual config entities to add.", "items": { "type": "string" }, "type": "array" } }, "required": [ "add", "delete" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-manual-filter-list.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "addCount": 72, "addSkipped": [ "a.example.com", "b.example.com", "c.example.com" ], "deleteCount": 5 }, "schema": { "additionalProperties": false, "description": "An Edge DNS proxy zone manual config list report.", "properties": { "addCount": { "description": "Number of manual filter names that were added. The `addSkipped` filter shows names you requested to add but already exist.", "type": "integer" }, "addSkipped": { "description": "Proxy zone manual config entities that were skipped because they already exist.", "items": { "type": "string" }, "type": "array" }, "deleteCount": { "description": "Number of manual filter names that were deleted.", "type": "integer" } }, "required": [ "addCount", "deleteCount", "addSkipped" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-manual-filter-list-report.yaml" } } } }, "description": "A proxy zone's manual config entry data on what was added, removed or skipped from being added as they already exist." }, "400": { "content": { "application/problem+json": { "example": { "contractId": "K-0N7RAK7", "detail": "You have reached the limit on the number of manual configs that can be created for this proxy zone on that contract.", "instance": "f804a623-444c-4e4f-a719-2190313b99d7", "maximumManualConfigs": 10000, "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "proxyId": 1, "status": 400, "title": "Too Many Manual Configs", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/tooManyManualConfigs" }, "schema": { "additionalProperties": true, "description": "An Edge DNS proxy zone manual config list report limit error.", "properties": { "contractId": { "description": "Contract that this occurred on.", "type": "string" }, "detail": { "description": "Detailed description of the error.", "type": "string" }, "instance": { "description": "Error instance.", "type": "string" }, "maximumManualConfigs": { "description": "Maximum allowed manual config entries on the contract for a given proxy zone.", "type": "integer" }, "problemId": { "description": "Problem instance ID.", "type": "string" }, "proxyId": { "description": "id", "type": "integer" }, "status": { "description": "HTTP error status.", "type": "integer" }, "title": { "description": "Error name.", "type": "string" }, "type": { "description": "A non-navigable URI that identifies each error case.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/filter-list-report-too-many-400.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/edge-dns/reference/400). The submitted proxy zone's manual config entry data that was added or removed increased passed the limit allowed for the proxy zone.", "x-akamai": { "file-path": "errors/400-proxy.yaml" } } }, "summary": "Manage manual filter names", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/manage.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/manual-filter-names/manage" } }, "/proxies/{proxyId}/zones/{name}/manual-filter-names/zone-file": { "post": { "description": "Initializes manual filter names for a proxy zone. Use [Manage manual filter names operation](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names) to update a proxy zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names-file" }, "operationId": "post-proxy-zone-manual-filter-names-file", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "text/dns": { "example": "\nexample.com. 10000 IN SOA ns1.akamaidns.com. webmaster.example.com. 1 28800 14400 2419200 86400\nexample.com. 10000 IN NS ns1.akamaidns.com.\nexample.com. 10000 IN NS ns2.akamaidns.com.\nexample.com. 300 IN A 10.0.0.1\nexample.com. 300 IN A 10.0.0.2\nwww.example.com. 300 IN A 10.0.0.1\nwww.example.com. 300 IN A 10.0.0.2", "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "addCount": 72, "addSkipped": [ "a.example.com", "b.example.com", "c.example.com" ], "deleteCount": 5 }, "schema": { "additionalProperties": false, "description": "An Edge DNS proxy zone manual config list report.", "properties": { "addCount": { "description": "Number of manual filter names that were added. The `addSkipped` filter shows names you requested to add but already exist.", "type": "integer" }, "addSkipped": { "description": "Proxy zone manual config entities that were skipped because they already exist.", "items": { "type": "string" }, "type": "array" }, "deleteCount": { "description": "Number of manual filter names that were deleted.", "type": "integer" } }, "required": [ "addCount", "deleteCount", "addSkipped" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-zone-manual-filter-list-report.yaml" } } } }, "description": "A proxy zone's manual config entry data on what was added, removed or skipped from being added as they already exist." } }, "summary": "Initialize manual filter names with a zone file", "tags": [ "Proxy zones" ] }, "parameters": [ { "description": "The proxy ID you're working with.", "example": "{{proxyId}}", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "The proxy zone name.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-zone-file.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/manual-filter-names/zone-file" } }, "/zones": { "post": { "description": "Creates a new zone. Carefully review the documentation for which fields are relevant to the type of zone you're creating.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zone" }, "operationId": "post-zone", "parameters": [ { "description": "The contract to use for the new zone.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-query.yaml" } }, { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "category": "general", "comment": "adding a single new zone with zto", "contractId": "K-0N7RAK71", "lastActivationDate": "2023-11-06T14:29:48.743796Z", "lastModifiedBy": "adevi", "lastModifiedDate": "2023-11-06T14:29:37.802253Z", "multiProviderDnssec": { "enabled": true, "webhook": "https://example.url/akamai_webhook" }, "outboundZoneTransfer": { "ACL": [ "192.0.2.156/24", "2001:db8:69e:6c67:506d:ae87:fed8:23a1/32" ], "enabled": true, "notifyTargets": [ "192.0.2.192", "2001:db8:5577:c820:205:5d81:d7c4:389d" ], "tsigKey": { "algorithm": "hmac-md5", "name": "other.com.akamai.com3", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" } }, "signAndServe": true, "signAndServeAlgorithm": "ECDSA_P256_SHA256", "subzoneGrants": false, "type": "PRIMARY", "versionId": "c101efcc-1bff-4d6d-9566-0471af6bfba6", "zone": "zto_emea.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "example": "{{category}}", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "example": "{{comment}}", "type": "string" }, "contractId": { "description": "The contract for this zone.", "example": "{{contractId}}", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "example": "{{endCustomerId}}", "type": "string" }, "lastActivationDate": { "description": "PRIMARY and SECONDARY zones only. An ISO 8601 timestamp showing when the latest version was activated.", "example": "{{lastActivationDate}}", "format": "date-time", "type": "string" }, "lastModifiedBy": { "description": "The user that last edited this zone.", "example": "{{lastModifiedBy}}", "type": "string" }, "lastModifiedDate": { "description": "ISO 8601 timestamp marking when zone's last modification.", "example": "{{lastModifiedDate}}", "format": "date-time", "type": "string" }, "masters": { "description": "For `SECONDARY` zones only. The names or addresses of the customer's name servers that the zone data should be retrieved from.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "For `PRIMARY` and `SECONDARY` zones only. Indicates whether DNSSEC Sign&Serve enabled.", "example": "{{signAndServe}}", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "example": "{{signAndServeAlgorithm}}", "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "example": "{{subzoneGrants}}", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "example": "{{target}}", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "example": "{{type}}", "type": "string" }, "versionId": { "description": "The UUID of the most recently activated version.", "example": "{{versionId}}", "type": "string" }, "zone": { "description": "The name of the zone.", "example": "{{zone}}", "type": "string" } }, "required": [ "zone", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "activationState": "ERROR", "aliasCount": 1, "comment": "Initial add", "contractId": "C-0N7RAC71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "szhang", "lastModifiedDate": "2021-12-11T03:21:00Z", "masters": [ "192.0.2.200", "192.0.2.200" ], "signAndServe": false, "tsigKey": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "type": "SECONDARY", "versionId": "7949b2db-ac43-4773-a3ec-dc93202142fd", "zone": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Create a zone", "tags": [ "Zones" ] }, "get": { "description": "All zones that the current user has access to manage. The response is [paginated](https://techdocs.akamai.com/edge-dns/reference/use-pagination).", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones" }, "operationId": "get-zones", "parameters": [ { "description": "Limits the list to those zones belonging to the specified contracts.", "example": "{{contractIds}}", "in": "query", "name": "contractIds", "schema": { "example": "C-0N7RAC7,K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-ids-zones-query.yaml" } }, { "description": "Limits the list to those zones whose name matches the specified search string.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/search-zones-query.yaml" } }, { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Sorting is ignored if used with `showAll` parameter. Valid sort keys include `zone`, `contractId`, `comment`, `endCustomerId`, `lastModifiedDate`, and `lastActivatedDate`.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "-contractId", "zone" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-zones-query.yaml" } }, { "description": "If included, limits the Edge DNS zones where `subzoneGrants` matches the specified boolean. Refer to [Subzone grants](https://techdocs.akamai.com/edge-dns/reference/subzone-grants) for more information.", "example": "{{subzoneGrants}}", "in": "query", "name": "subzoneGrants", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/subzone-grant-query.yaml" } }, { "description": "Limits the list to one or more Edge DNS zone types. Specify any combination of `PRIMARY`, `SECONDARY`, and `ALIAS` values.", "example": "{{types}}", "explode": false, "in": "query", "name": "types", "schema": { "example": [ "PRIMARY", "ALIAS" ], "items": { "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/types-zones-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.yaml" } }, { "description": "Limits the list to zones in the specified activation states. Specify any combination of `ACTIVE`, `NEW`, `PENDING`, `LOCKED`, and `ERROR` values.", "example": "{{activationStates}}", "explode": false, "in": "query", "name": "activationStates", "schema": { "example": [ "ACTIVE", "PENDING" ], "items": { "enum": [ "ACTIVE", "NEW", "PENDING", "LOCKED", "ERROR" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/activation-states-query.yaml" } }, { "description": "Limits the list to zones with the specified DNSSEC status. Specify any combination of `valid`, `warning`, and `error` values.", "example": "{{dnsSecStatus}}", "explode": false, "in": "query", "name": "dnsSecStatus", "schema": { "example": [ "valid", "warning" ], "items": { "enum": [ "valid", "warning", "error" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/dns-sec-status-query.yaml" } }, { "description": "Limits the list to zones matching the specified zone transfer status. Specify any combination of `success`, `warning`, `failure`, and `pending` values.", "example": "{{transferStatus}}", "explode": false, "in": "query", "name": "transferStatus", "schema": { "example": [ "success", "pending" ], "items": { "enum": [ "success", "warning", "failure", "pending" ], "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/transfer-status-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "contractIds": [ "C-0N7RAC7" ], "page": 1, "pageSize": 3, "showAll": false, "totalElements": 17 }, "zones": [ { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "K-0N7RAK71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "jdupont", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": false, "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, { "activationState": "ACTIVE", "contractId": "K-0N7RAK71", "lastModifiedBy": "jsmith", "lastModifiedDate": "2021-05-21T19:45:00Z", "target": "example.com", "type": "ALIAS", "versionId": "19f38d0d-d8cb-4ac1-a7c9-ab8d82d8ca06", "zone": "example.com" }, { "activationState": "ERROR", "aliasCount": 1, "comment": "Initial add", "contractId": "K-0N7RAK71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "jperez", "lastModifiedDate": "2021-12-11T03:21:00Z", "masters": [ "192.0.2.215", "192.0.2.37" ], "signAndServe": false, "tsigKey": { "algorithm": "hmac-sha512", "name": "other.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "type": "SECONDARY", "versionId": "7949b2db-ac43-4773-a3ec-dc93202142fd", "zone": "example.net" } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "zones": { "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "items": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } }, "type": "array" } }, "required": [ "metadata", "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-response.yaml" } } } }, "description": "Zones that you own." } }, "summary": "List zones", "tags": [ "Zones" ] }, "x-akamai": { "file-path": "paths/zones.yaml", "path-info": "/zones" } }, "/zones/convert-requests": { "get": { "description": "Search convert requests.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests" }, "operationId": "get-zones-convert-requests", "parameters": [ { "description": "Returns only completed requests.", "example": "{{isComplete}}", "in": "query", "name": "isComplete", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/is-complete-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "page": 1, "pageSize": 3, "showAll": false, "totalElements": 2 }, "requests": [ { "expirationDate": "2021-01-05T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "d785a640-0849-4b87-8dd9-91afdaf8852b", "successCount": 4, "zonesSubmitted": 5 }, { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 } ] }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone conversion request.", "properties": { "metadata": { "description": "Metadata containing information about the bulk conversion request.", "type": "object" }, "requests": { "description": "A list of individual zone conversion request statuses included in the bulk operation.", "items": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } }, "type": "array" } }, "required": [ "metadata", "requests" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-convert-request-response.yaml" } } } }, "description": "List of bulk convert requests", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Search bulk zone convert requests", "tags": [ "Convert requests" ] }, "x-akamai": { "file-path": "paths/zone-convert-requests.yaml", "path-info": "/zones/convert-requests" } }, "/zones/convert-requests/alias": { "post": { "description": "Submits a request to convert one or more zones to alias asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to convert to an alias zone. All zones are converted on the same contract and group. An offline task converts the zones. You can use the response's `requestId` to check the task's status and view its results once it completes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-alias-requests" }, "operationId": "post-zones-convert-alias-requests", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Converting to alias because it fits our model better", "targetZoneName": "example.org", "zoneList": [ { "name": "example.com", "soaSerialLock": 2020164329 }, { "name": "example.net", "soaSerialLock": 2024164328 } ] }, "schema": { "additionalProperties": false, "description": "A request to convert multiple alias zones at once.", "properties": { "comment": { "description": "Optional user-defined comment describing the conversion request.", "example": "{{comment}}", "type": "string" }, "targetZoneName": { "description": "The name of the target zone to which the alias will point.", "example": "{{targetZoneName}}", "type": "string" }, "zoneList": { "description": "Edge DNS zones to convert.", "items": { "additionalProperties": false, "description": "An Edge DNS zone convert", "properties": { "name": { "description": "The domain name of the DNS zone name to convert.", "type": "string" }, "soaSerialLock": { "description": "The serial number from the zone's SOA record. This value needs to match the current SOA serial you retrieve to ensure consistency and prevent conflicts during the conversion.", "type": "integer" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-convert-primary-post.yaml" } }, "type": "array" } }, "required": [ "zoneList", "targetZoneName" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-alias-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Resource successfully created.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk zone convert alias request", "tags": [ "Convert requests" ] }, "x-akamai": { "file-path": "paths/zone-convert-alias-requests.yaml", "path-info": "/zones/convert-requests/alias" } }, "/zones/convert-requests/primary": { "post": { "description": "Submits an asynchronous request to convert one or more DNS zones to primary. The request body must be a JSON array, where each object provides the required data for converting a zone. All zones included in the request must belong to the same contract and group. The conversion is performed as an offline task. Use the requestId returned in the response to track the task\u2019s progress and retrieve the results upon completion.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-primary-requests" }, "operationId": "post-zones-convert-primary-requests", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Converting to primary because it fits our model better", "zoneList": [ { "name": "example.com", "soaSerialLock": 2020164329 }, { "name": "example.net", "soaSerialLock": 2024164328 } ] }, "schema": { "additionalProperties": false, "description": "Request body schema for converting multiple primary zones in a single operation.", "properties": { "comment": { "description": "Optional user-defined comment describing the conversion request.", "example": "{{comment}}", "type": "string" }, "zoneList": { "description": "A list of Edge DNS zones to be converted to primary.", "items": { "additionalProperties": false, "description": "An Edge DNS zone convert", "properties": { "name": { "description": "The domain name of the DNS zone name to convert.", "type": "string" }, "soaSerialLock": { "description": "The serial number from the zone's SOA record. This value needs to match the current SOA serial you retrieve to ensure consistency and prevent conflicts during the conversion.", "type": "integer" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-convert-primary-post.yaml" } }, "type": "array" } }, "required": [ "zoneList" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-primary-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Resource successfully created.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk zone convert primary request", "tags": [ "Convert requests" ] }, "x-akamai": { "file-path": "paths/zone-convert-primary-requests.yaml", "path-info": "/zones/convert-requests/primary" } }, "/zones/convert-requests/secondary": { "post": { "description": "Submits an asynchronous request to convert one or more DNS zones to secondary. The request body must be a JSON array, with each object containing the required data for the conversion. All zones must belong to the same contract and group. The conversion is handled by an offline task. Use the `requestId` returned in the response to monitor the task's progress and retrieve the results when complete.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-secondary-requests" }, "operationId": "post-zones-convert-secondary-requests", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Converting to secondary because it fits our model better", "masters": [ "192.0.2.10", "my.example.com" ], "tsigKey": { "algorithm": "hmac-md5", "name": "other.com.akamai.com3", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "zoneList": [ { "name": "example.com", "soaSerialLock": 2020164329 }, { "name": "example.net", "soaSerialLock": 2024164328 } ] }, "schema": { "additionalProperties": false, "description": "Request body schema for converting multiple zones to secondary in a single operation.", "properties": { "comment": { "description": "Optional user-defined comment describing the conversion request.", "example": "{{comment}}", "type": "string" }, "masters": { "description": "A list of master name server hostnames or IP addresses from which the zone data should be transferred.", "items": { "type": "string" }, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } }, "zoneList": { "description": "A list of Edge DNS zones to be converted to secondary.", "items": { "additionalProperties": false, "description": "An Edge DNS zone convert", "properties": { "name": { "description": "The domain name of the DNS zone name to convert.", "type": "string" }, "soaSerialLock": { "description": "The serial number from the zone's SOA record. This value needs to match the current SOA serial you retrieve to ensure consistency and prevent conflicts during the conversion.", "type": "integer" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-convert-primary-post.yaml" } }, "type": "array" } }, "required": [ "zoneList", "masters" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-secondary-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Resource successfully created.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk zone convert secondary request", "tags": [ "Convert requests" ] }, "x-akamai": { "file-path": "paths/zone-convert-secondary-requests.yaml", "path-info": "/zones/convert-requests/secondary" } }, "/zones/convert-requests/serials": { "post": { "description": "Submits a request to retrieve SOA serial numbers for secondary zones only. If a serial number cannot be retrieved from the back end for a given zone, the corresponding zone/soaSerialLock object will be omitted from the response list.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-convert-serials-requests" }, "operationId": "post-zones-convert-serials-requests", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "zones": [ "zone.example.com", "zone.example.net" ] }, "schema": { "additionalProperties": false, "description": "A request to list of SOA serials for secondary zones.", "properties": { "zones": { "description": "zone names", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-serials-post.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "soaSerialLocks": [ { "name": "zone.example.com", "soaSerialLock": 123456 }, { "name": "zone.example.net", "soaSerialLock": 567890 } ] }, "schema": { "additionalProperties": false, "description": "SoaSerialSummaryResponse for secondary zones.", "properties": { "soaSerialLocks": { "description": "The SOA serial number for the zone. This value must be present in the SOA record retrieved from the user.", "items": { "additionalProperties": false, "description": "An Edge DNS zone convert", "properties": { "name": { "description": "The domain name of the DNS zone name to convert.", "type": "string" }, "soaSerialLock": { "description": "The serial number from the zone's SOA record. This value needs to match the current SOA serial you retrieve to ensure consistency and prevent conflicts during the conversion.", "type": "integer" } }, "required": [ "name" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-convert-primary-post.yaml" } }, "type": "array" } }, "required": [ "soaSerialLocks" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-serials.yaml" } } } }, "description": "A list of SOA serial numbers successfully retrieved for Secondary Zones.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "List SOA serials for secondary zones", "tags": [ "Convert requests" ] }, "x-akamai": { "file-path": "paths/zone-convert-serials-requests.yaml", "path-info": "/zones/convert-requests/serials" } }, "/zones/convert-requests/{requestId}": { "get": { "description": "Retrieves the current status of a running or completed zone conversion request. The `requestId` is returned when the conversion request is initiated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests-requestid" }, "operationId": "get-zones-convert-requests-requestid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, "schema": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } } } }, "description": "Successful operation." } }, "summary": "Check bulk zone convert status", "tags": [ "Convert requests" ] }, "parameters": [ { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-convert-request.yaml", "path-info": "/zones/convert-requests/{requestId}" } }, "/zones/convert-requests/{requestId}/result": { "get": { "description": "Retrieves the results from a completed request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests-requestid-result" }, "operationId": "get-zones-convert-requests-requestid-result", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedZones": [ { "failureReason": "SOA_SERIAL_LOCK_MISMATCH", "zone": "example.org" } ], "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successfullyConvertedZones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Result of a bulk zone conversion operation. This object is available only after offline processing has completed.", "properties": { "failedZones": { "description": "A list of zones that failed to convert.", "items": { "additionalProperties": false, "properties": { "failureReason": { "description": "The reason the zone conversion failed. For a complete list of possible values, refer to [Zone convert failure reasons](https://techdocs.akamai.com/edge-dns/reference/zone-convert-failure-vals).", "enum": [ "SOA_SERIAL_LOCK_MISMATCH", "INVALID_TARGET_ZONE_TYPE", "INVALID_SOURCE_ZONE_TYPE", "ZONE_NOT_FOUND", "ZONE_NOT_TRANSFERRED", "INTERNAL_ERROR", "INVALID_CONVERT_REQUEST", "EXHAUSTED_ALL_RETRIES", "EXPIRED_REQUEST", "MALFORMED_RECORDSETS", "INVALID_TARGET_ZONE_NAME", "INVALID_RECORDSETS_ZONE_NAME", "UNEXPECTED_CONVERT_FAILURE", "INTERNAL_CONVERSION_FAILURE" ], "type": "string" }, "zone": { "description": "The name of a zone that failed to convert.", "type": "string" } }, "required": [ "zone", "failureReason" ], "type": "object" }, "type": "array" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successfullyConvertedZones": { "description": "A list of zone names that were successfully converted.", "items": { "type": "string" }, "type": "array" } }, "required": [ "requestId" ], "type": "object", "x-akamai": { "file-path": "schemas/convert-request-result.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get bulk zone convert results", "tags": [ "Convert requests" ] }, "parameters": [ { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-convert-result.yaml", "path-info": "/zones/convert-requests/{requestId}/result" } }, "/zones/create-requests": { "post": { "description": "Submits a request to create one or more new Zones asynchronously. The request body contains a JSON array. Each object in the array contains the data necessary to create a zone. All zones are created on the same contract and group. An offline task creates the new zones. You can use the response's `requestId` to check the task's status and view its results once it completes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-create-requests" }, "operationId": "post-zones-create-requests", "parameters": [ { "description": "The contract to use for the new zone.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-query.yaml" } }, { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "zones": [ { "comment": "Adding bodies of water", "masters": [ "192.0.2.20", "192.0.2.91" ], "type": "SECONDARY", "zone": "example.com" }, { "comment": "Adding bodies of water", "masters": [ "192.0.2.245", "192.0.2.208" ], "type": "SECONDARY", "zone": "example.net" }, { "comment": "Adding bodies of water", "masters": [ "192.0.2.69", "192.0.2.62" ], "type": "SECONDARY", "zone": "example.org" } ] }, "schema": { "additionalProperties": false, "description": "A request to create multiple zones at once.", "properties": { "zones": { "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "items": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "PRIMARY and SECONDARY zones only. An ISO 8601 timestamp showing when the latest version was activated.", "format": "date-time", "type": "string" }, "lastModifiedBy": { "description": "The user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "ISO 8601 timestamp marking when zone's last modification.", "format": "date-time", "type": "string" }, "masters": { "description": "For `SECONDARY` zones only. The names or addresses of the customer's name servers that the zone data should be retrieved from.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "For `PRIMARY` and `SECONDARY` zones only. Indicates whether DNSSEC Sign&Serve enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The UUID of the most recently activated version.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-post.yaml" } }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/create-request-post.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Resource successfully created.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk zone create request", "tags": [ "Create requests" ] }, "x-akamai": { "file-path": "paths/zone-create-requests.yaml", "path-info": "/zones/create-requests" } }, "/zones/create-requests/{requestId}": { "get": { "description": "Retrieves the current status of a running or completed request. The `requestId` was returned when the create request was initiated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-create-requests-requestid" }, "operationId": "get-zones-create-requests-requestid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, "schema": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } } } }, "description": "Successful operation." } }, "summary": "Check bulk zone create status", "tags": [ "Create requests" ] }, "parameters": [ { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-create-request.yaml", "path-info": "/zones/create-requests/{requestId}" } }, "/zones/create-requests/{requestId}/result": { "get": { "description": "Retrieves the results from a completed request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-create-requests-requestid-result" }, "operationId": "get-zones-create-requests-requestid-result", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedZones": [ { "failureReason": "ZONE_ALREADY_EXISTS", "zone": "example.org" } ], "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successfullyCreatedZones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Result of a bulk zone create operation. This object is only available after offline processing has completed.", "properties": { "failedZones": { "description": "Zones that failed to be created.", "items": { "additionalProperties": false, "properties": { "failureReason": { "description": "A value describing why zone creation failed. For a complete list of values, refer to [Zone create failure reasons](https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals)", "enum": [ "ZONE_ALREADY_EXISTS", "ZONE_TYPE_NOT_ALLOWED", "ZONE_LIMIT_EXCEEDED", "MALFORMED_ZONE", "ALIAS_TARGET_NOT_PROPAGATED", "SUBZONE_CHECK_FAILED", "GTM_CONFLICT", "INTERNAL_ERROR" ], "type": "string" }, "zone": { "description": "The name of a zone that failed to be created.", "type": "string" } }, "required": [ "zone", "failureReason" ], "type": "object" }, "type": "array" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successfullyCreatedZones": { "description": "The names of all zones that were successfully created.", "items": { "type": "string" }, "type": "array" } }, "required": [ "requestId" ], "type": "object", "x-akamai": { "file-path": "schemas/create-request-result.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get bulk zone create results", "tags": [ "Create requests" ] }, "parameters": [ { "description": "The ID of the request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-create-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-create-result.yaml", "path-info": "/zones/create-requests/{requestId}/result" } }, "/zones/delete-requests": { "post": { "description": "Submits a request to delete one or more new Zones asynchronously. The request body contains a JSON array. Each element in the array is the name of a zone to be deleted. Before deleting a zone from the Edge DNS system, the API makes sure Akamai servers aren't receiving DNS requests for that zone. It also checks that the zone isn't currently delegated to Akamai's name servers. An offline task deletes the new zones. The result of this operation is a `requestId`, which you can use to check the task's status and view its results once it completes.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-delete-requests" }, "operationId": "post-zones-delete-requests", "parameters": [ { "description": "If `true`, disables the delegation checks and deletes the zones as soon as possible. It's `false` by default.", "example": "{{bypassSafetyChecks}}", "in": "query", "name": "bypassSafetyChecks", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/bypass-safety-checks-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c" }, "schema": { "additionalProperties": false, "description": "An identifier for a newly created bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "format": "date-time", "type": "string" }, "requestId": { "description": "The ID of the request.", "type": "string" } }, "required": [ "requestId", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-id.yaml" } } } }, "description": "Successful operation.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Submit a bulk zone delete request", "tags": [ "Delete requests" ] }, "x-akamai": { "file-path": "paths/zone-delete-requests.yaml", "path-info": "/zones/delete-requests" } }, "/zones/delete-requests/{requestId}": { "get": { "description": "Retrieves the current status of a running or completed request. The `requestId` was returned when the delete request was initiated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-delete-requests-requestid" }, "operationId": "get-zones-delete-requests-requestid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "expirationDate": "2021-01-03T12:00:00Z", "failureCount": 1, "isComplete": true, "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successCount": 2, "zonesSubmitted": 3 }, "schema": { "additionalProperties": false, "description": "Status information about a bulk zone operation request.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp, up to which you can query information about this request. After that point, information may be purged and no longer available.", "type": "string" }, "failureCount": { "description": "The number of zones that couldn't be processed.", "minimum": 0, "type": "integer" }, "isComplete": { "description": "If `true`, the offline task has finished processing and the result object can be retrieved.", "type": "boolean" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successCount": { "description": "The number of zones that were successfully processed.", "minimum": 0, "type": "integer" }, "zonesSubmitted": { "description": "The number of zones that were included in the request.", "minimum": 1, "type": "integer" } }, "required": [ "requestId", "zonesSubmitted", "successCount", "failureCount", "isComplete", "expirationDate" ], "type": "object", "x-akamai": { "file-path": "schemas/async-request-status.yaml" } } } }, "description": "Successful operation." } }, "summary": "Check bulk zone delete status", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The ID of the delete request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-delete-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-delete-request.yaml", "path-info": "/zones/delete-requests/{requestId}" } }, "/zones/delete-requests/{requestId}/result": { "get": { "description": "Retrieves the `results` from a completed request.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-delete-requests-requestid-result" }, "operationId": "get-zones-delete-requests-requestid-result", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedZones": [ { "failureReason": "ZONE_DELEGATION_ERROR", "zone": "example.org" } ], "requestId": "e585a640-0849-4b87-8dd9-91afdaf8851c", "successfullyDeletedZones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Result of a bulk zone delete operation. This object is only available after offline processing has completed.", "properties": { "failedZones": { "description": "Zones that failed to be deleted.", "items": { "additionalProperties": false, "properties": { "failureReason": { "description": "The reason for the proxy zone deletion failure. Either `MALFORMED_ZONE`, `INTERNAL_ERROR`, `PROXY_ZONE_LIMIT_EXCEEDED`, `PROXY_ZONE_ALREADY_EXISTS`, or `PROXY_DOES_NOT_EXIST`.", "type": "string" }, "zone": { "description": "The name of a zone that failed to be deleted.", "type": "string" } }, "required": [ "zone", "failureReason" ], "type": "object" }, "type": "array" }, "requestId": { "description": "The ID of the request.", "type": "string" }, "successfullyDeletedZones": { "description": "The names of all zones that were successfully deleted.", "items": { "type": "string" }, "type": "array" } }, "required": [ "requestId" ], "type": "object", "x-akamai": { "file-path": "schemas/delete-request-result.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get bulk zone delete results", "tags": [ "Delete requests" ] }, "parameters": [ { "description": "The ID of the delete request.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/request-id-delete-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-delete-result.yaml", "path-info": "/zones/delete-requests/{requestId}/result" } }, "/zones/dns-sec-status": { "post": { "description": "Returns the current DNSSEC status for one or more zones.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-dns-sec-status" }, "operationId": "post-zones-dns-sec-status", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "dnsSecStatuses": [ { "alerts": [], "currentRecords": { "dnskeyRecord": "example.com. 7200 IN DNSKEY 257 3 8 (xxxxxxxxxxxxxxxxxxxxxxxx)", "dsRecord": "example.com. 86400 IN DS 47539 8 2 (xxxxxxxxxxx)", "expectedTtl": 3600, "lastModifiedDate": "2021-06-02T17:42:35.456Z" }, "zone": "example.com" }, { "alerts": [ "OLD_DNSKEY" ], "currentRecords": { "dnskeyRecord": "example.net. 7200 IN DNSKEY 257 3 8 (xxxxxxxxxxxxxxxxxxxxxxxx)", "dsRecord": "example.net. 86400 IN DS 47539 8 2 (xxxxxxxxxxx)", "expectedTtl": 3600, "lastModifiedDate": "2021-01-15T09:31:36.195Z" }, "newRecords": { "dnskeyRecord": "example.net. 7200 IN DNSKEY 257 3 8 (xxxxxxxxxxxxxxxxxxxxxxxx)", "dsRecord": "example.net. 86400 IN DS 47539 8 2 (xxxxxxxxxxx)", "expectedTtl": 3600, "lastModifiedDate": "2021-04-15T08:00:00.418Z" }, "zone": "example.net" } ] }, "schema": { "additionalProperties": false, "description": "Statuses of DNSSEC configurations for Edge DNS zones.", "properties": { "dnsSecStatuses": { "description": "Statuses of the DNSSEC configuration for Edge DNS zones.", "items": { "additionalProperties": false, "description": "The status of the DNSSEC configuration for an Edge DNS zone.", "properties": { "alerts": { "description": "A set of existing problems with the current DNSSEC configuration, any of these values: `INCOMPATIBLE_AUTHORITIES`, `NON_AKAMAI_AUTHORITIES`, `PARENT_DS_MISSING`, `OLD_DNSKEY`, and `WRONG_DNSKEY`.", "items": { "enum": [ "INCOMPATIBLE_AUTHORITIES", "NON_AKAMAI_AUTHORITIES", "PARENT_DS_MISSING", "OLD_DNSKEY", "WRONG_DNSKEY" ], "type": "string" }, "type": "array" }, "currentRecords": { "additionalProperties": false, "description": "The currently active set of generated DNSSEC records.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "newRecords": { "additionalProperties": false, "description": "The newly generated set of DNSSEC records, if one exists.", "properties": { "dnskeyRecord": { "description": "The generated DNSKEY record for this zone.", "type": "string" }, "dsRecord": { "description": "The generated DS record for this zone.", "type": "string" }, "expectedTtl": { "description": "The TTL on the NS record for this zone. This should match the TTL on the DS or DNSKEY record.", "type": "integer" }, "lastModifiedDate": { "description": "The ISO 8601 timestamp on which these records were generated.", "format": "date-time", "type": "string" } }, "required": [ "dnskeyRecord", "dsRecord", "expectedTtl", "lastModifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-records.yaml" } }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "alerts", "currentRecords" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-status.yaml" } }, "type": "array" } }, "required": [ "dnsSecStatuses" ], "type": "object", "x-akamai": { "file-path": "schemas/dns-sec-status-list.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone's DNSSEC status", "tags": [ "DNSSEC status" ] }, "x-akamai": { "file-path": "paths/dns-sec-status.yaml", "path-info": "/zones/dns-sec-status" } }, "/zones/edit-secondary-zones": { "post": { "description": "Updates settings for one or more secondary zones in a single operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-edit-secondary-zones" }, "operationId": "post-zones-edit-secondary-zones", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "settings": { "comment": "Updating secondary zone masters", "masters": [ "192.0.2.183", "192.0.2.40" ] }, "zones": [ { "versionId": "e89b10b0-a847-11e9-a2a3-2a2ae2dbcce4", "zone": "example.com" } ] }, "schema": { "additionalProperties": false, "properties": { "settings": { "additionalProperties": false, "description": "Secondary zone settings to apply to all listed zones.", "properties": { "comment": { "description": "Free-form comment about the change.", "type": "string" }, "masters": { "description": "List of primary name server IP addresses for zone transfer.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "zones": { "description": "List of secondary zones to edit, each identified by name and current version ID.", "items": { "additionalProperties": false, "properties": { "versionId": { "description": "The current `ETag` version identifier for the zone.", "type": "string" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone", "versionId" ], "type": "object" }, "type": "array" } }, "required": [ "zones", "settings" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-secondary-zone-edit-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "zones": [ { "versionId": "f7da1c90-b958-11e9-b3b4-3b3bf3ecdd5e", "zone": "example.com" } ] }, "schema": { "additionalProperties": false, "properties": { "zones": { "description": "List of zones successfully updated, each with its new version ID.", "items": { "additionalProperties": false, "properties": { "versionId": { "description": "The new `ETag` version identifier for the zone after the update.", "type": "string" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone", "versionId" ], "type": "object" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-secondary-zone-edit-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Bulk edit secondary zones", "tags": [ "Zones" ] }, "x-akamai": { "file-path": "paths/edit-secondary-zones.yaml", "path-info": "/zones/edit-secondary-zones" } }, "/zones/propagation-status": { "post": { "description": "Returns the current propagation status for one or more zones, showing what percentage of name servers have received the latest zone data.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-propagation-status" }, "operationId": "post-zones-propagation-status", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "propagationStatuses": [ { "percentCurrent": 75, "percentInProgress": 20, "percentNotReported": 5, "serial": 2024010101, "zone": "example.com" } ] }, "schema": { "additionalProperties": false, "properties": { "propagationStatuses": { "description": "Propagation status for each requested zone.", "items": { "additionalProperties": false, "properties": { "percentCurrent": { "description": "Percentage of name servers that have the current zone data.", "type": "integer" }, "percentInProgress": { "description": "Percentage of name servers currently receiving zone data.", "type": "integer" }, "percentNotReported": { "description": "Percentage of name servers that have not yet reported their status.", "type": "integer" }, "serial": { "description": "The current SOA serial number for the zone.", "format": "int64", "type": "integer" }, "zone": { "description": "The zone name.", "type": "string" } }, "required": [ "zone" ], "type": "object" }, "type": "array" } }, "required": [ "propagationStatuses" ], "type": "object", "x-akamai": { "file-path": "schemas/propagation-status-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get zone propagation status", "tags": [ "Zones" ] }, "x-akamai": { "file-path": "paths/propagation-status.yaml", "path-info": "/zones/propagation-status" } }, "/zones/zone-transfer-status": { "post": { "description": "Returns the results of the most recent zone transfer attempts for one or more zones. When you configure a `SECONDARY` zone, several Akamai name servers known as zone transfer agents perform zone transfer requests to fetch the record data from the zone's configured master name servers. The data returned by this operation describes the results of those zone transfers.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-transfer-status" }, "operationId": "post-zones-zone-transfer-status", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "example": "{{comment}}", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "zones": [ { "masters": [ { "masterIP": "192.0.2.70", "zoneTransferAgents": [ { "actions": [ { "actionType": "SOA", "lastSuccessSerial": 2019017037, "lastSuccessTimestamp": "2019-01-23T20:47:55Z" }, { "actionType": "XFR", "lastFailureTimestamp": "2019-01-23T20:47:55Z", "messages": [ { "errorCode": "TIMED_OUT", "timestamp": "2021-11-23T20:47:55Z", "tokens": [] }, { "errorCode": "TOO_MANY_RECORDS", "timestamp": "2019-01-23T20:47:55Z", "tokens": [ "2019017001 108163 100000" ] } ] } ], "agentIP": "192.0.2.189", "lastFailureTimestamp": "2021-01-23T20:47:55Z" }, { "actions": [ { "actionType": "SOA", "lastSuccessSerial": 2019017044, "lastSuccessTimestamp": "2019-01-23T20:47:55Z" }, { "actionType": "XFR", "lastFailureTimestamp": "2019-01-17T20:47:55Z", "messages": [ { "errorCode": "TOO_MANY_RECORDS", "timestamp": "2019-01-17T20:47:55Z", "tokens": [ "2019015704 107931 100000" ] }, { "errorCode": "TIMED_OUT", "timestamp": "2021-12-25T20:47:55Z", "tokens": [] } ] } ], "agentIP": "192.0.2.202", "lastFailureTimestamp": "2019-01-17T20:47:55Z" } ] }, { "masterIP": "192.0.2.49", "zoneTransferAgents": [ { "actions": [ { "actionType": "SOA", "lastSuccessSerial": 2019017044, "lastSuccessTimestamp": "2019-01-21T20:47:55Z" }, { "actionType": "XFR", "lastFailureTimestamp": "2019-01-23T20:47:55Z", "messages": [ { "errorCode": "TOO_MANY_RECORDS", "timestamp": "2019-01-23T20:47:55Z", "tokens": [ "2019017044 108173 100000" ] }, { "errorCode": "TIMED_OUT", "timestamp": "2019-01-21T20:47:55Z", "tokens": [] }, { "errorCode": "EOF", "timestamp": "2019-01-17T20:47:55Z", "tokens": [] } ] } ], "agentIP": "192.0.2.126", "lastFailureTimestamp": "2019-01-23T20:47:55Z" }, { "actions": [ { "actionType": "SOA", "lastSuccessSerial": 2019017044, "lastSuccessTimestamp": "2019-01-23T20:47:55Z" }, { "actionType": "XFR", "lastFailureTimestamp": "2019-01-17T20:47:55Z", "messages": [ { "errorCode": "TOO_MANY_RECORDS", "timestamp": "2019-01-17T20:47:55Z", "tokens": [ "2019015768 107946 100000" ] }, { "errorCode": "TIMED_OUT", "timestamp": "2019-01-15T20:47:55Z", "tokens": [] }, { "errorCode": "EOF", "timestamp": "2021-12-10T20:47:55Z", "tokens": [] } ] } ], "agentIP": "192.0.2.98", "lastFailureTimestamp": "2019-01-17T20:47:55Z" } ] } ], "metadata": { "lastFailureTimestamp": "2019-01-14T16:27:02Z", "lastSuccessSerial": 2021042400, "lastSuccessTimestamp": "2019-01-30T22:14:34Z" }, "zone": "example.com" } ] }, "schema": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "zones": { "description": "Statuses of any recent zone transfer attempts for Edge DNS secondary zones.", "items": { "additionalProperties": false, "description": "The status of any recent zone transfer attempts for an Edge DNS secondary zone.", "properties": { "masters": { "description": "Customer name servers that were contacted.", "items": { "additionalProperties": false, "description": "Customer name servers that were contacted.", "properties": { "masterIP": { "description": "__Read-only__ The IP address of the customer name server.", "readOnly": true, "type": "string" }, "zoneTransferAgents": { "description": "__Read-only__ Akamai zone transfer agents that performed zone transfers.", "items": { "additionalProperties": false, "description": "Akamai zone transfer agents that performed zone transfers.", "properties": { "actions": { "description": "__Read-only__ The zone transfer requests performed by the agent.", "items": { "additionalProperties": false, "description": "Actions performed by Akamai zone transfer agents.", "properties": { "actionType": { "description": "__Read-only__ The type of action performed. `SOA` indicates that the agent tried to fetch the SOA record for this zone. `XFR` indicates that the agent attempted to perform a full zone transfer.", "enum": [ "SOA", "XFR" ], "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent failed action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "lastSuccessSerial": { "description": "__Read-only__ If present, the SOA serial of the zone file at the time of the most recent successful retrieval.", "readOnly": true, "type": "integer" }, "lastSuccessTimestamp": { "description": "__Read-only__ If present, the ISO 8601 timestamp indicating when the most recent successful action occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "messages": { "description": "Error messages logged by the zone transfer agents. May contain messages from previous, that isn't the most recent, actions.", "items": { "additionalProperties": true, "properties": { "errorCode": { "description": "__Read-only__ A short identifier for the problem.", "readOnly": true, "type": "string" }, "timestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating when the error occurred.", "format": "date-time", "readOnly": true, "type": "string" }, "tokens": { "description": "__Read-only__ Additional information about the problem.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "errorCode" ], "type": "object" }, "type": "array" } }, "required": [ "actionType" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-action.yaml" } }, "readOnly": true, "type": "array" }, "agentIP": { "description": "__Read-only__ The IP address of the Akamai zone transfer agent.", "readOnly": true, "type": "string" }, "lastFailureTimestamp": { "description": "__Read-only__ The ISO 8601 timestamp indicating the last time a zone transfer failed for this agent.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "agentIP", "actions" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-agent.yaml" } }, "readOnly": true, "type": "array" } }, "required": [ "masterIP", "zoneTransferAgents" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-master.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Information about the most recent successful and failed zone transfer attempt.", "properties": { "lastFailureTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent failed zone transfer occurred.", "format": "date-time", "type": "string" }, "lastSuccessSerial": { "description": "The SOA serial number that was read during the most recent successful zone transfer.", "type": "integer" }, "lastSuccessTimestamp": { "description": "The ISO 8601 timestamp indicating when the most recent successful zone transfer occurred.", "format": "date-time", "type": "string" } }, "type": "object" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "zone", "metadata", "masters" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-transfer-status.yaml" } }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/post-zones-zone-transfer-status-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get secondary zones transfer status", "tags": [ "Zone transfer status" ] }, "x-akamai": { "file-path": "paths/zone-transfer-status.yaml", "path-info": "/zones/zone-transfer-status" } }, "/zones/{zone}": { "get": { "description": "Retrieves the metadata for this zone. Does not include record sets.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone" }, "operationId": "get-zone", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "tyamada", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone's settings", "tags": [ "Zones" ] }, "put": { "description": "Modifies a zone's settings. You can't change the zone `type` with this operation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-zone" }, "operationId": "put-zone", "parameters": [ { "description": "If set to true, skips safety checks when disabling sign and serve.", "example": "{{skipSignAndServeSafetyCheck}}", "in": "query", "name": "skipSignAndServeSafetyCheck", "required": false, "schema": { "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/skip-sign-and-serve-safety-check-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "category": "general", "comment": "adding a single new zone with zto", "contractId": "K-0N7RAK71", "lastActivationDate": "2023-11-06T14:29:48.743796Z", "lastModifiedBy": "adevi", "lastModifiedDate": "2023-11-06T14:29:37.802253Z", "multiProviderDnssec": { "enabled": true, "webhook": "https://example.url/akamai_webhook" }, "outboundZoneTransfer": { "ACL": [ "192.0.2.156/24", "2001:db8:69e:6c67:506d:ae87:fed8:23a1/32" ], "enabled": true, "notifyTargets": [ "192.0.2.192", "2001:db8:5577:c820:205:5d81:d7c4:389d" ], "tsigKey": { "algorithm": "hmac-md5", "name": "other.com.akamai.com3", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" } }, "signAndServe": true, "signAndServeAlgorithm": "ECDSA_P256_SHA256", "subzoneGrants": false, "type": "PRIMARY", "versionId": "c101efcc-1bff-4d6d-9566-0471af6bfba6", "zone": "zto_emea.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "category": { "description": "__Read-only__ The zone category.", "example": "{{category}}", "readOnly": true, "type": "string" }, "comment": { "description": "Free-form user comments.", "example": "{{comment}}", "type": "string" }, "contractId": { "description": "The contract for this zone.", "example": "{{contractId}}", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "example": "{{endCustomerId}}", "type": "string" }, "lastActivationDate": { "description": "__Read-only__ Used for primary and secondary zones only. An ISO 8601 timestamp showing when the latest version was activated.", "example": "{{lastActivationDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The user that last edited this zone.", "example": "{{lastModifiedBy}}", "readOnly": true, "type": "string" }, "lastModifiedDate": { "description": "__Read-only__ ISO 8601 timestamp marking the zone's last modification.", "example": "{{lastModifiedDate}}", "format": "date-time", "readOnly": true, "type": "string" }, "masters": { "description": "For secondary zones only. The names or addresses of the customer's name servers from which the zone data should be retrieved.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "example": "{{signAndServe}}", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`. Absent if no algorithm has ever been assigned to this zone.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "example": "{{signAndServeAlgorithm}}", "type": "string" }, "subzoneGrants": { "description": "Determines if cross-account subzones are enabled. This doesn't impact the ability to create subzones that you're presently authorized to edit.", "example": "{{subzoneGrants}}", "type": "boolean" }, "target": { "description": "For `ALIAS` zones only. The name of the zone whose configuration this zone copies.", "example": "{{target}}", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "example": "{{type}}", "type": "string" }, "versionId": { "description": "__Read-only__ The UUID of the most recently activated version.", "example": "{{versionId}}", "readOnly": true, "type": "string" }, "zone": { "description": "The name of the zone.", "example": "{{zone}}", "type": "string" } }, "required": [ "zone", "type", "signAndServe" ], "type": "object", "x-akamai": { "file-path": "schemas/put-zones-zone-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "tyamada", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Update a zone's settings", "tags": [ "Zones" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone.yaml", "path-info": "/zones/{zone}" } }, "/zones/{zone}/aliases": { "get": { "description": "Show all zones that alias to this zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-aliases" }, "operationId": "get-zone-aliases", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ "example.com", "example.net", "example.org" ] }, "schema": { "additionalProperties": false, "description": "Zone names that alias to this zone.", "properties": { "aliases": { "description": "Zone names.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "aliases" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-zone-aliases-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone's aliases", "tags": [ "Zones" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/aliases.yaml", "path-info": "/zones/{zone}/aliases" } }, "/zones/{zone}/contract": { "get": { "description": "Show data about the contract to which this zone belongs.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-contract" }, "operationId": "get-zone-contract", "parameters": [ { "description": "The currently selected group ID to manage. ", "example": "{{gid}}", "in": "query", "name": "gid", "required": true, "schema": { "example": 12345, "type": "integer" }, "x-akamai": { "file-path": "parameters/group-aware-gid.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "contractId": "K-0N7RAK71", "contractName": "Acme Inc", "contractTypeName": "DIRECT_CUSTOMER", "features": [ "PRIMARY_ZONES", "ALIAS_ZONES", "ZONE_APEX_MAPPING", "FORCE_DELETE" ], "maximumZones": 5000, "permissions": [ "READ", "WRITE", "ADD", "DELETE" ], "zoneCount": 92 }, "schema": { "additionalProperties": false, "description": "A customer contract and associated permissions.", "properties": { "contractId": { "description": "The ID of the contract.", "type": "string" }, "contractName": { "description": "The name of the customer for this contract.", "type": "string" }, "contractTypeName": { "description": "An internal description of the contract type.", "type": "string" }, "features": { "description": "Edge DNS features that you have access to. Possible values are: `ALIAS_ZONES`, `DNSSEC_SELF_SIGN`, `DNSSEC_SIGN_AND_SERVE`, `FORCE_DELETE`, `PRIMARY_ZONES`, `SECONDARY_ZONES`, `SUBZONE_GRANTS` `TLD_ZONES`, or `ZONE_APEX_MAPPING`.", "items": { "enum": [ "ALIAS_ZONES", "DNSSEC_SELF_SIGN", "DNSSEC_SIGN_AND_SERVE", "FORCE_DELETE", "PRIMARY_ZONES", "SECONDARY_ZONES", "ZONE_APEX_MAPPING", "TLD_ZONES", "SUBZONE_GRANTS" ], "type": "string" }, "type": "array" }, "maximumZones": { "description": "The maximum number of zones you're able to create on this contract.", "type": "integer" }, "permissions": { "description": "The Edge DNS permissions that you have on this contract. Possible values are: `READ`, `WRITE`, `ADD`, and `DELETE`.", "items": { "enum": [ "READ", "WRITE", "ADD", "DELETE" ], "type": "string" }, "type": "array" }, "zoneCount": { "description": "The number of zones that currently exist on this contract.", "type": "integer" } }, "required": [ "contractId", "contractName", "contractTypeName", "features", "maximumZones", "permissions", "zoneCount" ], "type": "object", "x-akamai": { "file-path": "schemas/contract-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone's contract", "tags": [ "Zone contracts" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/contract.yaml", "path-info": "/zones/{zone}/contract" } }, "/zones/{zone}/dnskeys": { "get": { "description": "Get the current DNSSEC DNSKEY records for a zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-dnskeys" }, "operationId": "get-zone-dnskeys", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "name": "example.com", "rdata": [ "256 3 8 AwEAAaF40bK10YnjfAwuo3AqoBXVLCrbijcRbptQLOrljkKCPsFQAN5/DoJQl/WG/6c//UGigg8joQGSmU24ttnt/RCGJNDKhzJorOM5h23zjPcfqwp+Dnmzq2/ZHx8C3VU98k1xWuienQo6suJpYUjkBQoyf1oEsviEtWxRa5Pv3i37", "256 3 8 AwEAAbS8P0ymylZm8QfMPc0rBUv9hTdY95JCljnFbfP0g1jV1ym9l7cg13xMwCS/CWGTy6cMUlTI3xejecIzMmEhziXJbuarpzDDP5eG2oli0eXrBfizBLhiSGm5IY31m/SSj9JBnL2m5awcBv+HDWlfEtTebSeUXTySOgNWQKtiL/WB" ], "ttl": 7200, "type": "DNSKEY" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone's DNSSEC DNSKEY records", "tags": [ "DNSSEC keys" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/dnskeys.yaml", "path-info": "/zones/{zone}/dnskeys" } }, "/zones/{zone}/key": { "get": { "description": "Retrieves the TSIG Key data for this zone. Includes a count of zones that use this key. Returns a 404 error if the zone doesn't have a TSIG key.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-key" }, "operationId": "get-zones-zone-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==", "zonesCount": 7 }, "schema": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a zone's TSIG key", "tags": [ "TSIG keys" ] }, "put": { "description": "Creates or replaces the current TSIG Key for this zone. If other zones use the same key, doesn't modify those zones.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-key" }, "operationId": "put-zones-zone-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "algorithm": "hmac-sha512", "name": "example.com.akamai.com.", "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==" }, "schema": { "additionalProperties": false, "description": "A TSIG key.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "example": "{{algorithm}}", "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "example": "{{name}}", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "example": "{{secret}}", "type": "string" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-post.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "The operation was successful. No response data is returned." } }, "summary": "Update a zone's TSIG key", "tags": [ "TSIG keys" ] }, "delete": { "description": "Removes the TSIG Key for this zone. This action doesn't affect any other zone, even if they share the same TSIG key as this zone. If the zone doesn't currently have a key, no actions are taken and no error is thrown.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-zones-zone-key" }, "operationId": "delete-zones-zone-key", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "The operation was successful. No response data is returned." } }, "summary": "Delete a zone's TSIG key", "tags": [ "TSIG keys" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-key.yaml", "path-info": "/zones/{zone}/key" } }, "/zones/{zone}/key/used-by": { "get": { "description": "Lists the Zones that use the same TSIG key as this zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-key-used-by" }, "operationId": "get-zones-zone-key-used-by", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "comment": "Removing rivers and streams.", "zones": [ "example.com", "example.net" ] }, "schema": { "additionalProperties": false, "description": "Zone names.", "properties": { "comment": { "description": "Any comment.", "type": "string" }, "zones": { "description": "Zone names.", "items": { "type": "string" }, "type": "array" } }, "required": [ "zones" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-name-list.yaml" } } } }, "description": "Successful operation." } }, "summary": "List users of a zone's TSIG key", "tags": [ "TSIG keys" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-used-by.yaml", "path-info": "/zones/{zone}/key/used-by" } }, "/zones/{zone}/matching-ds-record-key-tags": { "get": { "description": "Returns the key tag values from DS records in the parent zone that match the zone's current DNSKEY records. Use this to verify DS delegation is correctly configured.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-matching-ds-record-key-tags" }, "operationId": "get-zones-zone-matching-ds-record-key-tags", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "matchingKeyTags": [ 12345, 67890 ] }, "schema": { "additionalProperties": false, "properties": { "matchingKeyTags": { "description": "List of key tag values from DS records that match the zone's current DNSKEY records.", "items": { "type": "integer" }, "type": "array" } }, "required": [ "matchingKeyTags" ], "type": "object", "x-akamai": { "file-path": "schemas/ds-record-key-tag-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get matching DS record key tags", "tags": [ "DNSSEC keys" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-matching-ds-record-key-tags.yaml", "path-info": "/zones/{zone}/matching-ds-record-key-tags" } }, "/zones/{zone}/names": { "get": { "description": "Retrieves record set names for a zone.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-names" }, "operationId": "get-zone-names", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "names": [ "example.com", "www.example.com", "ftp.example.com", "space.example.com", "web.example.com" ] }, "schema": { "additionalProperties": false, "description": "Record names.", "properties": { "names": { "description": "Record names.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "names" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset-name-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List record set names for a zone", "tags": [ "Names" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-names.yaml", "path-info": "/zones/{zone}/names" } }, "/zones/{zone}/names/{name}/types": { "get": { "description": "Lists all *existing* record set types for this name. The types are available at [List record types](https://techdocs.akamai.com/edge-dns/reference/get-record-set-types). If the name doesn't exist within the zone, an empty list is returned.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-name-types" }, "operationId": "get-zone-name-types", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "types": [ "A", "AAAA", "MX" ] }, "schema": { "additionalProperties": false, "description": "Record types.", "properties": { "types": { "description": "Record types.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "types" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset-type-list.yaml" } } } }, "description": "Successful response." } }, "summary": "List record set types for name and zone", "tags": [ "Types" ] }, "parameters": [ { "description": "A domain name, including the parent zone.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "www.example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/name-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-types.yaml", "path-info": "/zones/{zone}/names/{name}/types" } }, "/zones/{zone}/names/{name}/types/{type}": { "post": { "description": "Creates a new Record set with the specified name and type.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-names-name-types-type" }, "operationId": "post-zones-zone-names-name-types-type", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.130", "192.0.2.182" ], "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "example": "{{name}}", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "example": "{{ttl}}", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "example": "{{type}}", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.130", "192.0.2.182" ], "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "description": "Successful operation.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } } }, "summary": "Create a record set", "tags": [ "Record sets" ] }, "get": { "description": "Retrieves a single record set for the zone, record name, and record type specified in the URL.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-name-type" }, "operationId": "get-zone-name-type", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.130", "192.0.2.182" ], "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a record set", "tags": [ "Record sets" ] }, "put": { "description": "Replaces an existing Record set with the request body. The `name` and `type` need to match the existing record.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-names-name-types-type" }, "operationId": "put-zones-zone-names-name-types-type", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.130", "192.0.2.182" ], "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "example": "{{name}}", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "example": "{{ttl}}", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "example": "{{type}}", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "name": "www.example.com", "rdata": [ "192.0.2.130", "192.0.2.182" ], "ttl": 300, "type": "A" }, "schema": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } } } }, "description": "Successful operation." } }, "summary": "Replace a record set", "tags": [ "Record sets" ] }, "delete": { "description": "Removes an existing record set.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/delete-zone-name-type" }, "operationId": "delete-zone-name-type", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Successful response." } }, "summary": "Delete a record set", "tags": [ "Record sets" ] }, "parameters": [ { "description": "The record set type.", "example": "{{type}}", "in": "path", "name": "type", "required": true, "schema": { "example": "A", "type": "string" }, "x-akamai": { "file-path": "parameters/type-path.yaml" } }, { "description": "A domain name, including the parent zone.", "example": "{{name}}", "in": "path", "name": "name", "required": true, "schema": { "example": "www.example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/name-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-type.yaml", "path-info": "/zones/{zone}/names/{name}/types/{type}" } }, "/zones/{zone}/recordsets": { "post": { "description": "Creates multiple new record sets on this Zone. If any record set fails to create, for example, because a record set with that name and type already exists, the entire operation fails.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-recordsets" }, "operationId": "post-zones-zone-recordsets", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "recordsets": [ { "name": "new.example.com", "rdata": [ "www.example.com" ], "ttl": 300, "type": "CNAME" } ] }, "schema": { "additionalProperties": false, "description": "One or more record sets.", "properties": { "recordsets": { "description": "A set of one or more resource records that share the same name, type, and TTL.", "items": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } }, "minItems": 1, "type": "array" } }, "required": [ "recordsets" ], "type": "object", "x-akamai": { "file-path": "schemas/post-zones-zone-recordsets-request.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Create record sets", "tags": [ "Record sets" ] }, "get": { "description": "Lists all record sets for this Zone. It works only for `PRIMARY` and `SECONDARY` zones. This operation is [paginated](https://techdocs.akamai.com/edge-dns/reference/use-pagination).", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-recordsets" }, "operationId": "get-zones-zone-recordsets", "parameters": [ { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Allowed fields include `name` and `type`.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "name", "type" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-name-type-query.yaml" } }, { "description": "Displays only record sets that match one of the provided types. Specifies multiple fields as a comma-separated list. Ignores illegal or disallowed record types.", "example": "{{types}}", "explode": false, "in": "query", "name": "types", "schema": { "example": [ "A", "AAAA" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/types-record-sets-query.yaml" } }, { "description": "Displays only record sets whose NAME or RDATA field matches this value. All records with the same name and type are included if any record in the set has a NAME or RDATA that matches the value case-insensitively.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/search-name-rdata-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "page": 1, "pageSize": 25, "totalElements": 2, "types": [ "A" ], "zone": "example.com" }, "recordsets": [ { "name": "www.example.com", "rdata": [ "192.0.2.11", "192.0.2.24" ], "ttl": 300, "type": "A" }, { "name": "mail.example.com", "rdata": [ "192.0.2.245", "192.0.2.117" ], "ttl": 300, "type": "A" } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "additionalProperties": false, "description": "Information about the request.", "properties": { "page": { "description": "Current page.", "minimum": 1, "type": "integer" }, "pageSize": { "description": "The number of results per page.", "minimum": 1, "type": "integer" }, "totalElements": { "description": "The total number of results.", "minimum": 0, "type": "integer" }, "types": { "description": "Reflects the set of record types that were requested.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "zone": { "description": "The name of the zone.", "minLength": 0, "type": "string" } }, "required": [ "zone", "page", "pageSize", "totalElements", "types" ], "type": "object" }, "recordsets": { "description": "One or more record sets.", "items": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } }, "type": "array" } }, "required": [ "metadata", "recordsets" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-zone-versions-uuid-recordsets-response.yaml" } } } }, "description": "Successful operation." } }, "summary": "Get a zone's record sets", "tags": [ "Record sets" ] }, "put": { "description": "Replaces all record sets that currently exist with the list provided.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-recordsets" }, "operationId": "put-zones-zone-recordsets", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "recordsets": [ { "name": "paveldespot.com", "rdata": [ "a33-33.akam.net. hostmaster.akamai.com. 14643123442 43200 7200 604800 7200" ], "ttl": 86400, "type": "SOA" }, { "name": "paveldespot.com", "rdata": [ "example3.paveldespot.net.edgekey.net" ], "ttl": 20, "type": "AKAMAICDN" }, { "name": "paveldespot.com", "rdata": [ "ns222.name.cloud.ibm.com.", "ns111.name.cloud.ibm.com." ], "ttl": 172800, "type": "NS" }, { "name": "api1.paveldespot.com", "rdata": [ "api2.paveldespot.com." ], "ttl": 300, "type": "CNAME" }, { "name": "api2.paveldespot.com", "rdata": [ "api.paveldespot.com." ], "ttl": 300, "type": "CNAME" }, { "name": "api3.paveldespot.com", "rdata": [ "api.paveldespot.com." ], "ttl": 300, "type": "CNAME" }, { "name": "api4.paveldespot.com", "rdata": [ "api.paveldespot.com." ], "ttl": 300, "type": "CNAME" }, { "name": "roubrobin.paveldespot.com", "rdata": [ "192.0.2.54", "192.0.2.69", "192.0.2.213", "192.0.2.8" ], "ttl": 30, "type": "A" } ] }, "schema": { "additionalProperties": false, "description": "One or more record sets.", "properties": { "recordsets": { "description": "A set of one or more resource records that share the same name, type, and TTL.", "items": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } }, "minItems": 1, "type": "array" } }, "required": [ "recordsets" ], "type": "object", "x-akamai": { "file-path": "schemas/post-zones-zone-recordsets-request.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Replace record sets", "tags": [ "Record sets" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-record-sets.yaml", "path-info": "/zones/{zone}/recordsets" } }, "/zones/{zone}/schedule-immediate-transfer": { "put": { "description": "Schedules an immediate zone transfer for the specified secondary zone, bypassing any pending transfer delays.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-schedule-immediate-transfer" }, "operationId": "put-zones-zone-schedule-immediate-transfer", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": {}, "description": "Zone transfer scheduled successfully." } }, "summary": "Schedule an immediate zone transfer", "tags": [ "Zones" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-schedule-transfer.yaml", "path-info": "/zones/{zone}/schedule-immediate-transfer" } }, "/zones/{zone}/versions": { "get": { "description": "Shows the settings for current and prior versions of this Zone, in reverse chronological order of modification. Many versions in this list may look very similar because a new version is created every time the zone's settings or record sets are changed. This operation is [paginated](https://techdocs.akamai.com/edge-dns/reference/use-pagination).", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-versions" }, "operationId": "get-zone-versions", "parameters": [ { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "contractIds": [ "K-0N7RAK71" ], "page": 1, "pageSize": 3, "showAll": false, "totalElements": 17 }, "versions": [ { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-02-02T12:00:00Z", "lastModifiedBy": "afero", "lastModifiedDate": "2021-02-02T12:00:00Z", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "PRIMARY", "versionId": "b55d3882-444a-4c19-8d9c-eb232867c1ed", "zone": "example.com" }, { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "K-0N7RAK71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "jperez", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": false, "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, { "activationState": "OBSOLETE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-12-19T08:15:42Z", "lastModifiedBy": "jdupont", "lastModifiedDate": "2021-12-19T08:15:42Z", "signAndServe": false, "type": "PRIMARY", "versionId": "7949b2db-ac43-4773-a3ec-dc93202142fd", "zone": "example.com" } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "description": "Information about the request.", "type": "object" }, "versions": { "description": "Edge DNS zones. Each object contains zone settings, but not record sets.", "items": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } }, "type": "array" } }, "required": [ "metadata", "versions" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-zone-versions-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List a zone's versions", "tags": [ "Versions" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/versions.yaml", "path-info": "/zones/{zone}/versions" } }, "/zones/{zone}/versions/diff": { "get": { "description": "Displays the difference between any two versions of a zone, as specified in the query parameters.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-diff" }, "operationId": "get-zone-versions-diff", "parameters": [ { "description": "The base zone version ID.", "example": "{{from}}", "in": "query", "name": "from", "required": true, "schema": { "example": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "type": "string" }, "x-akamai": { "file-path": "parameters/from-query.yaml" } }, { "description": "The version ID to compare against the base version.", "example": "{{to}}", "in": "query", "name": "to", "required": true, "schema": { "example": "b55d3882-444a-4c19-8d9c-eb232867c1ed", "type": "string" }, "x-akamai": { "file-path": "parameters/to-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "diffs": { "recordSetDiffs": [ { "fromValue": { "rdata": [ "192.0.2.73" ], "ttl": 100 }, "name": "www.example.com", "operation": "DELETE", "type": "A" } ], "settingsDiffs": [ { "fieldName": "comment", "fromValue": "old comment", "operation": "EDIT", "toValue": "new comment" } ] }, "metadata": { "fromVersionId": "9a274847-11b6-4589-b445-33c2de5b1747", "fromVersionLastModifiedDate": "2021-12-25T00:00:00Z", "toVersionId": "a41df66e-fd52-4da6-b963-c92d3f7db4d3", "toVersionLastModifiedDate": "2021-12-25T00:00:00Z" } }, "schema": { "additionalProperties": false, "description": "A report on the difference between two zone versions or a version and a change list.", "properties": { "diffs": { "additionalProperties": false, "description": "Collections of differences between the two versions.", "properties": { "recordSetDiffs": { "description": "Record sets that have changed between two versions.", "items": { "additionalProperties": false, "description": "The difference in a record set between two versions.", "properties": { "fromValue": { "description": "The prior value of the settings field or record set. This may be any type of data, depending on the field that changed. The value doesn't exist on an `ADD` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "name": { "description": "The name of the record set that changed.", "type": "string" }, "operation": { "description": "The type of difference. An `ADD` difference contains the `toValue` but not a `fromValue`. A `DELETE` difference is the other way around. An `EDIT` difference has both fields.", "enum": [ "ADD", "DELETE", "EDIT" ], "type": "string" }, "toValue": { "description": "The new value of the settings field or record set. This may be any type of data, depending on the field that changed. The value doesn't exist on an `DELETE` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "type": { "description": "The type of the record set that changed.", "type": "string" } }, "required": [ "name", "type", "operation" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-recordset.yaml" } }, "type": "array" }, "settingsDiffs": { "description": "Settings fields that have changed between two versions.", "items": { "additionalProperties": false, "description": "The difference in a settings value between two versions.", "properties": { "fieldName": { "description": "The name of the settings value that changed.", "type": "string" }, "fromValue": { "description": "The prior value of the settings field or record set. This may be any type of data, depending on the field that changed. The value isn't present for an `ADD` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] }, "operation": { "description": "The type of difference. An `ADD` difference contains the `toValue` and a `DELETE` difference contains a `fromValue`. An `EDIT` difference contains both fields.", "enum": [ "ADD", "DELETE", "EDIT" ], "type": "string" }, "toValue": { "description": "The new value of the settings field or record set. This may be any type of data, depending on the field that changed. The value isn't present for a `DELETE` difference.", "oneOf": [ { "nullable": true, "title": "Boolean", "type": "boolean" }, { "nullable": true, "title": "Integer", "type": "integer" }, { "nullable": true, "title": "Object", "type": "object" }, { "nullable": true, "title": "String", "type": "string" } ] } }, "required": [ "fieldName", "operation" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-setting.yaml" } }, "type": "array" } }, "type": "object" }, "metadata": { "additionalProperties": false, "description": "Metadata about this diff report, describing the versions being diffed.", "properties": { "fromVersionId": { "description": "The version ID of the base version.", "type": "string" }, "fromVersionLastModifiedDate": { "description": "ISO 8601 timestamp indicating when the base version was last modified.", "format": "date-time", "type": "string" }, "toVersionId": { "description": "The version ID of the new version or change list.", "type": "string" }, "toVersionLastModifiedDate": { "description": "ISO 8601 timestamp indicating when the new change list version was last modified.", "format": "date-time", "type": "string" } }, "required": [ "fromVersionId", "toVersionId", "fromVersionLastModifiedDate", "toVersionLastModifiedDate" ], "type": "object" } }, "required": [ "metadata", "diffs" ], "type": "object", "x-akamai": { "file-path": "schemas/diff-report.yaml" } } } }, "description": "Successful response." } }, "summary": "Show zone version differences", "tags": [ "Versions" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-diff.yaml", "path-info": "/zones/{zone}/versions/diff" } }, "/zones/{zone}/versions/{uuid}": { "get": { "description": "Returns an image of the Zone from a previous version. Shows only zone settings, not record sets.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-uuid" }, "operationId": "get-zone-versions-uuid", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "activationState": "ACTIVE", "aliasCount": 1, "contractId": "C-0N7RAC71", "lastActivationDate": "2021-01-03T12:00:00Z", "lastModifiedBy": "tyamada", "lastModifiedDate": "2021-01-03T12:00:00Z", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "type": "PRIMARY", "versionId": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "zone": "example.com" }, "schema": { "additionalProperties": false, "description": "An Edge DNS zone. This object contains zone settings, but not record sets.", "properties": { "activationState": { "description": "The current zone activation status. Either `NEW`, `PENDING`, `PENDING_APPROVAL`, `ACTIVE`, `OBSOLETE`, `LOCKED`, `ERROR`, or `DELETED`.", "enum": [ "NEW", "PENDING", "PENDING_APPROVAL", "ACTIVE", "OBSOLETE", "ERROR", "LOCKED", "DELETED" ], "type": "string" }, "aliasCount": { "description": "For primary and secondary zones only. The number of zones of type `ALIAS` that point to this zone.", "type": "integer" }, "comment": { "description": "Free-form user comments.", "type": "string" }, "contractId": { "description": "The contract for this zone.", "type": "string" }, "endCustomerId": { "description": "Free-form user identifier for this zone, often used by resellers.", "type": "string" }, "lastActivationDate": { "description": "An ISO 8601 timestamp indicating when the latest zone version was activated. For primary and secondary zones only.", "type": "string" }, "lastModifiedBy": { "description": "The name of the user that last edited this zone.", "type": "string" }, "lastModifiedDate": { "description": "An ISO 8601 timestamp indicating when the zone was last modified.", "type": "string" }, "masters": { "description": "The names or addresses of the customer's name servers from which the zone data should be retrieved. For `SECONDARY` zones only.", "items": { "type": "string" }, "type": "array" }, "multiProviderDnssec": { "additionalProperties": false, "description": "Multi-provider DNSSEC properties.", "properties": { "enabled": { "description": "Enables use of multi-provider DNSSEC functionality.", "type": "boolean" }, "webhook": { "description": "Customer URL to call when a new ZSK secret has been generated.", "type": "string" } }, "required": [ "enabled" ], "type": "object", "x-akamai": { "file-path": "schemas/multi-provider-dnssec.yaml" } }, "outboundZoneTransfer": { "additionalProperties": false, "description": "Outbound zone transfer properties. When enabling outbound zone transfer, all the fields are required. Set `tsigKey` to null if you don't use it.", "properties": { "ACL": { "description": "The access control list, defined as IPv4 and IPv6 CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "enabled": { "description": "Enables outbound zone transfer.", "type": "boolean" }, "notifyTargets": { "description": "Customer secondary name servers to notify, if `NOTIFY` requests are desired. Up to 64 IPv4 or IPv6 addresses. If no targets are specified, you can manually request zone transfer updates as needed.", "items": { "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" }, "tsigKey": { "additionalProperties": false, "description": "The TSIG key used for outbound zone transfers.", "nullable": true, "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The zone name.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" } }, "type": "object" } }, "type": "object", "x-akamai": { "file-path": "schemas/outbound-zone-transfer.yaml" } }, "signAndServe": { "description": "Whether DNSSEC Sign&Serve is enabled. Applies to primary and secondary zones only.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve, present only if an algorithm has been assigned. Either `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "subzoneGrants": { "description": "Indicates that cross-account subzones are enabled. Users can still create subzones.", "type": "boolean" }, "target": { "description": "The name of the zone whose configuration this zone copies. For `ALIAS` zones only.", "type": "string" }, "tsigKey": { "additionalProperties": false, "description": "A TSIG key. For `SECONDARY` zones only. The TSIG key used for zone transfers.", "properties": { "algorithm": { "description": "The algorithm used to encode the TSIG key's secret data. Possible values are: `hmac-md5`, `hmac-sha1`, `hmac-sha224`, `hmac-sha256`, `hmac-sha384`, `hmac-sha512`, or `HMAC-MD5.SIG-ALG.REG.INT`.", "enum": [ "hmac-md5", "hmac-sha1", "hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512", "HMAC-MD5.SIG-ALG.REG.INT" ], "type": "string" }, "name": { "description": "The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.", "type": "string" }, "secret": { "description": "A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.", "type": "string" }, "zonesCount": { "description": "The number of zones that reference this key.", "minimum": 1, "type": "integer" } }, "required": [ "name", "algorithm", "secret" ], "type": "object", "x-akamai": { "file-path": "schemas/tsigkey-get.yaml" } }, "type": { "description": "The zone type. A `PRIMARY` zone's records are stored in Control Center. A `SECONDARY` zone's records are stored on the customer's name servers. `ALIAS` zones allow users to duplicate the configuration of an existing zone.", "enum": [ "PRIMARY", "SECONDARY", "ALIAS" ], "type": "string" }, "versionId": { "description": "The most recently activated version's unique ID. You can use this value as an `ETag` when performing operations that affect zones.", "type": "string" }, "zone": { "description": "The name of the zone.", "type": "string" } }, "required": [ "contractId", "zone", "type", "versionId", "lastModifiedDate", "lastModifiedBy", "activationState" ], "type": "object", "x-akamai": { "file-path": "schemas/zone-get.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a zone version", "tags": [ "Versions" ] }, "parameters": [ { "description": "A zone version tag ID.", "example": "{{uuid}}", "in": "path", "name": "uuid", "required": true, "schema": { "example": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "type": "string" }, "x-akamai": { "file-path": "parameters/uuid-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/uuid.yaml", "path-info": "/zones/{zone}/versions/{uuid}" } }, "/zones/{zone}/versions/{uuid}/recordsets": { "get": { "description": "Lists all record sets for this zone. It works only for `PRIMARY` and `SECONDARY` zones. This operation [paginates](https://techdocs.akamai.com/edge-dns/reference/use-pagination).", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-recordsets" }, "operationId": "get-zone-versions-recordsets", "parameters": [ { "description": "Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Allowed fields include `name` and `type`.", "example": "{{sortBy}}", "explode": false, "in": "query", "name": "sortBy", "schema": { "example": [ "name", "type" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/sort-by-name-type-query.yaml" } }, { "description": "Displays only record sets that match one of the provided types. Specifies multiple fields as a comma-separated list. Ignores illegal or disallowed record types.", "example": "{{types}}", "explode": false, "in": "query", "name": "types", "schema": { "example": [ "A", "AAAA" ], "items": { "type": "string" }, "type": "array" }, "style": "form", "x-akamai": { "file-path": "parameters/types-record-sets-query.yaml" } }, { "description": "Display only record sets whose RDATA field matches this value. All records with the same name and type display if any record in the set has RDATA that matches the supplied value.", "example": "{{search}}", "in": "query", "name": "search", "schema": { "example": "192.0.2.1", "type": "string" }, "x-akamai": { "file-path": "parameters/search-rdata-query.yaml" } }, { "description": "Which page of results to return. The first page is page `1`, the default value.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "default": 1, "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page.yaml" } }, { "description": "The number of results per page to return, `25` by default.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 25, "type": "integer" }, "x-akamai": { "file-path": "parameters/pageable-page-size.yaml" } }, { "description": "Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time.", "example": "{{showAll}}", "in": "query", "name": "showAll", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/pageable-show-all.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "page": 1, "pageSize": 25, "totalElements": 2, "types": [ "A" ], "zone": "example.com" }, "recordsets": [ { "name": "www.example.com", "rdata": [ "192.0.2.11", "192.0.2.24" ], "ttl": 300, "type": "A" }, { "name": "mail.example.com", "rdata": [ "192.0.2.245", "192.0.2.117" ], "ttl": 300, "type": "A" } ] }, "schema": { "additionalProperties": false, "properties": { "metadata": { "additionalProperties": false, "description": "Information about the request.", "properties": { "page": { "description": "Current page.", "minimum": 1, "type": "integer" }, "pageSize": { "description": "The number of results per page.", "minimum": 1, "type": "integer" }, "totalElements": { "description": "The total number of results.", "minimum": 0, "type": "integer" }, "types": { "description": "Reflects the set of record types that were requested.", "items": { "type": "string" }, "minItems": 0, "type": "array", "uniqueItems": true }, "zone": { "description": "The name of the zone.", "minLength": 0, "type": "string" } }, "required": [ "zone", "page", "pageSize", "totalElements", "types" ], "type": "object" }, "recordsets": { "description": "One or more record sets.", "items": { "additionalProperties": false, "description": "A set of one or more resource records that share the same name, type, and TTL.", "properties": { "name": { "description": "The fully qualified domain name (FQDN) of this record.", "type": "string" }, "rdata": { "description": "Each string encodes the rdata for a single record. If you want to have three A records, you need three strings in the array. Each string is encoded in master file format. RFC 1035 defines master file format for most record types.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds this record should live in a resolver's cache before being refetched. A value of `0` means the record is uncached.", "minimum": 0, "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "name", "type", "ttl", "rdata" ], "type": "object", "x-akamai": { "file-path": "schemas/recordset.yaml" } }, "type": "array" } }, "required": [ "metadata", "recordsets" ], "type": "object", "x-akamai": { "file-path": "schemas/get-zones-zone-versions-uuid-recordsets-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a version's record sets", "tags": [ "Versions" ] }, "parameters": [ { "description": "A zone version tag ID.", "example": "{{uuid}}", "in": "path", "name": "uuid", "required": true, "schema": { "example": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "type": "string" }, "x-akamai": { "file-path": "parameters/uuid-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-record-sets.yaml", "path-info": "/zones/{zone}/versions/{uuid}/recordsets" } }, "/zones/{zone}/versions/{uuid}/recordsets/activate": { "post": { "description": "Creates and activates a new version of the zone by copying the record sets from a prior version of this zone and reapplying them to the current version. The new version has a new, auto-incremented SOA serial number, and the zone's modification data is set to the current time and user. All other zone settings remain the same as the current version.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-versions-uuid-recordsets-activate" }, "operationId": "post-zones-zone-versions-uuid-recordsets-activate", "parameters": [ { "description": "A new comment string that may be blank. If not included, the old comment is copied.", "example": "{{comment}}", "in": "query", "name": "comment", "schema": { "example": "Migrated from legacy DNS provider", "type": "string" }, "x-akamai": { "file-path": "parameters/comment-query.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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "The operation was successful. No response data is returned." } }, "summary": "Reactivate a version", "tags": [ "Versions" ] }, "parameters": [ { "description": "A zone version tag ID.", "example": "{{uuid}}", "in": "path", "name": "uuid", "required": true, "schema": { "example": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "type": "string" }, "x-akamai": { "file-path": "parameters/uuid-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/activate.yaml", "path-info": "/zones/{zone}/versions/{uuid}/recordsets/activate" } }, "/zones/{zone}/versions/{uuid}/zone-file": { "get": { "description": "Downloads the record sets from a prior zone version in [master zone file](https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-uuid) format. This applies to primary and secondary zones.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-versions-uuid-zone-file" }, "operationId": "get-zones-zone-versions-uuid-zone-file", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "text/dns": { "example": "\nexample.com. 10000 IN SOA ns1.akamaidns.com. webmaster.example.com. 1 28800 14400 2419200 86400\nexample.com. 10000 IN NS ns1.akamaidns.com.\nexample.com. 10000 IN NS ns2.akamaidns.com.\nexample.com. 300 IN A 10.0.0.1\nexample.com. 300 IN A 10.0.0.2\nwww.example.com. 300 IN A 10.0.0.1\nwww.example.com. 300 IN A 10.0.0.2", "schema": { "type": "string" } } }, "description": "Successful response." } }, "summary": "Get a version's master zone file", "tags": [ "Zone file" ] }, "parameters": [ { "description": "A zone version tag ID.", "example": "{{uuid}}", "in": "path", "name": "uuid", "required": true, "schema": { "example": "ae02357c-693d-4ac4-b33d-8352d9b7c786", "type": "string" }, "x-akamai": { "file-path": "parameters/uuid-path.yaml" } }, { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/version-zone-file.yaml", "path-info": "/zones/{zone}/versions/{uuid}/zone-file" } }, "/zones/{zone}/zone-file": { "post": { "description": "Upload new record set data for this zone in master zone file format. Replaces any existing record sets. This operation applies to primary zones and secondary zones. See [RFC 1035](http://tools.ietf.org/html/rfc1035) section 5 and [RFC 1034](http://tools.ietf.org/html/rfc1034) section 3.6.1 for more information. Zone files can contain only US-ASCII characters 0–127. Where allowed, you can encode high-order ASCII characters, 128+, with a backslash plus a three-digit decimal number representing the byte value. For example, `\\233` instead of `é`. `AKAMAICDN` and `AKAMAITLC` records can't be represented in this format. Uploading a zone file doesn't affect these records.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-zone-file" }, "operationId": "post-zones-zone-zone-file", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "text/dns": { "example": "\nexample.com. 10000 IN SOA ns1.akamaidns.com. webmaster.example.com. 1 28800 14400 2419200 86400\nexample.com. 10000 IN NS ns1.akamaidns.com.\nexample.com. 10000 IN NS ns2.akamaidns.com.\nexample.com. 300 IN A 10.0.0.1\nexample.com. 300 IN A 10.0.0.2\nwww.example.com. 300 IN A 10.0.0.1\nwww.example.com. 300 IN A 10.0.0.2", "schema": { "type": "string" } } }, "required": true }, "responses": { "204": { "content": {}, "description": "Successful operation." } }, "summary": "Upload a master zone file", "tags": [ "Master zone file" ] }, "get": { "description": "Download this zone's record set data in master zone file format. Use the recipe below to get the master zone file. This operation applies to primary zones and secondary zones. See [RFC 1035](http://tools.ietf.org/html/rfc1035) section 5 and [RFC 1034](http://tools.ietf.org/html/rfc1034) section 3.6.1 for more information. `AKAMAICDN` and `AKAMAITLC` records can't be represented in this format, so they're displayed as comment lines.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-zone-file" }, "operationId": "get-zones-zone-zone-file", "parameters": [ { "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).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "text/dns": { "example": "\nexample.com. 10000 IN SOA ns1.akamaidns.com. webmaster.example.com. 1 28800 14400 2419200 86400\nexample.com. 10000 IN NS ns1.akamaidns.com.\nexample.com. 10000 IN NS ns2.akamaidns.com.\nexample.com. 300 IN A 10.0.0.1\nexample.com. 300 IN A 10.0.0.2\nwww.example.com. 300 IN A 10.0.0.1\nwww.example.com. 300 IN A 10.0.0.2", "schema": { "type": "string" } } }, "description": "Successful operation." } }, "summary": "Get a master zone file", "tags": [ "Master zone file" ] }, "parameters": [ { "description": "The name of the zone.", "example": "{{zone}}", "in": "path", "name": "zone", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/zone-path.yaml" } } ], "x-akamai": { "file-path": "paths/zone-file.yaml", "path-info": "/zones/{zone}/zone-file" } } }, "servers": [ { "url": "https://{hostname}/config-dns/v2" } ], "tags": [ { "description": "Groups operations to manage zones.", "name": "Zones" }, { "description": "Groups operations to get the current DNSSEC status for zones.", "name": "DNSSEC status" }, { "description": "Groups operations to get the current DNSSEC DNSKEY records for zones.", "name": "DNSSEC keys" }, { "description": "Groups operations to get results of the most recent zone transfer attempts.", "name": "Zone transfer status" }, { "description": "Groups operations to get details about the contract that zone belongs to.", "name": "Zone contracts" }, { "description": "Groups operations to manage zone versions.", "name": "Versions" }, { "description": "Groups operations to download the record sets from a prior zone version.", "name": "Zone file" }, { "description": "Groups operations to list record set names for a zone.", "name": "Names" }, { "description": "Groups operations to master zone files.", "name": "Master zone file" }, { "description": "Groups operations that you can use to manage change lists.", "name": "Change lists" }, { "description": "Groups operations that you can use to get details about record set types.", "name": "Types" }, { "description": "Groups operations that you can use to manage record sets.", "name": "Record sets" }, { "description": "Groups operations that you can use to manage record Change list settings.", "name": "Change list settings" }, { "description": "Groups operations to get details about Akamai authoritative name servers for your contracts.", "name": "Authorities" }, { "description": "Groups operations to get details about your contracts.", "name": "Contracts" }, { "description": "Groups operations to get details about DNSSEC algorithm names.", "name": "DNSSEC algorithms" }, { "description": "Groups operations to get details about your Edge Hostnames.", "name": "Edge hostnames" }, { "description": "Groups operations to get details about your groups.", "name": "Groups" }, { "description": "Groups operations to get names of TSIG key algorithms.", "name": "TSIG key algorithms" }, { "description": "Groups operations to get record set types.", "name": "Record set types" }, { "description": "Groups operations to manage proxies.", "name": "DNS proxies" }, { "description": "Groups operations to manage proxy zones.", "name": "Proxy zones" }, { "description": "Groups operations to manage proxy zone filter conversions.", "name": "Proxy zones filter mode conversion" }, { "description": "Groups operations to manage TSIG keys.", "name": "TSIG keys" }, { "description": "Groups operations that you can use to manage zone creation requests.", "name": "Create requests" }, { "description": "Groups operations that you can use to manage zone convert requests.", "name": "Convert requests" }, { "description": "Groups operations that you can use to manage zone deletion requests.", "name": "Delete requests" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }