Edge DNS

https://techdocs.akamai.com/edge-dns/
Admin
Edge DNS is an authoritative DNS service that provides secure, high-performance, scalable DNS...
Tokens:2,144,266
Snippets:5,946
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/convert-requests

Provides links to key API resources, including the OpenAPI schema, getting started guides, and error documentation.

```APIDOC
API Reference:
  - Edge DNS API v2: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
  - API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and Access Level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS Resource Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone Create Failure States: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  - API Errors:
    - 304: https://techdocs.akamai.com/edge-dns/reference/304
    - 400: https://techdocs.akamai.com/edge-dns/reference/400
    - 401: https://techdocs.akamai.com/edge-dns/reference/401
    - 403: https://techdocs.akamai.com/edge-dns/reference/403
    - 404: https://techdocs.akamai.com/edge-dns/reference/404
    - 405: https://techdocs.akamai.com/edge-dns/reference/405
    - 409: https://techdocs.akamai.com/edge-dns/reference/409
    - 415: https://techdocs.akamai.com/edge-dns/reference/415
    - 429: https://techdocs.akamai.com/edge-dns/reference/429
    - 503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/put-zones-zone-recordsets

Provides general information and links to key resources for the Akamai Edge DNS API, including the OpenAPI schema and getting started guides.

```APIDOC
Edge DNS API v2:
  Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api

API Summary:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-summary

OpenAPI Schema:
  Link: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2

Get Started:
  Guide: https://techdocs.akamai.com/edge-dns/reference/get-started

Use Pagination:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-pagination

Group IDs and Access Level:
  Guide: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level

Supported DNS Resource Record Types:
  Guide: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types

Use Change Lists:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-change-lists

Zone Create Failure States:
  Guide: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals

Subzone Grants:
  Guide: https://techdocs.akamai.com/edge-dns/reference/subzone-grants

Definitions of the activationState:
  Guide: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions

Edge DNS API Troubleshooting:
  Guide: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting

API Errors:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-errors
  Specific Errors:
    304: https://techdocs.akamai.com/edge-dns/reference/304
    400: https://techdocs.akamai.com/edge-dns/reference/400
    401: https://techdocs.akamai.com/edge-dns/reference/401
    403: https://techdocs.akamai.com/edge-dns/reference/403
    404: https://techdocs.akamai.com/edge-dns/reference/404
    405: https://techdocs.akamai.com/edge-dns/reference/405
    409: https://techdocs.akamai.com/edge-dns/reference/409
    415: https://techdocs.akamai.com/edge-dns/reference/415
    429: https://techdocs.akamai.com/edge-dns/reference/429
    503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### Akamai Edge DNS API Reference

Source: https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-mode-convert-manual

Provides links to key API resources for Edge DNS, including the OpenAPI schema, getting started guides, and pagination usage.

```APIDOC
Edge DNS API v2:
  https://techdocs.akamai.com/edge-dns/reference/edge-dns-api

API Summary:
  https://techdocs.akamai.com/edge-dns/reference/api-summary

OpenAPI Schema:
  https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2

Get Started:
  https://techdocs.akamai.com/edge-dns/reference/get-started

Use Pagination:
  https://techdocs.akamai.com/edge-dns/reference/use-pagination

Group IDs and Access Level:
  https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level

Supported DNS Resource Record Types:
  https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types

Use Change Lists:
  https://techdocs.akamai.com/edge-dns/reference/use-change-lists

Zone Create Failure States:
  https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals

Subzone Grants:
  https://techdocs.akamai.com/edge-dns/reference/subzone-grants

Definitions of the activationState:
  https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions

Edge DNS API Troubleshooting:
  https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
```

--------------------------------

### Edge DNS API v2 Overview

Source: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone

Provides an overview and entry point to the Akamai Edge DNS API v2 documentation. It includes links to the API summary, OpenAPI schema, getting started guides, and best practices for using the API.

```APIDOC
Edge DNS API v2:
  - API summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  - Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/get-zones-convert-requests

Provides links to key API resources, including the OpenAPI schema, getting started guides, and error documentation.

```APIDOC
API Reference:
  - Edge DNS API v2: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
  - API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and Access Level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS Resource Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone Create Failure States: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  - API Errors:
    - 304: https://techdocs.akamai.com/edge-dns/reference/304
    - 400: https://techdocs.akamai.com/edge-dns/reference/400
    - 401: https://techdocs.akamai.com/edge-dns/reference/401
    - 403: https://techdocs.akamai.com/edge-dns/reference/403
    - 404: https://techdocs.akamai.com/edge-dns/reference/404
    - 405: https://techdocs.akamai.com/edge-dns/reference/405
    - 409: https://techdocs.akamai.com/edge-dns/reference/409
    - 415: https://techdocs.akamai.com/edge-dns/reference/415
    - 429: https://techdocs.akamai.com/edge-dns/reference/429
    - 503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/get-keys

