Skip to main content
POST
/
subscription
/
dns
Handle DNS Subscription Webhook
curl --request POST \
  --url https://api.altostrat.io/content/subscription/dns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "create",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "signature": "<string>",
  "metadata": {
    "site_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
    "ip_address": "100.64.10.5",
    "policy_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ip_address": "127.0.0.1",
  "created_at": "07 Apr 2025 09:00:21",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_name": "<string>",
  "dnr_subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dns_online": true,
  "dnr_online": true,
  "dnr_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dnr_policy_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer token (obtained via authentication or provided internally).

Body

application/json
​
action
enum<string>
required

The action to perform (create or terminate subscription).

Available options:
create,
terminate
Example:

"create"

​
customer_id
string<uuid>
required

The customer associated with the subscription.

​
product_id
string<uuid>
required

The product ID this subscription relates to (DNS or DNR).

​
subscription_id
string<uuid>
required

The unique identifier for the subscription itself.

​
signature
string
required

HMAC signature to verify payload integrity and authenticity.

​
metadata
object
required

Additional data required for the action.

Example:
{
  "site_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "ip_address": "100.64.10.5",
  "policy_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
}

Response

Subscription 'create' handled successfully.

​
id
string<uuid>

The Site ID associated with the tunnel.

​
ip_address
string<ipv4> | null
​
created_at
string | null

Tunnel creation timestamp (timezone adjusted by resource).

Example:

"07 Apr 2025 09:00:21"

​
policy_id
string<uuid> | null

UUID of the attached DNS policy.

​
policy_name
string | null

Name of the attached DNS policy.

​
dnr_subscription_id
string<uuid> | null
​
dns_subscription_id
string<uuid> | null
​
dns_online
boolean | null

Status of the DNS tunnel endpoint.

​
dnr_online
boolean | null

Status of the BGP/DNR tunnel endpoint.

​
dnr_policy_id
string<uuid> | null

UUID of the attached BGP/DNR policy.

​
dnr_policy_name
string | null

Name of the attached BGP/DNR policy.

⌘I