Netim Direct
Updated on 18 December 2024

Get DNS zone informations

1 Description
2 Common language examples

Description

GET https://rest.netim.com/3.0/domain/{domain}/zone/info/

Return all informations about a hosting DNS zone.

URL Parameters

  • {domain}
    Domain name.

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

  • 200OK

    The request is processed and the result is returned in the body.

    Body

    arrayapplication/json


    An array containing the DNS zone informations.

     

    Variables

    • domain string (255)
      Domain name.
    • status string
      Zone status.
    • signed bool
      Is the zone signed with DNSSec?
    • status string
      Zone status.
    • ttl integer
      Zone ttl value.
    • ttlUnit string (1)
      Zone ttl unit.
    • refresh integer
      Zone refresh value.
    • refreshUnit string (1)
      Zone refresh unit.
    • retry integer
      Zone retry value.
    • retryUnit string (1)
      Zone retry unit.
    • expire integer
      Zone expire value.
    • expireUnit string (1)
      Zone expire unit.
    • minimum integer
      Zone minimum value.
    • minimumUnit string (1)
      Zone minimum unit.
    • records array
      Zone DNS records.

    Records variables

    • subdomain string
      Record subdomain.
    • type string
      Record type.
    • value string
      Record value.
    • options array StructOptionsZone
      Custom settings of the record as StructZoneParam array

       

      In this response the StructZoneParam array contains one additional value :

      • customTtl Bool

      Does the record have a custom ttl (true) or does it use the zone one (false) ?

  • 4XX

    Learn more about the possible error codes

Perimeter : Applies only to domain names.

Common language examples

<?php
 
    $ch = curl_init();
 
    $domain = "netim.com";
 
    curl_setopt($ch, CURLOPT_URL, "https://rest.netim.com/3.0/domain/$domain/zone/info/");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $sessionID", "Content-type: application/json"]);
    curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
 
 
 
    $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 = "netim.com";
 
 
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://rest.netim.com/3.0/domain/" + domain + "/zone/info/"))
            .method("GET", HttpRequest.BodyPublishers.ofString(""))
            .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 = "netim.com"
url = "https://rest.netim.com/3.0/domain/" + domain + "/zone/info/"
 
sessionId = "1234567"
 
headers = {"Authorization": "Bearer " + sessionId, "Content-Type": "application/json"}
 
 
response = requests.get(url, headers=headers)
curl -X GET https://rest.netim.com/3.0/domain/netim.com/zone/info/ \
-H 'Authorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26=' \
-H 'Content-type: application/json'