Заменить делегирование NS

PUT /domains/{domainUuid}/nameservers

operationId: updateDomainNameservers

Требуемые scopes: domains.manage.

Полная замена набора NS (2..6), а не добавление одного сервера. Имена нормализуются в Punycode и сравниваются без регистра; дубликаты запрещены. ipv4/ipv6 необязательны и nullable. Это делегирование, не редактирование A/MX/TXT; распространение DNS не входит в срок выполнения задачи.

HTTP 202 подтверждает только сохранение задачи, не успешную EPP-команду. Сохраните data.uuid; проверяйте GET /operations/{operationUuid} (domains.read) либо события domain.operation.updated. pending/processing не окончательны; completed подтверждает выполнение, failed означает окончательный отказ. При uncertain не создавайте новую операцию: сверка запланирована, смотрите next_check_at (обычно +5 минут). Для результата, который нельзя доказать чтением/журналом, потребуется поддержка. Зарезервированные средства удерживаются до подтверждения или окончательного отказа.

Обязателен Idempotency-Key (1..160 символов). Повтор с тем же ключом должен сохранять метод, путь, query и точные байты JSON. HTTP replay обычно хранится 24 часа и возвращает первоначальный ответ, а не актуальную задачу; проверяйте GET /operations/{operationUuid}. Ключ доменной задачи нельзя переиспользовать после истечения HTTP TTL.

Лимит общий для всех запросов одного API-ключа (rate_limit_per_minute, значение по умолчанию при выдаче ключа 120, индивидуальное значение может отличаться). Окно счётчика 60 секунд. Учитывайте X-RateLimit-Limit и X-RateLimit-Remaining; при 429 дождитесь Retry-After секунд и добавьте jitter. Polling и повторы также расходуют лимит; лимиты реестра независимы.

Scopes: domains.manage

x-async-error-cases:

json

[
  {
    "status": "failed",
    "code": "validation_failed",
    "when": "Обработчик отклонил входные данные/состояние либо получил отказ, классифицированный как ValidationException.",
    "recovery": "Изучите ограничения и журнал через поддержку; новый запрос только после окончательного отказа и устранения причины."
  },
  {
    "status": "failed",
    "code": "registry_rejected",
    "when": "Есть относящийся к этой задаче подтверждённый отказ реестра либо ошибка до отправки.",
    "recovery": "Не повторяйте неизменённую команду; исправьте причину. Резерв освобождается."
  },
  {
    "status": "uncertain",
    "code": "registry_result_unknown",
    "when": "После начала действия нет надёжного подтверждения, произошёл timeout, идентичность ответа не совпала либо сверка пока не установила результат.",
    "recovery": "Не посылайте вторую мутацию. Опрос исходного UUID после next_check_at; при длительном ожидании передайте UUID и request_id поддержке. Резерв не освобождается автоматически."
  }
]

x-input-caveats:

json

[
  "Передавайте синтаксически корректный UUID. Не все методы выполняют явную UUID-валидацию до SQL; поведение malformed UUID не унифицировано и в PostgreSQL может дать 500 вместо 404/422. Это ограничение реализации, не рекомендуемый сценарий клиента."
]

Параметры

domainUuid

Расположение: path. Обязательный. UUID из ответа API. Передавайте корректную строку UUID. Ресурс другого реселлера или среды не раскрывается.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Idempotency-Key

Расположение: header. Обязательный. Обязателен для POST/PUT/PATCH/DELETE, включая check, sync, test, rotate-secret. После trim 1..160 символов. Один ключ на логическую операцию и API-ключ. Повторите те же method/path/query и байты JSON. TTL HTTP replay по умолчанию 24 часа от первого резервирования; не продлевается. Не переиспользуйте ключ для новой операции, доменная задача дополнительно сохраняет связь с ним.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	minLength: 1; maxLength: 160

Пример

json

"webhook-create-20261005-0001"

Тело запроса

Обязательное. JSON body; Content-Type: application/json.

