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.
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.
/api/v2/line-tag-domainsList domains for line tags
Authentication: Admin only
Line tag domains object
| Field | Type | Description |
|---|---|---|
domain | string | Access root domain. |
edition | string | Provider edition name; empty when unreadable. |
granularity | string | Line granularity: province=down to province, isp=carrier only, global=default line only, none=lines failed to load or not loaded yet. |
id | integer | Domain id (cname_domains.id). |
line_count | integer | Line count; 0 when granularity is none. |
provider_name | string | DNS provider account name. |
provider_type | string | 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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}