Host

Recupero di tutti gli host

Richiesta

Definizione

GET /api/v1/hosts

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura della risorsa.

  Bearer {token}

Parametri query string

Parametro	Tipo	Richiesto	Descrizione
paginate	boolean	Si	Indica se il risultato debba essere paginato.
page	integer	Si se paginate è true	Indice della pagina.
page_size	integer	Si se paginate è true	Numero di elementi visualizzati per pagina.
host_name_search	string	No	Filtra gli Host il cui nome corrisponde interamente o parzialmente alla stringa digitata manualmente dall'utente.
host_name_list	array<string>	No	Filtra gli Host il cui nome corrisponde a uno di quelli presenti nella lista.
server_address	string	No	Filtra gli Host il cui indirizzo IP corrisponde a quello ricercato.
unrelated	boolean	No	Filtra gli Host non associati a nessun Domain Group.

Risposta

Codici di stato

Codice di stato	Messaggio
200	"List of hosts"
400	"Error with pagination fields"
403	"Forbidden"

Body

Attributi

• data.hosts.id string

  Codice identificativo dell'Host.

• data.hosts.first_seen integer

  Data della prima comparsa dell'Host.

• data.hosts.last_seen integer

  Data dell'ultima comparsa dell'Host.

• data.hosts.name string

  Nome dell'Host.

• data.hosts.servers array<string>

  Server a cui l'Host appartiene.

• data.hosts.traffic_sources array<string>

  Sorgenti di traffico configurate per l'Host.

Esempio

{
    "data": {
        "hosts": [
        {
            "first_seen": "2022-02-04T13:06:45.105811Z",
            "id": "kb+UUJ95RqfrxxxxxphO3Uxxxo2Nq4pbxxxxxxgnZrc=",
            "last_seen": "2022-02-04T13:06:45.105811Z",
            "name": "www.service-test.it",
            "servers": [],
            "traffic_sources": []
        }
        ]
    },
    "message": "List of hosts",
    "pagination": {
        "first": 1,
        "last": 1,
        "page": 0,
        "total_count": 1,
        "total_pages": 1
    },
    "status": "ok"
}

Eliminazione di uno specifico host

Richiesta

Definizione

DELETE /api/v1/hosts/{id}

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura della risorsa.

  Bearer {token}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Hosts succesfully deleted"
400	"Error deleting hosts"
403	"Forbidden"

Body

{
  "message": "Hosts succesfully deleted",
  "status": "ok"
}

Eliminazione di più host

Richiesta

Definizione

DELETE /api/v1/hosts

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "host_ids": [
    "kb+UUJ95RqfrIPfmjphO3UEZGo2Nq4pbAp0yNWgnZrc="
  ]
}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Hosts succesfully deleted"
400	"Error deleting hosts"
403	"Forbidden"

Body

{
  "message": "Hosts succesfully deleted",
  "status": "ok"
}