# akamai/akamaiopen-edgegrid-golang architecture

> Architecture diagram of the GitHub repository akamai/akamaiopen-edgegrid-golang, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/akamai/akamaiopen-edgegrid-golang
- Repository: https://github.com/akamai/akamaiopen-edgegrid-golang

## Overview

This is Akamai’s EdgeGrid-authenticated Go SDK, providing both request signing and broad REST API support. A caller configures credentials, creates a request through a service package, and sends it to Akamai; the shared session layer executes requests, while EdgeGrid supplies signing. The graph preserves major API families represented in the tree. Many individual service implementations were not excerpted, so their links to shared runtime or remote APIs are shown only where the README or source index supports them.

Main entry points: [`pkg/session/session.go`](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/session/session.go) (HTTP session), [`pkg/papi`](https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/papi) (Property management), [`pkg/edgegrid/signer.go`](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgegrid/signer.go) (EdgeGrid signer), [`pkg/appsec`](https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/appsec) (App & bot security)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_auth["Authentication"]
  node_credentials["Credential config<br/>[config.go]"]
  node_signer["EdgeGrid signer<br/>[signer.go]"]
end

subgraph group_runtime["Request runtime"]
  node_session["HTTP session<br/>[session.go]"]
  node_request["Request builder<br/>[request.go]"]
end

subgraph group_security["Security APIs"]
  node_appsec["App &amp; bot security"]
  node_clientlists["Client lists<br/>[client_list.go]"]
  node_accountprotection["Account protection"]
end

subgraph group_delivery["Delivery APIs"]
  node_papi["Property management"]
  node_cloudlets["Cloudlets<br/>[match_rule.go]"]
  node_edgeworkers["EdgeWorkers &amp; EdgeKV<br/>[edgeworkers.go]"]
  node_purgecache["Cache purge"]
end

subgraph group_platform["Platform APIs"]
  node_iam["Identity management<br/>[api_clients.go]"]
  node_certificates["Certificate services"]
  node_cps["Certificate provisioning<br/>[enrollments.go]"]
  node_networklists["Network lists<br/>[network_list.go]"]
  node_datastream["DataStream<br/>[stream.go]"]
end

node_caller(("Go caller"))
node_akamai{{"Akamai REST APIs"}}

node_caller -->|"configures"| node_credentials
node_caller -->|"calls service"| node_papi
node_credentials -->|"provides credentials"| node_signer
node_caller -->|"signs request"| node_signer
node_papi -->|"builds requests"| node_request
node_papi -->|"executes requests"| node_session
node_iam -->|"executes requests"| node_session
node_clientlists -->|"executes requests"| node_session
node_appsec -.->|"uses session"| node_session
node_accountprotection -->|"uses session"| node_session
node_cloudlets -.->|"uses session"| node_session
node_edgeworkers -->|"uses session"| node_session
node_certificates -->|"executes requests"| node_session
node_cps -->|"uses session"| node_session
node_networklists -->|"uses session"| node_session
node_datastream -.->|"uses session"| node_session
node_purgecache -.->|"uses session"| node_session
node_session -->|"signs requests"| node_signer
node_papi -->|"calls REST API"| node_akamai
node_appsec -->|"calls REST API"| node_akamai
node_clientlists -->|"calls REST API"| node_akamai
node_accountprotection -->|"calls REST API"| node_akamai
node_cloudlets -->|"calls REST API"| node_akamai
node_edgeworkers -->|"calls REST API"| node_akamai
node_purgecache -->|"calls REST API"| node_akamai
node_iam -->|"calls REST API"| node_akamai
node_certificates -->|"calls REST API"| node_akamai
node_cps -->|"calls REST API"| node_akamai
node_networklists -->|"calls REST API"| node_akamai
node_datastream -->|"calls REST API"| node_akamai

