Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"url": "https://techdocs.akamai.com/edge-dns/reference"
},
"info": {
"title": "Akamai APIs",
"title": "Akamai Edge DNS API",
"version": "latest",
"x-vendor-api-version": "v2",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"description": "Akamai APIs provide programmatic access to Akamai platform services including CDN configuration, security, edge logic, and traffic management.\n\nAuthentication: API key in Authorization header \u2014 generate EdgeGrid credentials from Akamai Control Center. Pass as Authorization: Bearer <client_token>.\n\nSource: https://techdocs.akamai.com/developer/docs",
"description": "Akamai Edge DNS API provides programmatic access to authoritative DNS zones, record sets, change lists, and TSIG keys for domains hosted on Akamai's Edge DNS service.\n\nAuthentication: API key in Authorization header \u2014 generate EdgeGrid credentials from Akamai Control Center. Pass as Authorization: Bearer <client_token>.\n\nSource: https://techdocs.akamai.com/developer/docs",
"x-itential-curated": "Reviewed against the repo's common-CRUD-for-automation policy: all 60 upstream operations are already in scope, so the full spec is carried through as -latest. See the repo README for the operation breakdown and the full spec."
},
"paths": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"url": "https://techdocs.akamai.com/edge-dns/reference"
},
"info": {
"title": "Akamai APIs",
"title": "Akamai Edge DNS API",
"version": "v2",
"x-vendor-api-version": "v2",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"description": "Akamai APIs provide programmatic access to Akamai platform services including CDN configuration, security, edge logic, and traffic management.\n\nAuthentication: API key in Authorization header \u2014 generate EdgeGrid credentials from Akamai Control Center. Pass as Authorization: Bearer <client_token>.\n\nSource: https://techdocs.akamai.com/developer/docs"
"description": "Akamai Edge DNS API provides programmatic access to authoritative DNS zones, record sets, change lists, and TSIG keys for domains hosted on Akamai's Edge DNS service.\n\nAuthentication: API key in Authorization header \u2014 generate EdgeGrid credentials from Akamai Control Center. Pass as Authorization: Bearer <client_token>.\n\nSource: https://techdocs.akamai.com/developer/docs"
},
"paths": {
"/changelists": {
Expand Down
52 changes: 42 additions & 10 deletions Akamai/README.md → Akamai/Edge DNS/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
Akamai provides a global content delivery, security, and edge computing platform. This project covers the Akamai Edge DNS API, which manages authoritative DNS zones, record sets, change lists, and TSIG keys for domains hosted on Akamai's Edge DNS service.

This project provides an OpenAPI spec for automating against the Edge DNS REST API via an Integration Model.
This project provides an OpenAPI spec for automating against the Edge DNS REST API via an Integration Model, plus a Studio Project of ready-to-import CRUD workflows built on that model.

## Table of Contents

- [Contents](#contents)
- [Requirements](#requirements)
- [Integration Configuration](#integration-configuration)
- [OpenAPIs](#openapis)
- [`akamai_apis-latest.json`](#akamai_apis-latestjson)
- [`akamai_apis-v2.json`](#akamai_apis-v2json)
- [`akamai_edge_dns_api-latest.json`](#akamai_edge_dns_api-latestjson)
- [`akamai_edge_dns_api-v2.json`](#akamai_edge_dns_api-v2json)
- [Studio Projects](#studio-projects)
- [Akamai Edge DNS Project](#akamai-edge-dns-project)
- [Folder Structure](#folder-structure)
- [Dependencies](#dependencies)

## Contents

| Asset | Description |
|---|---|
| [OpenAPIs/](./OpenAPIs/) | Akamai Edge DNS REST API OpenAPI spec — curated `-latest` plus the full dated spec |
| [Studio Projects/](./Studio%20Projects/) | Itential Platform project containing all 60 workflows in 8 folders |

## Requirements

| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Akamai Edge DNS API | v2 |
| Akamai Edge DNS Integration Model | Required to build automation against the OpenAPI spec |
| `Akamai Edge DNS API:latest` Integration Model | Required to build automation against the OpenAPI spec, and to run the Studio Project below |

## Integration Configuration

Expand All @@ -41,10 +45,10 @@ Generate EdgeGrid credentials in Akamai Control Center (Identity and Access Mana

| Spec | Version | Operations | Description |
|---|---|---|---|
| [`akamai_apis-latest.json`](./OpenAPIs/akamai_apis-latest.json) | latest (curated) | 60 | Reviewed and confirmed already scoped to common CRUD for automation — see breakdown below |
| [`akamai_apis-v2.json`](./OpenAPIs/akamai_apis-v2.json) | v2 | 60 | Full spec for the Akamai Edge DNS API, version v2. |
| [`akamai_edge_dns_api-latest.json`](./OpenAPIs/akamai_edge_dns_api-latest.json) | latest (curated) | 60 | Reviewed and confirmed already scoped to common CRUD for automation — see breakdown below |
| [`akamai_edge_dns_api-v2.json`](./OpenAPIs/akamai_edge_dns_api-v2.json) | v2 | 60 | Full spec for the Akamai Edge DNS API, version v2. |

### `akamai_apis-latest.json`
### `akamai_edge_dns_api-latest.json`

Reviewed and confirmed already scoped to common CRUD for automation (`x-vendor-api-version: v2`, 60 operations). Every operation is CRUD or a provisioning action on the Edge DNS domain model (zones, versions, record sets, change lists, TSIG keys) or reference data those actions require (contracts, groups, nameservers, algorithms) — there is no separate admin, telemetry, or self-introspection surface to exclude, so nothing was removed.

Expand All @@ -59,6 +63,34 @@ Operations included, by category:
- **Zone status checks**: Get DNSSEC status for zones; get secondary-zone transfer status
- **DNS reference data** (inputs required by the operations above, e.g. contract/group IDs for zone creation): Authoritative nameservers, contracts, groups, edge hostnames, record set types, DNSSEC algorithms, TSIG algorithms

### `akamai_apis-v2.json`
A handful of resource names are prefixed with `Akamai` (e.g. `Akamai List Groups`) to avoid colliding with identically-named workflows already published for other products — workflow names are unique across the whole Itential Platform instance, not scoped per-project.

Full, unmodified vendor spec for the Akamai Edge DNS API, version v2 — the vendor's complete API surface, preserved as-is. See `akamai_apis-latest.json` above for the curated subset if you just need common CRUD automation.
### `akamai_edge_dns_api-v2.json`

Full, unmodified vendor spec for the Akamai Edge DNS API, version v2 — the vendor's complete API surface, preserved as-is. See `akamai_edge_dns_api-latest.json` above for the curated subset if you just need common CRUD automation.

## Studio Projects

### Akamai Edge DNS Project

Backed by the **`Akamai Edge DNS API:latest`** Integration Model (see [`akamai_edge_dns_api-latest.json`](./OpenAPIs/akamai_edge_dns_api-latest.json) above). The project contains **60 workflows** organized into **8 folders**.

#### Folder Structure

| Folder | Workflows | Scope |
|---|---|---|
| Change Lists | 15 | Staged edits prior to activation |
| Record Sets | 11 | Individual and bulk record set CRUD, zone file access |
| Zones | 6 | Zone creation and settings |
| Zone Versions | 6 | Version history, diffing, reactivation |
| Bulk Zone Requests | 6 | Async bulk zone create/delete provisioning |
| TSIG Keys | 7 | TSIG key management and zone assignment |
| Zone Status Checks | 2 | DNSSEC and secondary-zone transfer status |
| DNS Reference Data | 7 | Contracts, groups, nameservers, algorithms |

#### Dependencies

| Dependency | Notes |
|---|---|
| `Akamai Edge DNS API:latest` Integration Model | Import from [`akamai_edge_dns_api-latest.json`](./OpenAPIs/akamai_edge_dns_api-latest.json) before importing the project |
| `Akamai Edge DNS` integration instance | Create in **Admin > Integrations** with the connection properties above. Workflows are wired to an integration instance named `Akamai Edge DNS` — update the `adapter_id` value in each workflow task if yours is named differently |
Loading
Loading