API overview - Aptranet Developers

The Aptranet API is a JSON-over-HTTPS control plane for project resources.

Base URL: https://api.aptranet.com

Public product prefixes

Product	Canonical prefix
Cloud CDN	`/cloud-cdn`
Cloud DNS	`/cloud-dns`
Cloud Shield	`/shield`
TLS Manager	`/tls-manager`

The older /cdn and /dns prefixes are compatibility aliases. New integrations should not use them.

First request

curl --request GET \
  --url https://api.aptranet.com/cloud-dns/zones \
  --header "Authorization: Bearer $APTRANET_ACCESS_KEY" \
  --header "Aptranet-Secret: $APTRANET_SECRET" \
  --header "Accept: application/json"

The API key determines the project. Do not send a project ID for API-key-authenticated product requests.

API characteristics

Requests and responses use JSON unless an endpoint returns no body.
Identifier types vary by resource. Use returned IDs without transforming them.
Configuration updates commonly replace a complete configuration document.
204 No Content can represent an empty list or a successful operation with no response document.
Responses are marked private and non-cacheable by the Gateway.
Mutating calls are permission checked before reaching the product service.

Authentication

Send the access key and secret correctly and rotate credentials safely.

Errors

Handle validation, authentication, permission, activation, and service errors.