click node_credentials "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgegrid/config.go"
click node_signer "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgegrid/signer.go"
click node_session "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/session/session.go"
click node_request "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/internal/request/request.go"
click node_appsec "https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/appsec"
click node_clientlists "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/clientlists/client_list.go"
click node_accountprotection "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/accountprotection/protected_operation.go"
click node_papi "https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/papi"
click node_cloudlets "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/cloudlets/match_rule.go"
click node_edgeworkers "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgeworkers/edgeworkers.go"
click node_purgecache "https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/purgecache"
click node_iam "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/iam/api_clients.go"
click node_certificates "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/mtlskeystore/client_certificates.go"
click node_cps "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/cps/enrollments.go"
click node_networklists "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/networklists/network_list.go"
click node_datastream "https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/datastream/stream.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_credentials,node_signer toneBlue
class node_session,node_request toneAmber
class node_appsec,node_clientlists,node_accountprotection,node_akamai toneMint
class node_papi,node_cloudlets,node_edgeworkers,node_purgecache toneRose
class node_iam,node_certificates,node_cps,node_networklists,node_datastream,node_caller toneIndigo
```

## Components

### Authentication

- [Credential config](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgegrid/config.go): `pkg/edgegrid/config.go`
- [EdgeGrid signer](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgegrid/signer.go): `pkg/edgegrid/signer.go`

### Request runtime

- [HTTP session](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/session/session.go): `pkg/session/session.go`
- [Request builder](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/internal/request/request.go): `internal/request/request.go`

### Security APIs

- [App & bot security](https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/appsec): `pkg/appsec`
- [Client lists](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/clientlists/client_list.go): `pkg/clientlists/client_list.go`
- [Account protection](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/accountprotection/protected_operation.go): `pkg/accountprotection/protected_operation.go`

### Delivery APIs

- [Property management](https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/papi): `pkg/papi`
- [Cloudlets](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/cloudlets/match_rule.go): `pkg/cloudlets/match_rule.go`
- [EdgeWorkers & EdgeKV](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/edgeworkers/edgeworkers.go): `pkg/edgeworkers/edgeworkers.go`
- [Cache purge](https://github.com/akamai/akamaiopen-edgegrid-golang/tree/master/pkg/purgecache): `pkg/purgecache`

### Platform APIs

- [Identity management](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/iam/api_clients.go): `pkg/iam/api_clients.go`
- [Certificate services](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/mtlskeystore/client_certificates.go): `pkg/mtlskeystore/client_certificates.go`
- [Certificate provisioning](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/cps/enrollments.go): `pkg/cps/enrollments.go`
- [Network lists](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/networklists/network_list.go): `pkg/networklists/network_list.go`
- [DataStream](https://github.com/akamai/akamaiopen-edgegrid-golang/blob/master/pkg/datastream/stream.go): `pkg/datastream/stream.go`

### Other components

- **Go caller**
- **Akamai REST APIs**

## Connections

- Go caller → Credential config: configures
- Go caller → Property management: calls service
- Credential config → EdgeGrid signer: provides credentials
- Go caller → EdgeGrid signer: signs request
- Property management → Request builder: builds requests (evidence: `pkg/papi/clientsettings.go`)
- Property management → HTTP session: executes requests (evidence: `pkg/papi/clientsettings.go`)
- Identity management → HTTP session: executes requests (evidence: `pkg/iam/api_clients.go`)
- Client lists → HTTP session: executes requests (evidence: `pkg/clientlists/client_list.go`)
- App & bot security → HTTP session: uses session
- Account protection → HTTP session: uses session (evidence: `pkg/accountprotection/protected_operation.go`)
- Cloudlets → HTTP session: uses session
- EdgeWorkers & EdgeKV → HTTP session: uses session (evidence: `pkg/edgeworkers/edgeworkers.go`)
- Certificate services → HTTP session: executes requests (evidence: `pkg/mtlskeystore/client_certificates.go`)
- Certificate provisioning → HTTP session: uses session (evidence: `pkg/cps/enrollments.go`)
- Network lists → HTTP session: uses session (evidence: `pkg/networklists/network_list.go`)
- DataStream → HTTP session: uses session
- Cache purge → HTTP session: uses session
- HTTP session → EdgeGrid signer: signs requests (evidence: `pkg/session/session.go`)
- Property management → Akamai REST APIs: calls REST API
- App & bot security → Akamai REST APIs: calls REST API
- Client lists → Akamai REST APIs: calls REST API
- Account protection → Akamai REST APIs: calls REST API
- Cloudlets → Akamai REST APIs: calls REST API
- EdgeWorkers & EdgeKV → Akamai REST APIs: calls REST API
- Cache purge → Akamai REST APIs: calls REST API
- Identity management → Akamai REST APIs: calls REST API
- Certificate services → Akamai REST APIs: calls REST API
- Certificate provisioning → Akamai REST APIs: calls REST API
- Network lists → Akamai REST APIs: calls REST API
- DataStream → Akamai REST APIs: calls REST API