application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["nameservers","reason"]	Схема: DomainNameserversRequest
`$.nameservers`	array	Да	minItems: 2; maxItems: 6	Полный новый набор NS, не патч; после нормализации имена должны быть различны.
`$.nameservers[]`	object	Да	required: ["hostname"]	Схема: DomainNameserver
`$.nameservers[].hostname`	string	Да	maxLength: 253	Полное доменное имя без схемы, пути, порта и завершающей точки. IDN допускается; сервер нормализует регистр и преобразует в Punycode UTS46. ASCII-представление не длиннее 253, каждая метка не длиннее 63 символов. example.kz в примерах не означает доступность для регистрации. Схема: DomainName
`$.nameservers[].ipv4`	string / null	Нет	format: "ipv4"	Glue IPv4 или null; не адрес веб-сайта.
`$.nameservers[].ipv6`	string / null	Нет	format: "ipv6"	Glue IPv6 или null.
`$.reason`	string	Да	minLength: 3; maxLength: 1000	Причина действия для журнала аудита; не передавайте пароли или персональные данные. Схема: DomainReason

Заменить делегирование NS

json

{
  "nameservers": [
    {
      "hostname": "ns1.example.net",
      "ipv4": null,
      "ipv6": null
    },
    {
      "hostname": "ns2.example.net",
      "ipv4": null,
      "ipv6": null
    }
  ],
  "reason": "Смена DNS-провайдера"
}

bash

API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${DOMAIN_UUID:?Set DOMAIN_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"

curl --request PUT "$API_BASE_URL/domains/${DOMAIN_UUID}/nameservers" \
  --connect-timeout 5 --max-time 20 --fail-with-body \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header 'Accept: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "nameservers": [
    {
      "hostname": "ns1.example.net",
      "ipv4": null,
      "ipv6": null
    },
    {
      "hostname": "ns2.example.net",
      "ipv4": null,
      "ipv6": null
    }
  ],
  "reason": "Смена DNS-провайдера"
}'

php

<?php
declare(strict_types=1);

// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
    $value = getenv($name);
    if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
        throw new RuntimeException('Set a valid environment variable: ' . $name);
    }
    return $value;
}

$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/domains/{domainUuid}/nameservers';
$path = str_replace('{domainUuid}', rawurlencode(requiredEnv('DOMAIN_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
    'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
    'Accept: application/json',
    'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
    'Content-Type: application/json',
];
$body = '{
  "nameservers": [
    {
      "hostname": "ns1.example.net",
      "ipv4": null,
      "ipv6": null
    },
    {
      "hostname": "ns2.example.net",
      "ipv4": null,
      "ipv6": null
    }
  ],
  "reason": "Смена DNS-провайдера"
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
    throw new RuntimeException('Cannot initialize cURL.');
}
try {
    if (!curl_setopt_array($handle, [
        CURLOPT_CUSTOMREQUEST => 'PUT',
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_CONNECTTIMEOUT => 5,
        CURLOPT_TIMEOUT => 20,
        CURLOPT_SSL_VERIFYPEER => true,
        CURLOPT_SSL_VERIFYHOST => 2,
        CURLOPT_POSTFIELDS => $body,
        CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
            if (str_starts_with($line, 'HTTP/')) {
                $responseHeaders = [];
            } elseif (str_contains($line, ':')) {
                [$name, $value] = explode(':', $line, 2);
                $responseHeaders[strtolower(trim($name))] = trim($value);
            }
            return strlen($line);
        },
    ])) {
        throw new RuntimeException('Cannot configure cURL.');
    }
    $raw = curl_exec($handle);
    if ($raw === false) {
        throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
    }
    $status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
    unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
    try {
        $data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
    } catch (JsonException $error) {
        if ($status >= 200 && $status < 300) {
            throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
        }
    }
}
if ($status < 200 || $status >= 300) {
    // Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
    throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;

// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
  const value = process.env[name];
  if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
  return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/domains/{domainUuid}/nameservers";
path = path.replaceAll("{domainUuid}", encodeURIComponent(requiredEnv("DOMAIN_UUID")));
const url = baseUrl + path;
const body = `{
  "nameservers": [
    {
      "hostname": "ns1.example.net",
      "ipv4": null,
      "ipv6": null
    },
    {
      "hostname": "ns2.example.net",
      "ipv4": null,
      "ipv6": null
    }
  ],
  "reason": "Смена DNS-провайдера"
}`;
const response = await fetch(url, {
  method: "PUT",
  redirect: 'manual',
  signal: AbortSignal.timeout(20_000),
  headers: {
    Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
    Accept: 'application/json',
    'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
    "Content-Type": "application/json",
  },
  body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
  try { data = JSON.parse(raw); }
  catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
  // Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
  throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);

python

# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener

def required_env(name):
    value = os.environ.get(name, "")
    if not value or "\r" in value or "\n" in value:
        raise RuntimeError("Set a valid environment variable: " + name)
    return value

class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/domains/{domainUuid}/nameservers"
path = path.replace("{domainUuid}", quote(required_env("DOMAIN_UUID"), safe=""))
url = base_url + path
headers = {
    "Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
    "Accept": "application/json",
    "Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
    "Content-Type": "application/json",
}
body = "{\n  \"nameservers\": [\n    {\n      \"hostname\": \"ns1.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    },\n    {\n      \"hostname\": \"ns2.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    }\n  ],\n  \"reason\": \"Смена DNS-провайдера\"\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="PUT")
opener = build_opener(NoRedirect())
try:
    response = opener.open(request, timeout=20)
except HTTPError as error:
    response = error  # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
    status = response.status
    request_id = response.headers.get("X-Request-ID")
    retry_after = response.headers.get("Retry-After")
    raw = response.read()
data = None
if raw and status not in (204, 205):
    try:
        data = json.loads(raw)
    except (ValueError, UnicodeDecodeError):
        if 200 <= status < 300:
            raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
    # Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
    raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)

// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
    "strings"
    "time"
)

