Netim Direct
Updated on 8 January 2024

Get host list

1 Description
2 Common language examples

Description

POST https://rest.netim.com/3.0/hosts/

Returns a list of hosts corresponding to the filters

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

OPTIONAL

  • filters array
    Search filters

    •  

    Available filter keys:

    • name (Host name)
    • ipv4 (IPv4 address)
    • ipv6 (IPv6 address)

    For more information on filters for list functions, please consult the corresponding page.

 

JSON example

{
    "filters": {
        "name": {
            "LIKE": "foo%"
        },
        "ipv4": {
            "<>": "1.1.1.1"
        },
        "ipv6": {
            "=": ""
        }
    }
}

Common language examples

$data = array(
    'filters' => array(
        'name' => ['LIKE' => 'ns%'],
        'ipv4' => ['<>' => '1.1.1.1'],
        'ipv6' => ['=' => '']
    ),
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://rest.netim.com/3.0/hosts/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Authorization: Bearer ' . $sessionID,
    'Content-Type: application/json'
));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
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 body = "{\"filters\":{\"name\":{\"LIKE\":\"foo%\"},\"ipv4\":{\"<>\":\"1.1.1.1\"},\"ipv6\":{\"=\":\"\"}}}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://rest.netim.com/3.0/hosts/"))
                .method("POST", 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

url = 'https://rest.netim.com/3.0/hosts/'
sessionId = "12345678"

headers = {"Authorization": "Bearer " + sessionId, "Content-Type": "application/json"}
body = {"filters":{"name":{"LIKE":"ns%"},"ipv4":{"<>":"1.1.1.1"},"ipv6":{"=":""}}}

response = requests.post(url, headers=headers, json=body)
curl -X POST 'https://rest.netim.com/3.0/hosts/' \
-H 'Authorization: Bearer 12345678' \
-H "Content-type: application/json" \
-d '{"filters":{"name":{"LIKE":"ns%"},"ipv4":{"<>":"1.1.1.1"},"ipv6":{"=":""}}}'