Akamai · OpenAPI Overlay 1.0.0

Akamai Fast Purge - API Evangelist enhancements

3 actions 3 updates security extends openapi/akamai-technologies-ccu-v3-openapi.json

Generated by API Evangelist Written by API Evangelist tooling for Akamai's API. It is a proposal applied on top of the contract, not a document Akamai publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

componentssecurityx-akamai-sourcex-akamai-authx-akamai-host-variablex-reversiblex-consequence

Targets 3

$.info

$.paths['/delete/url/{network}'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: Akamai Fast Purge - API Evangelist enhancements
  version: 1.0.0
extends: openapi/akamai-technologies-ccu-v3-openapi.json
actions:
- target: $
  description: Declare the EdgeGrid security scheme the upstream Akamai spec omits.
  update:
    components:
      securitySchemes:
        EdgeGrid:
          type: apiKey
          in: header
          name: Authorization
          description: 'Akamai EdgeGrid request signing. Send Authorization: EG1-HMAC-SHA256 client_token=...;access_token=...;timestamp=...;nonce=...;signature=
            computed over the method, path, host, selected headers and a hash of the request body, using the credentials
            from your ~/.edgerc section. Documented at https://techdocs.akamai.com/developer/docs/authenticate-with-edgegrid
            - NOT declared in the upstream spec.'
    security:
    - EdgeGrid: []
- target: $.info
  description: Record where this contract came from and how it is authenticated.
  update:
    x-akamai-source: https://github.com/akamai/akamai-apis
    x-akamai-auth: EdgeGrid EG1-HMAC-SHA256
    x-akamai-host-variable: '{hostname} is your per-account API hostname, e.g. akab-xxxxxxxx.luna.akamaiapis.net,
      from ~/.edgerc'
- target: $.paths['/delete/url/{network}'].post
  description: Flag the one genuinely irreversible write on this API.
  update:
    x-reversible: false
    x-consequence: Evicts the object from edge cache. There is no un-purge; recovery is a re-fetch from origin.
      Prefer post-invalidate-url unless eviction is required.
x-generated: '2026-08-30'
x-method: generated
x-note: Captures enhancements only; the upstream openapi/ file is never mutated.