Provides an overview of the Akamai Edge DNS API, including links to the v2 reference, API summary, OpenAPI schema, and guides for getting started, pagination, and error handling.

```APIDOC
Edge DNS API v2 Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
Use Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
Group IDs and Access Level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
Supported DNS Resource Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
Use Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
Zone Create Failure States: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
API Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Akamai Edge DNS API Reference Summary

Source: https://techdocs.akamai.com/edge-dns/reference/post-proxy-zones-delete-requests

Provides an overview of the Akamai Edge DNS API, including links to specific resources like the OpenAPI schema, getting started guides, and pagination usage.

```APIDOC
Edge DNS API v2:
  - API summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
```

--------------------------------

### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/tsig-keys

Provides an overview of the Akamai Edge DNS API, including links to the v2 reference, API summary, OpenAPI schema, and guides for getting started, pagination, and error handling.

```APIDOC
Edge DNS API v2 Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
Use Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
Group IDs and Access Level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
Supported DNS Resource Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
Use Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
Zone Create Failure States: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
API Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Akamai Edge DNS API Overview and Resources

Source: https://techdocs.akamai.com/edge-dns/reference/get-zone

Provides links to key resources for the Akamai Edge DNS API, including the OpenAPI schema, getting started guides, pagination usage, and error handling.

```APIDOC
APIDOC: Akamai Edge DNS API Resources

Key resources and guides for using the Edge DNS API.

- Edge DNS API v2 Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
- API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
- OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
- Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
- Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
- Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
- Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
- Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
- Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
- Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
- Subzone grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
- Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
- Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
- API Errors (e.g., 304, 400, 401, 403, 404, 405, 409, 415, 429, 503): https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Akamai Edge DNS API Reference

Source: https://techdocs.akamai.com/edge-dns/reference/use-pagination

Provides links to key API documentation sections for Akamai Edge DNS, including the OpenAPI schema, getting started guides, and specific features like pagination and change lists.

```APIDOC
Edge DNS API v2:
  Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api

API Summary:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-summary

OpenAPI Schema:
  Location: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  Description: Provides the OpenAPI specification for the Edge DNS API v2.

Get Started:
  Reference: https://techdocs.akamai.com/edge-dns/reference/get-started
  Description: Guide to begin using the Edge DNS API.

Use Pagination:
  Reference: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  Description: Information on how to use pagination for API requests.

Group IDs and Access Level:
  Reference: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  Description: Details on group IDs and access level management within the API.

Supported DNS Resource Record Types:
  Reference: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  Description: List of DNS record types supported by the API.

Use Change Lists:
  Reference: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  Description: How to use change lists for managing DNS configurations.

Example: Create a new primary zone:
  Reference: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  Description: A practical example demonstrating the creation of a primary zone.

Zone Create Failure States:
  Reference: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  Description: Information on failure states during zone creation.

Subzone Grants:
  Reference: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  Description: Details regarding subzone grants.

Definitions of the activationState:
  Reference: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  Description: Explains the different states of zone activation.

Edge DNS API Troubleshooting:
  Reference: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  Description: Guidance for troubleshooting common API issues.

API Errors:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-errors
  Description: Comprehensive list and explanation of API error codes.
```

--------------------------------

### Example API Request with Headers

Source: https://techdocs.akamai.com/edge-dns/reference/get-zone-versions

Demonstrates how to make an API request, including setting necessary headers like 'accept'.

```shell
curl -X GET \
  'https://example.akamai.com/api/v2/zones/example.com/contract' \
  --header 'accept: application/json'
```

--------------------------------

### Zone Creation Example

Source: https://techdocs.akamai.com/edge-dns/reference/zone-file

Illustrates the process of creating a new primary zone using the Akamai Edge DNS API, including relevant concepts like change lists.

```APIDOC
Example: Create a new primary zone
  URL: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  Description: This example guides through the steps to create a primary zone, often involving the use of change lists for managing zone updates.
