Servizi

Recupero di tutti i servizi

Richiesta

Definizione

GET /api/v1/services

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

Parametri query string

Parametro	Tipo	Richiesto	Descrizione
paginate	boolean	No	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.
service_name_search	string	No	Filtra i servizi il cui nome corrisponde interamente o parzialmente a una stringa.
service_name_list	array<string>	No	Filtra i servizi il cui nome corrisponde a uno di quelli presenti sulla lista.
host_name_search	string	No	Filtra i servizi che contengono un Host il cui nome corrisponde interamente o parzialmente a una stringa digitata manualmente dall'utente.

Risposta

Codici di stato

Codici di stato	Messaggio
200	"List of services"
400	"Error with pagination fields"
403	"Forbidden"

Corpo

Attributi

• data.services.id string

  Codice identificativo del servizio.

• data.services.created_at string

  Data di creazione del servizio.

• data.services.updated_at string

  Data dell'ultimo aggiornamento dei dati del servizio.

• data.services.name string

  Nome del servizio.

• data.services.is_monitored boolean

  Indica se le richieste associate al Domain Group vengono analizzate dal software.

• data.services.hosts array<string>

  Host correlati al servizio.

Esempio

{
"data": {
    "services": [
    {
        "created_at": "2024-01-17T13:12:04Z",
        "description": "Testing service",
        "hosts": [],
        "id": "kb+XUJxxxxxrIPfmjpxxxxxAs9HFJkD0",
        "is_monitored": true,
        "name": "www.xxxxxxxxxxxx.it",
        "updated_at": "2024-01-17T13:12:04Z"
    }
    ]
},
"message": "List of services",
"pagination": {
    "first": 1,
    "last": 1,
    "page": 0,
    "total_count": 1,
    "total_pages": 1
},
"status": "ok"
}

Recupero di un servizio specifico

Richiesta

Definizione

GET /api/v1/services/{id}

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Application retrieved."
400	"Error retrieving service."
403	"Forbidden"

Corpo

{
  "data": {
    "service": {
      "created_at": "2024-01-17T13:12:08Z",
      "description": "Testing service",
      "hosts": [],
      "id": "kb+UUJ95RqfrIPfmjphO3RNAs9HFJkD0",
      "is_monitored": true,
      "name": "www.xxxxxxxxxxxx.it",
      "updated_at": "2024-01-17T13:12:08Z"
    }
  },
  "message": "Application retrieved.",
  "status": "ok"
}

Creazione di un servizio

Riciesta

Definizione

POST /api/v1/services

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "attrs": [
    {
      "description": "Testing service",
      "host_ids": [
        "kb+UUJ95RqfrIPfmjphO3UEZGo2Nq4pbAp0yNWgnZrc="
      ],
      "is_monitored": true,
      "name": "www.service-test.it"
    },
    {
      "description": "Testing service",
      "host_ids": [
        "kb+UUJ95RqfrIPfmjphO3bdcvMr4cF3C5JkygNi4OBA="
      ],
      "is_monitored": true,
      "name": "www.service-test2.it"
    }
  ]
}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Services created succesfully."
400	"Error creating new services."
403	"Forbidden"

Corpo della risposta

{
  "data": {
    "service_names": [
      "www.service-test2.it",
      "www.service-test.it"
    ]
  },
  "message": "Services created succesfully.",
  "status": "ok"
}

Modifica di un servizio specifico

Richiesta

Definizione

PUT /api/v1/services/{id}

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "attrs": {
    "description": "New description"
  }
}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Service updated successfully."
400	"Error updating the service."
403	"Forbidden"

Corpo della risposta

{
  "data": {
    "service": {
      "created_at": "2024-01-17T13:12:10Z",
      "description": "New description",
      "hosts": [],
      "id": "kb+UUJ95RqfrIPfmjphO3RNAs9HFJkD0",
      "is_monitored": true,
      "name": "www.service-test.it",
      "updated_at": "2024-01-17T13:12:10Z"
    }
  },
  "message": "Service updated succesfully.",
  "status": "ok"
}

Eliminazione di un servizio specifico

Richiesta

Definizione

DELETE /api/v1/services/{id}

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Service succesfully deleted"
400	"Error deleting service"
403	"Forbidden"

Corpo della risposta

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

Eliminazione di più servizi

Richiesta

Definizione

DELETE /api/v1/services

Header

• Authorization richiesto

  Token di autenticazione con i privilegi di lettura per la risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "service_ids": [
    "kb+UUJ95RqfrIPfmjphO3RNAs9HFJkD0"
  ]
}

Risposta

Codici di stato

Codici di stato	Messaggio
200	"Services succesfully deleted"
400	"Error deleting services"
403	"Forbidden"

Corpo della risposta

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