For the complete documentation index, see llms.txt. This page is also available as Markdown.

WebSupport

Configuration

To use this provider, add an entry to creds.json with TYPE set to WEBSUPPORT along with your WebSupport API key and secret. Both are generated in the Security section of the WebSupport admin console.

Example:

creds.json
{
  "websupport": {
    "TYPE": "WEBSUPPORT",
    "api_key": "your-api-key",
    "secret": "your-api-secret"
  }
}

You can also use environment variables:

creds.json
{
  "websupport": {
    "TYPE": "WEBSUPPORT",
    "api_key": "$WEBSUPPORT_API_KEY",
    "secret": "$WEBSUPPORT_SECRET"
  }
}

Metadata

This provider does not recognize any special metadata fields unique to WebSupport.

Usage

An example configuration:

Activation

DNSControl uses the WebSupport REST API v2 to manage your DNS records. Generate an API key and secret in the Security section of the admin console.

Authentication uses HTTP Basic auth where the username is the API key and the password is a per-request HMAC-SHA1 signature derived from the secret. The secret itself is never transmitted.

Notes and limitations

  • Zones must already exist. The API has no endpoint to create a zone or to enumerate all zones, so create-domains and get-zones are not supported. Add domains through the WebSupport portal first.

  • Supported record types: A, AAAA, CNAME, MX, TXT, and SRV.

  • Unsupported record types, due to WebSupport v2 API limitations:

    • NS β€” the API silently ignores attempts to create NS records, so they are rejected to avoid an endless create loop. Apex nameservers are managed by WebSupport and are not exposed through the DNS record API.

    • CAA β€” the API does not return the tag/flags of a CAA record on read, so the record cannot be managed without churn.

    • ALIAS/ANAME β€” WebSupport only allows ANAME at the apex and rejects it when other apex records exist, so it cannot be supported generically.

    • LOC, NAPTR, PTR, SSHFP, TLSA, DS.

  • The provider automatically resolves each domain to its numeric WebSupport service id (used internally by the v2 API); you only need to supply api_key and secret.

Feature Summary

Last updated