```

--------------------------------

### Example API Request with Headers

Source: https://techdocs.akamai.com/edge-dns/reference/versions

Demonstrates how to make an API request, including setting necessary headers like 'accept'.

```shell
curl -X GET \
  'https://example.akamai.com/api/v2/zones/example.com/contract' \
  --header 'accept: application/json'
```

--------------------------------

### Zone Creation Example

Source: https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-versions-uuid-zone-file

Illustrates the process of creating a new primary zone using the Akamai Edge DNS API, including relevant concepts like change lists.

```APIDOC
Example: Create a new primary zone
  URL: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  Description: This example guides through the steps to create a primary zone, often involving the use of change lists for managing zone updates.
```

--------------------------------

### Edge DNS API General Information

Source: https://techdocs.akamai.com/edge-dns/reference/zone-transfer-status

Provides general information and links to key resources for the Edge DNS API, including the OpenAPI schema, getting started guides, and error handling.

```APIDOC
API v2 Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
Group IDs & Access: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
Supported Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
Example: Create Primary Zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
Zone Create Failures: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
Activation State Definitions: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
API Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Edge DNS API General Information

Source: https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-transfer-status

Provides general information and links to key resources for the Edge DNS API, including the OpenAPI schema, getting started guides, and error handling.

```APIDOC
API v2 Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
API Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
Group IDs & Access: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
Supported Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
Example: Create Primary Zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
Zone Create Failures: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
Activation State Definitions: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
API Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Example Shell Command with Headers

Source: https://techdocs.akamai.com/edge-dns/reference/get-changelists-zone-names

Demonstrates how to make an API request using curl, including setting the 'accept' header.

```shell
curl -X GET \
  'https://example.com/api/v1/zones' \
  --header 'accept: application/json'
```

--------------------------------

### Akamai Edge DNS API - General References

Source: https://techdocs.akamai.com/edge-dns/reference/get-zones-delete-requests-requestid-result

Provides links to general API resources including OpenAPI schema, getting started guides, pagination usage, error codes, and troubleshooting.

```APIDOC
OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
Use Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
API Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
```

--------------------------------

### Basic Shell Response Example

Source: https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-transfer-status

A minimal example of a successful JSON response from a shell command.

```Shell
1{"success":true}
```

--------------------------------

### Akamai Edge DNS API Overview

Source: https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zones-name-key

Provides general information and links to key resources for the Akamai Edge DNS API, including its schema, getting started guides, and best practices.

```APIDOC
Edge DNS API v2:
  - Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api
  - Summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI Schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get Started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and Access Level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS Resource Record Types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Change Lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone Create Failure States: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone Grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Activation State Definitions: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  - Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
```

--------------------------------

### Edge DNS API v2 Overview

Source: https://techdocs.akamai.com/edge-dns/reference/get-proxy-id

Provides links to key resources for the Edge DNS API v2, including the OpenAPI schema, getting started guides, pagination, and supported record types.

```APIDOC
Edge DNS API v2:
  - API summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
```

--------------------------------

### cURL Request Example for TSIG Algorithms

Source: https://techdocs.akamai.com/edge-dns/reference/tsig-key-algorithms

Example cURL command to fetch the list of TSIG key algorithms from the Akamai Edge DNS API.

```curl
curl --request GET \
     --url https://hostname/config-dns/v2/data/tsig-algorithms
```

--------------------------------

### Akamai Edge DNS API Reference

Source: https://techdocs.akamai.com/edge-dns/reference/put-proxy

Provides an overview of the Edge DNS API, including links to the OpenAPI schema, getting started guides, pagination usage, supported record types, and troubleshooting information.

```APIDOC
Edge DNS API v2:
  - API summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Example: Create a new primary zone: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone
  - Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Subzone grants: https://techdocs.akamai.com/edge-dns/reference/subzone-grants
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
  - Errors: https://techdocs.akamai.com/edge-dns/reference/api-errors
    - 304: https://techdocs.akamai.com/edge-dns/reference/304
    - 400: https://techdocs.akamai.com/edge-dns/reference/400
    - 401: https://techdocs.akamai.com/edge-dns/reference/401
    - 403: https://techdocs.akamai.com/edge-dns/reference/403
    - 404: https://techdocs.akamai.com/edge-dns/reference/404
    - 405: https://techdocs.akamai.com/edge-dns/reference/405
    - 409: https://techdocs.akamai.com/edge-dns/reference/409
    - 415: https://techdocs.akamai.com/edge-dns/reference/415
    - 429: https://techdocs.akamai.com/edge-dns/reference/429
    - 503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### Example: Create a New Primary Zone

