Initialize SOA record

Description

PATCH https://api.netim.com/rest/1.0/domain/{domain}/zone/init-soa/

Set the SOA record of a domain name.

• 
  Parameters
• 
  Responses

URL Parameters

• {domain}

  Domain name to be registered.

  For IDN, you must provide the domain name as ACE string.

Headers

• Authorization
  string

  The Autorization header must start with « Bearer  » followed by the session ID.
  Example: »Autorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26″

• Content-type
  string

  Content type of the request

  Only « application/json » is accepted

Body

REQUIRED

---

• ttl
  integer
  (11)
  Time to live.
• ttlUnit
  string
  (1)
  TTL unit (S/M/H/D/W).
• refresh
  integer
  (11)
  Refresh delay.
• refreshUnit
  string
  (1)
  Refresh unit (S/M/H/D/W).
• retry
  integer
  (11)
  Retry delay.
• retryUnit
  string
  (1)
  Retry unit (S/M/H/D/W).
• expire
  integer
  (11)
  Expire delay.
• expireUnit
  string
  (1)
  Expire unit (S/M/H/D/W).
• minimum
  integer
  (11)
  Minimum delay.
• minimumUnit
  string
  (1)
  Minimum Unit (S/M/H/D/W).

Units

S = Second
M = Minute
H = Hour
D = Day
W = Week

JSON example

{
	"ttl":59,
	"ttlUnit":"M",
	"refresh":59,
	"refreshUnit":"M",
	"retry":59,
	"retryUnit":"M",
	"expire":59,
	"expireUnit":"M",
	"minimum":59,
	"minimumUnit":"M",
}

• 200OK
  The request is processed and the result is returned in the body.

  Body

  Objectapplication/json

  An object of type StructOperationResponse

• 4XX

  Learn more about the possible error codes

Common language examples

• 
  PHP
• 
  JAVA
• 
  PYTHON
• 
  SHELL / CURL

<?php
 
	$ch = curl_init();
 
	$body = array(
		"ttl" => 59,
		"ttlUnit" => "M",
		"refresh" => 59,
		"refreshUnit" => "M",
		"retry" => 59,
		"retryUnit" => "M",
		"expire" => 59,
		"expireUnit" => "M",
		"minimum" => 59,
		"minimumUnit" => "M",
	);
 
	curl_setopt($ch, CURLOPT_URL,"https://api.netim.com/rest/1.0/domain/$domain/zone/init-soa/");
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
	curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $sessionID", "Content-type: application/json"]);
	curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
 
	$result = json_decode(curl_exec ($ch), true);
	$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	curl_close ($ch);
 

import java.util.Base64;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
 
	public static void main(String args[]) throws Exception {
		String sessionID = "12345678";
		String domain = "example.com";
 
		String body = "{"ttl":59,"ttlUnit":"M","refresh":59,"refreshUnit":"M","retry":59,"retryUnit":"M","expire":59,"expireUnit":"M","minimum":59,"minimumUnit":"M",}";
 
		HttpClient client = HttpClient.newHttpClient();
		HttpRequest request = HttpRequest.newBuilder()
			.uri(URI.create("https://api.netim.com/rest/1.0/domain/" + domain + "/zone/init-soa/"))
			.method("PATCH", HttpRequest.BodyPublishers.ofString(body))
			.header("Content-Type", "application/json")
			.header("Accept-Language", "EN")
			.header("Authorization", "Bearer " + sessionID)
			.build();
		HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
 
		String result = response.body().toString();
	}
}

#!/usr/bin/python3
 
import json
import requests
 
domain = 'example.com'
 
url = 'https://api.netim.com/rest/1.0/domain/' + domain + '/zone/init-soa/'
 
sessionId = "1234567"
 
data = {
	"ttl":59,
	"ttlUnit":"M",
	"refresh":59,
	"refreshUnit":"M",
	"retry":59,
	"retryUnit":"M",
	"expire":59,
	"expireUnit":"M",
	"minimum":59,
	"minimumUnit":"M",
}
 
headers = {"Authorization": "Bearer " + sessionId, "Content-Type": "application/json"}
 
 
response = requests.patch(url, headers=headers, data=json.dumps(data))

curl -X PATCH https://api.netim.com/rest/1.0/domain/example.com/zone/init-soa/ 
-H 'Authorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26=' 
-H 'Content-type: application/json' 
-d '{"ttl":59,"ttlUnit":"M","refresh":59,"refreshUnit":"M","retry":59,"retryUnit":"M","expire":59,"expireUnit":"M","minimum":59,"minimumUnit":"M",}'

Need an API Client?
Speed up your integration by using our API client for SOAP