func requiredEnv(name string) string {
    value := os.Getenv(name)
    if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
    return value
}

func main() {
    baseURL := os.Getenv("API_BASE_URL")
    if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
    path := "/domains/{domainUuid}/nameservers"
    value0 := requiredEnv("DOMAIN_UUID")
    path = strings.ReplaceAll(path, "{domainUuid}", url.PathEscape(value0))
    endpoint := strings.TrimRight(baseURL, "/") + path
    request, err := http.NewRequest("PUT", endpoint, strings.NewReader("{\n  \"nameservers\": [\n    {\n      \"hostname\": \"ns1.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    },\n    {\n      \"hostname\": \"ns2.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    }\n  ],\n  \"reason\": \"Смена DNS-провайдера\"\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
    request.Header.Set("Content-Type", "application/json")
    client := &http.Client{
        Timeout: 20 * time.Second,
        CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
    }
    response, err := client.Do(request)
    if err != nil { panic("Transport failure; operation result may be unknown") }
    defer response.Body.Close()
    raw, err := io.ReadAll(response.Body)
    if err != nil { panic("Response read failed; operation result may be unknown") }
    requestID := response.Header.Get("X-Request-ID")
    retryAfter := response.Header.Get("Retry-After")
    var data any
    if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
        decoder := json.NewDecoder(strings.NewReader(string(raw)))
        decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
        if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
    }
    if response.StatusCode < 200 || response.StatusCode >= 300 {
        // Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
        panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
    }
    // data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
    fmt.Println("HTTP", response.StatusCode)
}

java

// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class RequestExample {
    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
            throw new IllegalStateException("Set a valid environment variable: " + name);
        }
        return value;
    }
    private static String envOr(String name, String fallback) {
        String value = System.getenv(name);
        return value == null || value.isEmpty() ? fallback : value;
    }
    public static void main(String[] args) throws Exception {
        String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
        String path = "/domains/{domainUuid}/nameservers";
        path = path.replace("{domainUuid}", URLEncoder.encode(requiredEnv("DOMAIN_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
        URI uri = URI.create(baseUrl + path);
        String body = "{\n  \"nameservers\": [\n    {\n      \"hostname\": \"ns1.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    },\n    {\n      \"hostname\": \"ns2.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    }\n  ],\n  \"reason\": \"Смена DNS-провайдера\"\n}";
        HttpRequest request = HttpRequest.newBuilder(uri)
            .timeout(Duration.ofSeconds(20))
            .header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
            .header("Accept", "application/json")
            .header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
            .build();
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(5))
            .followRedirects(HttpClient.Redirect.NEVER)
            .build();
        // Reuse HttpClient in production. A timeout may mean an unknown write result.
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
        int status = response.statusCode();
        String requestId = response.headers().firstValue("X-Request-ID").orElse("");
        String retryAfter = response.headers().firstValue("Retry-After").orElse("");
        String responseBody = (status == 204 || status == 205) ? "" : response.body();
        if (status < 200 || status >= 300) {
            // Decode responseBody with your JSON library; schedule 429 using retryAfter.
            throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
        }
        // Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
        // Do not parse an empty 204 body; 202 means accepted, not completed.
        System.out.println("HTTP " + status);
    }
}

csharp

// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;

static string RequiredEnv(string name)
{
    string? value = Environment.GetEnvironmentVariable(name);
    if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
        throw new InvalidOperationException("Set a valid environment variable: " + name);
    return value;
}

string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/domains/{domainUuid}/nameservers";
path = path.Replace("{domainUuid}", Uri.EscapeDataString(RequiredEnv("DOMAIN_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("PUT"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n  \"nameservers\": [\n    {\n      \"hostname\": \"ns1.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    },\n    {\n      \"hostname\": \"ns2.example.net\",\n      \"ipv4\": null,\n      \"ipv6\": null\n    }\n  ],\n  \"reason\": \"Смена DNS-провайдера\"\n}", Encoding.UTF8, "application/json");

// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
    try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
    catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
    // Inspect data; schedule 429 using retryAfter and preserve the same key/body.
    throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");

Ответы

Условия ошибок и восстановление

HTTP	Код	Когда возникает	Что делать
401	`unauthenticated`	Нет действительного Bearer API-ключа.	Проверьте ключ, срок действия и окружение; не повторяйте бесконечно.
403	`forbidden`	Нет требуемого scope, провайдер/ключ/доступ запрещён.	Проверьте настройки провайдера и scopes ключа.
429	`rate_limit_exceeded`	Исчерпан общий лимит ключа.	Выждите Retry-After; повторы выполняйте с backoff и jitter.
500	`internal_error`	Необработанный сбой инфраструктуры или внешнего драйвера.	Сохраните request_id. Для изменения сначала проверьте существующую задачу; не генерируйте новый ключ вслепую. Формат ответа reverse proxy может отличаться от API.
404	`resource_not_found`	UUID не найден у этого провайдера/окружения, либо запись удалена/скрыта migration hold.	Проверьте UUID, test/live и принадлежность. Не пытайтесь получить ресурс чужого провайдера.
409	`conflict`	Интеграция домена неактивна, migration hold или есть pending/processing/uncertain/awaiting_registry задача.	Дождитесь исходной задачи либо обратитесь к оператору. sync и управление текущим трансфером разрешены при занятой очереди.
422	`validation_failed`	Драйвер не поддерживает действие либо домен не зарегистрирован для требующего регистрации действия.	Проверьте capabilities и состояние домена; не вызывайте неподдерживаемое действие.
409	`conflict`	Ключ уже используется другим запросом или исходный запрос ещё выполняется.	Не изменяйте тело при повторе. Проверьте исходную операцию; используйте новый ключ только для нового намеренного действия.
422	`validation_failed`	Невалидный JSON-пayload/поле или отсутствует Idempotency-Key.	Исправьте данные по error.details; для изменённого запроса создайте новый ключ.
404	`resource_not_found`	Reseller API глобально выключен конфигурацией.	Уточните base URL и включение API у оператора.
422	`validation_failed`	Список NS не содержит 2..6 элементов, hostname некорректен/повторяется после нормализации либо адрес не соответствует ipv4/ipv6.	Исправьте весь набор NS; повтор с изменённым JSON выполняйте под новым ключом.

HTTP 202

Задача принята; результат реестра проверяется отдельно.

Заголовок Idempotency-Replayed: Присутствует со значением true при возврате сохранённого HTTP-ответа.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	const: "true"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["data"]	Схема: DomainOperationEnvelope
`$.data`	object	Да	required: ["uuid","domain_uuid","action","status","result","error","created_at","completed_at","next_check_at"]	Схема: DomainOperation
`$.data.uuid`	string	Да	format: "uuid"	UUID задачи для опроса /operations/{operationUuid}.
`$.data.domain_uuid`	string	Да	format: "uuid"	UUID связанного домена.
`$.data.action`	string	Да	enum: "renew", "transfer", "restore", "nameservers", "contacts", "statuses", "privacy", "sync", "auth_code", "transfer_query", "transfer_approve", "transfer_reject", "transfer_cancel", "host_create", "host_update", "host_delete", "delete"	Тип операции приложения, не команда EPP.
`$.data.status`	string	Да		Состояние очереди. pending: ожидает; processing: выполняется; completed: подтверждена; failed: окончательный отказ; uncertain: результат не подтверждён, выполняется сверка. Не трактовать неизвестное значение как успех.
`$.data.result`	oneOf	Да		Итог не включает сырой EPP-ответ, полную запись домена или HTTP-код реестра. Схема: DomainOperationResult
`$.data.result (oneOf 1)`	array	Да	maxItems: 0	До завершения result сериализуется как [], а не {}.
`$.data.result (oneOf 2)`	object	Да	required: ["domain_uuid","expires_at"]
`$.data.result (oneOf 2).domain_uuid`	string	Да	format: "uuid"	UUID домена.
`$.data.result (oneOf 2).expires_at`	string / null	Да	format: "date-time"	Срок домена после подтверждения; null допустим.
`$.data.result (oneOf 2).auth_code`	string	Нет		Секрет. Только GET, action=auth_code и дополнительный scope domains.auth-code; иначе поле отсутствует. Не логировать.
`$.data.error`	anyOf	Да		Ошибка операции; это не HTTP ErrorEnvelope.
`$.data.error (anyOf 1)`	null	Да
`$.data.error (anyOf 2)`	object	Да	required: ["code","message"]
`$.data.error (anyOf 2).code`	string	Да		Машинный код обработки: registry_rejected, validation_failed, transfer_rejected или registry_result_unknown; новые значения допустимы.
`$.data.error (anyOf 2).message`	string	Да		Безопасное сообщение; не используйте текст как машинный код.
`$.data.created_at`	string / null	Да	format: "date-time"	Время постановки.
`$.data.completed_at`	string / null	Да	format: "date-time"	Заполняется при completed; при failed остаётся null.
`$.data.next_check_at`	string / null	Да	format: "date-time"	Для pending/uncertain: не опрашивать чаще указанного времени; это не SLA. Для прочих статусов null.

Принята операция nameservers (202)

json

{
  "data": {
    "uuid": "019a1234-1000-7000-8000-000000000007",
    "domain_uuid": "019a1234-1000-7000-8000-000000000001",
    "action": "nameservers",
    "status": "pending",
    "result": [],
    "error": null,
    "created_at": "2026-10-05T08:00:00+00:00",
    "completed_at": null,
    "next_check_at": "2026-10-05T08:00:00+00:00"
  }
}

HTTP 401

Отсутствует, неверен, отозван или просрочен Bearer-ключ.

Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (401)

json

{
  "error": {
    "code": "unauthenticated",
    "message": "API credential is missing or invalid.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 403

Нет scope, IP не разрешён, тариф/режим/статус реселлера запрещает действие либо test-ключ обращается к live-only ресурсу.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (403)

json

{
  "error": {
    "code": "forbidden",
    "message": "Source IP address is not allowed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

supportTest (403)

json

{
  "error": {
    "code": "forbidden",
    "message": "Support is available only to live credentials.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 404

Ресурс недоступен в контексте или весь reseller API отключён. Не отличайте чужое от отсутствующего.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (404)

json

{
  "error": {
    "code": "resource_not_found",
    "message": "Not Found",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 409

Конфликт ключа идемпотентности или состояния. Устраните причину.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (409)

json

{
  "error": {
    "code": "conflict",
    "message": "A request with this Idempotency-Key is already processing.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

changedRequest (409)

json

{
  "error": {
    "code": "conflict",
    "message": "Idempotency-Key was already used with a different request.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 422

Ошибка данных или обязательного заголовка. details может быть [].

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (422)

json

{
  "error": {
    "code": "validation_failed",
    "message": "A valid Idempotency-Key header is required.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

fields (422)

json

{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "details": {
      "name": [
        "The name field is required."
      ]
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 429

Квота API-ключа исчерпана. Ждите Retry-After. Собственный 429 не содержит X-RateLimit-Limit/Remaining/Reset.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Заголовок Retry-After: На 429 API: целые секунды до сброса окна, не дата/Unix timestamp. При 0 добавьте jitter. Proxy может вернуть HTTP-date.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	pattern: "^[0-9]+$"

text

Retry-After: 42

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (429)

json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "API rate limit exceeded.",
    "details": {
      "retry_after": 42
    },
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

HTTP 500

Этот HTTP-ответ не определяет результат записи. Сначала сверка; повтор только с прежним ключом и точным телом.

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	string	Да	format: "uuid"

Content-Type: application/json

Поле	Тип	Обязательно в родителе	Ограничения	Описание
`$`	object	Да	required: ["error"]	Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope
`$.error`	object	Да	required: ["code","message","details","request_id"]
`$.error.code`	string	Да		Машинный код; не извлекайте причину из message.
`$.error.message`	string	Да		Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки.
`$.error.details`	oneOf	Да		Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}.
`$.error.details (oneOf 1)`	array	Да	maxItems: 0
`$.error.details (oneOf 2)`	object	Да
`$.error.details (oneOf 2).*`	array	Нет
`$.error.details (oneOf 2).*[]`	string	Да
`$.error.details (oneOf 3)`	object	Да	required: ["retry_after"]; Дополнительные поля запрещены
`$.error.details (oneOf 3).retry_after`	integer	Да	minimum: 0
`$.error.request_id`	string / null	Да	format: "uuid"	UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке.

default (500)

json

{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "details": [],
    "request_id": "11111111-1111-4111-8111-111111111111"
  }
}

Дополнительные примеры из контракта

cURL

bash

BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
# BASE_URL включает /api/reseller/v1. Подставьте реальные UUID своего окружения.
# Для нового намеренного действия задайте новый IDEMPOTENCY_KEY; для повтора сохраните прежний.
curl --request PUT "$BASE_URL/domains/019a1234-1000-7000-8000-000000000001/nameservers" \
  --header "Authorization: Bearer $RESELLER_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "nameservers": [
    {
      "hostname": "ns1.example.net",
      "ipv4": null,
      "ipv6": null
    },
    {
      "hostname": "ns2.example.net",
      "ipv4": null,
      "ipv6": null
    }
  ],
  "reason": "Смена DNS-провайдера"
}'

Машиночитаемый контракт

OpenAPI JSON · OpenAPI YAML · Markdown этой операции

Источники проверки контракта

routes/api/reseller/v1.php
app/Application/ResellerApi/V1/Controller/DomainOperationController.php

Заменить делегирование NS ​

Параметры ​

domainUuid ​

Idempotency-Key ​

Тело запроса ​

application/json ​

Заменить делегирование NS ​

Ответы ​

Условия ошибок и восстановление ​

HTTP 202 ​

Принята операция nameservers (202) ​

HTTP 401 ​

default (401) ​

HTTP 403 ​

default (403) ​

supportTest (403) ​

HTTP 404 ​

default (404) ​

HTTP 409 ​

default (409) ​

changedRequest (409) ​

HTTP 422 ​

default (422) ​

fields (422) ​

HTTP 429 ​

default (429) ​

HTTP 500 ​

default (500) ​

Дополнительные примеры из контракта ​

cURL ​

Машиночитаемый контракт ​

Заменить делегирование NS

Параметры

domainUuid

Idempotency-Key

Тело запроса

application/json

Заменить делегирование NS

Ответы

Условия ошибок и восстановление

HTTP 202

Принята операция nameservers (202)

HTTP 401

default (401)

HTTP 403

default (403)

supportTest (403)

HTTP 404

default (404)

HTTP 409

default (409)

changedRequest (409)

HTTP 422

default (422)

fields (422)

HTTP 429

default (429)

HTTP 500

default (500)

Дополнительные примеры из контракта

cURL

Машиночитаемый контракт