Source: https://techdocs.akamai.com/edge-dns/reference/post-zones-zone-versions-uuid-recordsets-activate

Illustrates the process of creating a new primary DNS zone using the Akamai Edge DNS API.

```APIDOC
POST /zones

Request Body Example:
{
  "zone": "example.com",
  "email": "admin@example.com",
  "nameservers": [
    "ns1.akamai.com",
    "ns2.akamai.com"
  ],
  "contractId": "1-ABCDEF"
}

Response Example (201 Created):
{
  "zone": "example.com",
  "email": "admin@example.com",
  "nameservers": [
    "ns1.akamai.com",
    "ns2.akamai.com"
  ],
  "contractId": "1-ABCDEF",
  "status": "active",
  "creationDate": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Basic Shell Response Example

Source: https://techdocs.akamai.com/edge-dns/reference/get-zone-contract

A minimal example of a successful JSON response from a shell command.

```Shell
1{"success":true}
```

--------------------------------

### Basic Shell Response Example

Source: https://techdocs.akamai.com/edge-dns/reference/post-zone

A minimal example of a successful JSON response from a shell command.

```Shell
1{"success":true}
```

--------------------------------

### Akamai Edge DNS API Reference Summary

Source: https://techdocs.akamai.com/edge-dns/reference/delete-requests-1

Provides an overview of the Akamai Edge DNS API, including links to specific resources like the OpenAPI schema, getting started guides, and pagination usage.

```APIDOC
Edge DNS API v2:
  - API summary: https://techdocs.akamai.com/edge-dns/reference/api-summary
  - OpenAPI schema: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2
  - Get started: https://techdocs.akamai.com/edge-dns/reference/get-started
  - Use pagination: https://techdocs.akamai.com/edge-dns/reference/use-pagination
  - Group IDs and access level: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level
  - Supported DNS resource record types: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types
  - Use change lists: https://techdocs.akamai.com/edge-dns/reference/use-change-lists
  - Zone create failure states: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals
  - Definitions of the activationState: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions
  - Edge DNS API Troubleshooting: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting
```

--------------------------------

### Basic Shell Response Example

Source: https://techdocs.akamai.com/edge-dns/reference/zone-contracts

A minimal example of a successful JSON response from a shell command.

```Shell
1{"success":true}
```

--------------------------------

### Akamai Edge DNS API - Example Request

Source: https://techdocs.akamai.com/edge-dns/reference/get-zone-versions-diff

An example of an API request, demonstrating how to set headers for interacting with the Akamai Edge DNS API.

```shell
curl \
     --header 'accept: application/json'
```

--------------------------------

### Basic Shell Response Example

Source: https://techdocs.akamai.com/edge-dns/reference/zones-1

A minimal example of a successful JSON response from a shell command.

```Shell
1{"success":true}
```

--------------------------------

### Akamai Edge DNS API General References

Source: https://techdocs.akamai.com/edge-dns/reference/post-proxy

Provides an overview of the Akamai Edge DNS API, including links to the OpenAPI schema, getting started guides, pagination usage, error codes, and troubleshooting tips.

```APIDOC
Edge DNS API v2:
  Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api

API Summary:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-summary

OpenAPI Schema:
  Link: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2

Get Started:
  Guide: https://techdocs.akamai.com/edge-dns/reference/get-started

Use Pagination:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-pagination

Group IDs and Access Level:
  Details: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level

Supported DNS Resource Record Types:
  List: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types

Use Change Lists:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-change-lists

Example: Create a new primary zone:
  Guide: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone

Zone Create Failure States:
  Details: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals

Subzone Grants:
  Details: https://techdocs.akamai.com/edge-dns/reference/subzone-grants

Definitions of activationState:
  Details: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions

Edge DNS API Troubleshooting:
  Guide: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting

API Errors:
  General: https://techdocs.akamai.com/edge-dns/reference/api-errors
  Specific Errors:
    304: https://techdocs.akamai.com/edge-dns/reference/304
    400: https://techdocs.akamai.com/edge-dns/reference/400
    401: https://techdocs.akamai.com/edge-dns/reference/401
    403: https://techdocs.akamai.com/edge-dns/reference/403
    404: https://techdocs.akamai.com/edge-dns/reference/404
    405: https://techdocs.akamai.com/edge-dns/reference/405
    409: https://techdocs.akamai.com/edge-dns/reference/409
    415: https://techdocs.akamai.com/edge-dns/reference/415
    429: https://techdocs.akamai.com/edge-dns/reference/429
    503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### Example: Create a New Primary Zone

