Version 2.4.7.20261116085428 · latest

Line tag domains line-tag-domains

Admin only. Access root domains (excluding retiring ones) to pick from for node line tags, with provider edition and line granularity.

Pick an endpoint to see its example call on the right.

DNS and accessAuthentication: Admin only1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

Line tag domains object

FieldTypeDescription
domainstring Access root domain.
editionstring Provider edition name; empty when unreadable.
granularitystring Line granularity: province=down to province, isp=carrier only, global=default line only, none=lines failed to load or not loaded yet.
Values ["province","isp","global","none"]
idinteger Domain id (cname_domains.id).
line_countinteger Line count; 0 when granularity is none.
provider_namestring DNS provider account name.
provider_typestring DNS provider type.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command