Source: https://techdocs.akamai.com/edge-dns/reference/get-zones-zone-key

Illustrates the process of creating a new primary DNS zone using the Edge DNS API.

```APIDOC
## Example: Create a New Primary Zone

This example demonstrates a typical request to create a new primary zone.

**Request**: `POST /zones`

**Request Body Example**: 
```json
{
  "zone": "example.com",
  "email": "admin@example.com",
  "soa_ttl": 3600,
  "default_ttl": 3600,
  "allow_transfer": ["192.0.2.0/24"],
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ],
  "type": "PRIMARY"
}
```

**Response**: 
```json
{
  "zone": "example.com",
  "email": "admin@example.com",
  "soa_ttl": 3600,
  "default_ttl": 3600,
  "allow_transfer": ["192.0.2.0/24"],
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ],
  "type": "PRIMARY",
  "zone_key": "example.com",
  "activationState": "PENDING"
}
```

**Notes**: 
- The `zone_key` is typically the zone name itself.
- `activationState` indicates the current deployment status of the zone.
```

--------------------------------

### Akamai Edge DNS API General References

Source: https://techdocs.akamai.com/edge-dns/reference/dns-proxies

Provides an overview of the Akamai Edge DNS API, including links to the OpenAPI schema, getting started guides, pagination usage, error codes, and troubleshooting tips.

```APIDOC
Edge DNS API v2:
  Reference: https://techdocs.akamai.com/edge-dns/reference/edge-dns-api

API Summary:
  Reference: https://techdocs.akamai.com/edge-dns/reference/api-summary

OpenAPI Schema:
  Link: https://github.com/akamai/akamai-apis/tree/main/apis/config-dns/v2

Get Started:
  Guide: https://techdocs.akamai.com/edge-dns/reference/get-started

Use Pagination:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-pagination

Group IDs and Access Level:
  Details: https://techdocs.akamai.com/edge-dns/reference/group-ids-access-level

Supported DNS Resource Record Types:
  List: https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types

Use Change Lists:
  Guide: https://techdocs.akamai.com/edge-dns/reference/use-change-lists

Example: Create a new primary zone:
  Guide: https://techdocs.akamai.com/edge-dns/reference/example-create-new-primary-zone

Zone Create Failure States:
  Details: https://techdocs.akamai.com/edge-dns/reference/zone-create-failure-vals

Subzone Grants:
  Details: https://techdocs.akamai.com/edge-dns/reference/subzone-grants

Definitions of activationState:
  Details: https://techdocs.akamai.com/edge-dns/reference/activation-state-definitions

Edge DNS API Troubleshooting:
  Guide: https://techdocs.akamai.com/edge-dns/reference/edns-api-troubleshooting

API Errors:
  General: https://techdocs.akamai.com/edge-dns/reference/api-errors
  Specific Errors:
    304: https://techdocs.akamai.com/edge-dns/reference/304
    400: https://techdocs.akamai.com/edge-dns/reference/400
    401: https://techdocs.akamai.com/edge-dns/reference/401
    403: https://techdocs.akamai.com/edge-dns/reference/403
    404: https://techdocs.akamai.com/edge-dns/reference/404
    405: https://techdocs.akamai.com/edge-dns/reference/405
    409: https://techdocs.akamai.com/edge-dns/reference/409
    415: https://techdocs.akamai.com/edge-dns/reference/415
    429: https://techdocs.akamai.com/edge-dns/reference/429
    503: https://techdocs.akamai.com/edge-dns/reference/503
```

--------------------------------

### cURL Request Example for TSIG Algorithms

Source: https://techdocs.akamai.com/edge-dns/reference/get-data-tsig-algorithms

Example cURL command to fetch the list of TSIG key algorithms from the Akamai Edge DNS API.

```curl
curl --request GET \
     --url https://hostname/config-dns/v2/data/tsig-algorithms
```

--------------------------------

### API Request Header Example

Source: https://techdocs.akamai.com/edge-dns/reference/tsig-keys

An example of an 'Accept' header used in API requests to specify the desired response format.

```bash
--header 'accept: application/json'
```
Tokens:
Raw