IDrive ® Raccolta di API 360

L'IDrive ® L'API 360 è basata sull'architettura REST e supporta JSON sia per i corpi della richiesta che per quelli della risposta.

L'autenticazione viene gestita tramite una chiave API. Puoi generare questa chiave da Il mio account > Chiavi API nel tuo IDrive ® Console di gestione 360.

Includi la chiave generata in ogni richiesta API aggiungendola all'intestazione HTTP sotto Autorizzazione.

Chiave API dell'intestazione dell'autorizzazione

Chiave Autorizzazione
Valore Portatore <LA TUA CHIAVE API>


Endpoint di base:

https://api.idrive360.com/api/msp

Operazioni relative al dispositivo e all'azienda

Recupera riepilogo azienda:

GET /azienda

Consuma: applicazione/json

Produce: applicazione/json


Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • company_id (non obbligatorio, numero): l'ID dell'azienda

Risposta riuscita: 

    				{

  "name": "default",

  "status": 1,

  "company_id": 15020,

  "status_description": "Active",

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

  "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/ATVAWQ17242",

  "sub_company_list": [

    {

      "name": "Test Company",

      "status": 1,

      "company_id": 15806,

      "status_description": "Active",

      "configuration_id": "eyJ0b2tlbiI6IkZBT0JaNDE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

      "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/FAOBZ417242"

    },

    {

      "name": "MSP-1",

      "status": 1,

      "company_id": 15816,

      "status_description": "Active",

      "configuration_id": "eyJ0b2tlbiI6Ik1ZSENKUDE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

      "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/MYHCJP17242"

    },

    {

      "name": "MSP-2",

      "status": 1,

      "company_id": 15817,

      "status_description": "Active",

      "configuration_id": "eyJ0b2tlbiI6Ik5KUEhIOTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

      "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/NJPHH917242"

    }

  ]

}
  1. Nell'elenco dei parametri della richiesta, se il campo 'company_id' non è specificato, l'azienda dell'utente associata alla chiave API verrà presa come parametro
  2. Se 'company_id' corrisponde alla chiave API dell'azienda dell'utente, le sottosocietà dell'azienda dell'utente verranno restituite nel payload con la chiave 'sub_company_list'
  3. Se "company_id" corrisponde a qualsiasi società secondaria dell'azienda dell'utente della chiave API, verranno restituiti solo i dettagli della società target
  4. La risposta conterrà i dettagli dell'azienda dell'utente della chiave API e delle sue sottosocietà
  5. Il 'configuration_id' restituito per ciascuna azienda avrà le opzioni 'private_encryption' e 'full_client' disabilitate per impostazione predefinita
  6. Se l'opzione 'private_encryption' o 'full_client' deve essere inclusa in 'configuration_id', utilizzare l'API /company/fetch_config_id con i rispettivi valori dei parametri
  7. Il "setup_link" restituito è il collegamento per il download del setup corrispondente al "configuration_id" restituito. Qui per impostazione predefinita viene restituito il collegamento di installazione per Windows
  8. Se è necessario scaricare il collegamento per il download della configurazione corrispondente a un altro sistema operativo, utilizzare l'API /company/fetch_config_id con il rispettivo valore del parametro

Recupera ID configurazione:

GET /company/fetch_config_id

Consuma: applicazione/json

Produce: applicazione/json


Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • company_id (non obbligatorio, numero): l'ID dell'azienda
  • private_encryption (non richiesto, booleano): se il client installato nel dispositivo deve avere la crittografia privata [qui spiega o fornisce il collegamento per la documentazione sulla crittografia privata]
  • full_client (non richiesto, booleano): se il client installato nel dispositivo deve avere accesso alle funzionalità del client completo [qui spiega o fornisce il collegamento per la documentazione del client completo]
  • build_type (non richiesto, stringa, senza distinzione tra maiuscole e minuscole): il sistema operativo di destinazione per il quale deve essere utilizzato il collegamento di installazione (WIN, MAC, RPM, DEB, MSI, PKG)

Risposta riuscita: 

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

  "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/ATVAWQ17242" 

}
  1. Nell'elenco dei parametri della richiesta, se il campo 'company_id' non è specificato, l'azienda dell'utente associata alla chiave API verrà presa come parametro
  2. Nell'elenco dei parametri della richiesta, se i campi 'private_encryption', 'full_client' non sono specificati, il valore predefinito false verrà preso come valore del parametro
  3. Nell'elenco dei parametri della richiesta, se 'build_type' non è specificato, il valore predefinito di WIN verrà utilizzato come valore del parametro

Crea azienda:

POST /azienda

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Corpo della richiesta: 

{

   "name": "idrive",

   "company_id": 1111

}

Risposta di successo: 201 creato 

    	{

  "name": "idrive",

  "status": 1,

  "company_id": 12223,

  "status_description": "Active",

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

  "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/ATVAWQ17242"

}
  1. Nel corpo della richiesta, se il campo 'company_id' non è specificato, verrà presa come parametro l'azienda dell'utente associata alla chiave API
  2. Il campo del nome è obbligatorio nel payload
  3. La risposta dopo la creazione con successo conterrà i dettagli dell'azienda
  4. Il 'configuration_id' restituito per la società appena creata avrà le opzioni 'private_encryption' e 'full_client' disabilitate per impostazione predefinita
  5. Se l'opzione 'private_encryption' o 'full_client' deve essere inclusa in 'configuration_id', utilizzare l'API /company/fetch_config_id con i rispettivi valori dei parametri
  6. Il "setup_link" restituito è il collegamento per il download del setup corrispondente al "configuration_id" restituito. Qui per impostazione predefinita viene restituito il collegamento di installazione per Windows
  7. Se è necessario scaricare il collegamento per il download della configurazione corrispondente a un altro sistema operativo, utilizzare l'API /company/fetch_config_id con il rispettivo valore del parametro

Recupera azienda per nome:

GET /azienda/nome

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • nome (richiesto, stringa): il nome dell'azienda
  • case_sensitive (non richiesto, booleano): valore che specifica se la corrispondenza deve fare distinzione tra maiuscole e minuscole
  • esatto (non richiesto, booleano): valore che specifica se la corrispondenza deve essere esatta/parziale

Risposta riuscita: 

        [

  {

    "name": "MSP-1",

    "status": 1,

    "company_id": 15816,

    "status_description": "Active",

    "configuration_id": "eyJ0b2tlbiI6Ik1ZSENKUDE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

    "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/MYHCJP17242"

  },

  {

    "name": "MSP-2",

    "status": 1,

    "company_id": 15817,

    "status_description": "Active",

    "configuration_id": "eyJ0b2tlbiI6Ik5KUEhIOTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

    "setup_link": "https://api.idrive360.com/api/v1/download/setup/win/NJPHH917242"

  }

]
  1. Nell'elenco dei parametri di richiesta, se il campo 'case_sensitive' non è specificato, per questo parametro verrà utilizzato il valore predefinito false (senza distinzione tra maiuscole e minuscole).
  2. Nell'elenco dei parametri di richiesta, se il campo 'esatto' non è specificato, per questo parametro verrà utilizzato il valore predefinito true (corrispondenza esatta)
  3. La risposta conterrà una serie di dettagli dell'azienda corrispondenti al nome con le impostazioni specificate nell'elenco dei parametri della richiesta all'interno della gerarchia accessibile dalla chiave API
  4. Se l'array è vuoto significa che nessuna azienda nella gerarchia accessibile dalla chiave API corrisponde al nome con le impostazioni specificate

Recupera riepilogo dispositivo:

GET /device/summary

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • company_id (non obbligatorio, numero): l'ID dell'azienda
  • device_id (non obbligatorio, stringa): l'ID del dispositivo

Risposta riuscita: 

    	[    

{

        "name": "test-office",

        "status": "offline",

        "device_id": wvlgllxuuaomn4bk4atfljznjyvsfhfeo5g6wgyart3osefi",

        "company_id": "1111",

        "custom_tag": " ",

        "os": "linux",

        "backup_status": "Success",

        "version": "1.0.21",

        "last_backup": "2025-06-11T11:12:58.000",

        "next_backup": null,

        "group_name": "Linux"

}

]
  1. Nell'elenco dei parametri della richiesta, se il campo 'company_id' non è specificato, l'azienda dell'utente associata alla chiave API verrà presa come parametro
  2. Se viene specificato il campo 'device_id', nell'array di risposta verrà restituito il riepilogo del dispositivo solo di quel dispositivo
  3. La risposta conterrà i dettagli del dispositivo di tutti i dispositivi accessibili dall'utente corrispondenti alla chiave API
Nome campo Descrizione
nome Il nome del dispositivo
stato Lo stato attuale del dispositivo (ad esempio online, offline, bloccato, archiviato)
id_dispositivo L'ID dispositivo associato al dispositivo
id_azienda L'ID azienda associato al dispositivo
tag_personalizzato Qualsiasi tag personalizzato assegnato al dispositivo
os Il sistema operativo del dispositivo
stato_backup Lo stato dell'ultimo backup (ad esempio, riuscito, non riuscito, in corso, annullato)
versione La versione dell'applicazione di backup installata sul dispositivo
ultimo_backup Il timestamp dell'ultimo backup riuscito
backup_successivo Il timestamp del prossimo backup pianificato
nome_gruppo Il nome del gruppo a cui appartiene il dispositivo

Aggiorna notifica e-mail per un dispositivo:

PUT/dispositivo/piano_di_backup/notifica_e-mail

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Corpo della richiesta: 

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}
Nome campo Descrizione
id_dispositivo L'ID dispositivo associato al dispositivo
set_backup Il nome del set di backup (ad esempio, “DEFAULT”, “LOCAL”, "ENTIRE_MACHINE", "MAPPED_DRIVE", "EXPRESS")
digitare La frequenza della notifica email (ad esempio, "SEMPRE", "ON_FAILURE", "MAI"). Se la frequenza è “MAI” le notifiche verranno disabilitate
e-mail Un array di indirizzi email per ricevere la notifica

Risposta riuscita: 

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
  1. Quando la richiesta ha esito positivo, verrà restituito un codice di stato 200 con il payload della risposta sopra

Crea piano di backup:

POST /piano_backup

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • dry_run (non richiesto, booleano): flag specificato per eseguire la richiesta senza modifiche, false per impostazione predefinita

Corpo della richiesta: 

    {

  "company_id": 14366,

  "device_ids": [

    "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

  ],

  "group_ids": [],

  "name": "namechange_new_1",

  "backup_details": {

    "what_to_backup": "FILE_FOLDER",

    "where_to_backup": "CLOUD"

    "items_to_backup": [

      "[All Profiles Folder]"

    ],

    "local_dest_path": "C:\\Users\\Mark\\IDrive360LocalDest"

  },

  "scheduler": {

    "disable_schedule": false,

    "start_missed_backup": false,

    "frequency_type": "MONTHLY",

    "time": "17:40:30",

    "months": [

      "JANUARY",

      "FEBRUARY"

    ],

    "dates": [

      "23",

      "25"

    ],

    "days": [

      "SUN",

      "MON"

    ], 

    "cutoff_time": "07:00:00",

    "email": [

      "mark@idrive.com"

    ],

    "send_email_notification": "ALWAYS"

  },

  "exclude_hidden": true,

  "exclude_system": true,

  "enable_cdp": true,

  "cdp_frequency": "TEN_MINUTES",

  "exclude_partial": 
"*.appicon,*.appinfo,*.cab,*.dl_,*.dll,*.dmg,*.drk,*.exe,*.fdd,*.hdd,*.hds,*.iso,*.ithmb,*.log,*.mem,*.menudata,*.
msi,*.nvram,*.o,*.ost,*.pva,*.pvi,*.pvm,*.pvs,*.qtch,*.sparseimage,*.sys,*.vdi,*.vhd,*.vhdx,*.vmc,*.vmdk,*.vmem,*.vmsd,
*.vmsn,*.vmss,*.vmx,*.vmxf,*.vo1,*.vo2,*.vsv,*.vud,*.wab~,*.wim"

}

Campi richiesta base:

Nome campo Obbligatorio/facoltativo Descrizione
id_azienda Facoltativo L'ID azienda con cui deve essere creato il piano di backup. Se non specificato, verrà utilizzata l'azienda dell'utente della chiave API
ID_dispositivo Opzionale (Array) Un array di ID dispositivo a cui verrà applicato il piano di backup
ID_gruppo Opzionale (Array) Un array di ID di gruppo a cui verrà applicato il piano di backup
nome Obbligatorio Il nome del nuovo piano di backup
dettagli_backup Obbligatorio (Oggetto) Contiene dettagli sugli elementi di cui eseguire il backup e sulla posizione in cui sono archiviati i backup
pianificatore Obbligatorio (Oggetto) Contiene dettagli sulla pianificazione del backup, sulla frequenza e sulle notifiche e-mail
esclude_nascosto Facoltativo (booleano) Se impostato su true, i file/cartelle nascosti verranno esclusi dal backup (N/D per i backup di ENTIRE_MACHINE, verranno ignorati se specificato)
sistema_escludi Facoltativo (booleano) Se impostato su true, i file/cartelle di sistema verranno esclusi dal backup (N/D per i backup di ENTIRE_MACHINE, verranno ignorati se specificato)
abilita_cdp Facoltativo (booleano) Se impostato su true, la protezione continua dei dati (CDP) sarà abilitata (N/D per i backup di ENTIRE_MACHINE, verrà ignorato se specificato)
cdp_frequenza Facoltativo (stringa) La frequenza per CDP. Obbligatorio se Enable_cdp è vero. (ad esempio, "REAL_TIME", "TEN_MINUTES", "THIRTY_MINUTES", "SIXTY_MINUTES") (N/D per i backup di ENTIRE_MACHINE, verrà ignorato se specificato)
escludere_parziale Facoltativo (stringa) Una stringa di estensioni di file separate da virgole da escludere parzialmente dal backup (N/D per i backup di INTERE_MACHINE, verrà ignorato se specificato)

Campi richiesta nidificati (backup_details):

Nome campo Obbligatorio/facoltativo Descrizione
cosa_di_backup Obbligatorio (Stringa) 1. Backup di file/cartelle: esegui il backup di singoli elementi, utilizza regole di policy predefinite o crea policy personalizzate in items_to_backup
2. Backup dell'intera macchina: è applicabile solo ai PC Windows ed eseguirà il backup di tutte le unità nel disco rigido interno. Nel caso in cui i dispositivi o i gruppi selezionati includano Mac o Linux, non verranno considerati per il backup (ad esempio, "FILE_FOLDER", "INTERE_MACHINE")
dove_fare_il_backup Obbligatorio (Stringa) La destinazione del backup (ad esempio, "CLOUD", "LOCAL")
elementi_in_backup Opzionale (Array) Un array di percorsi o regole di policy predefinite da includere nel backup
(ad esempio, delle regole dei criteri predefinite "[PROFILEDEFAULTFOLDERS]", "[Cartella tutti i profili]", "%ALLUSERSPROFILE%", "%PROGRAMFILES%", "%WINDIR%")
(ad esempio, di percorsi personalizzati "C:\Data\*.log", "C:\Data\Finance\", "C:\Data\Finance\F.log", "C:\Users\*\Desktop\", "/Users/JOHN/Desktop/*.txt", "/Users/JOHN/Desktop/F.txt", "/Users/*/Desktop/")
Richiesto se è selezionato il backup di file/cartelle
percorso_destinazione_locale Facoltativo (stringa) Il percorso di destinazione locale per il backup (se backup_set è LOCAL) Se non specificato, i backup locali verranno eseguiti nella posizione predefinita

Campi richiesta nidificati (programmatore):

Nome campo Obbligatorio/facoltativo Descrizione
disabilita_programma Facoltativo (booleano) Se impostato su true, la pianificazione del backup verrà disabilitata. Il valore predefinito è falso
start_missed_backup Facoltativo (booleano) Se impostato su true, i backup pianificati persi verranno avviati automaticamente quando il dispositivo torna online. Il valore predefinito è falso
tipo_frequenza Obbligatorio (Stringa) Il tipo di frequenza per la pianificazione (ad esempio, "MENSILE", "SETTIMANALE", "GIORNALIERO", "ORARIO", "IMMEDIATO")
tempo Obbligatorio (Stringa) L'ora del giorno per il backup pianificato nel formato HH:MM:SS
mesi Obbligatorio (array) Un array di mesi in cui deve essere eseguito il backup (se Frequency_Type è "MONTHLY", ad esempio, per applicarlo a mesi particolari "GENNAIO", "FEBBRAIO" o per applicarlo a tutti i mesi "TUTTI")
date Obbligatorio (array) Un array di giorni del mese in cui deve essere eseguito il backup (se Frequency_Type è "MONTHLY") (ad esempio, "1, 2, 3, 4, 30, 31", per eseguire tutti i giorni del mese "ALL_DAYS", per eseguire l'ultimo giorno del mese "LAST_DAY")
giorni Obbligatorio(Array) Un array di giorni della settimana in cui deve essere eseguito il backup (se Frequency_Type è "WEEKLY") (ad esempio, "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT", per l'esecuzione in tutti i giorni "ALL")
modalità_giornaliera Obbligatorio(Stringa) I giorni in cui deve essere eseguito il backup (se Frequency_Type è "DAILY") (ad esempio, "ALL_DAYS","WEEKDAYS")
limite_orario Opzionale (Array) L'ora del giorno dopo la quale un backup pianificato deve essere interrotto nel formato HH:MM:SS
e-mail Opzionale (Array) Una serie di indirizzi email per ricevere notifiche di backup
invia_e-mail_notifica Facoltativo (stringa) La frequenza con cui inviare notifiche email (ad esempio, "SEMPRE", "ON_FAILURE", "MAI"). Se la frequenza è "MAI", le notifiche email verranno disabilitate

Risposta riuscita: 

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}
  1. Se la richiesta ha esito positivo, verrà restituita una risposta con il codice di stato 201
  2. Nella risposta di successo, il campo conflitti è un array di oggetti con device_id e plan_name esistente che è stato sostituito con il piano di backup creato nella richiesta
  3. Il campo apply_to contiene la stringa di device_id separati da virgole dei dispositivi a cui è stato applicato il piano di backup
  4. Il campo not_applied_to contiene la stringa di device_id separati da virgole dei dispositivi a cui non è stato applicato il piano di backup perché il dispositivo non è attivo, ovvero (bloccato, annullato o archiviato)

Recupera piano di backup:

OTTIENI /backup_plan

Consuma: applicazione/json

Produce: applicazione/json

Intestazioni della richiesta:

  • Autorizzazione: portatore 'api-key'

Parametri della richiesta:

  • company_id (non obbligatorio, numero): l'ID dell'azienda
  • backup_id (non obbligatorio, stringa): l'ID del piano di backup

Risposta riuscita: 

    [

    {

        "backup_id": "679251",

        "name": "testingplan",

        "backup_set": "ENTIRE_MACHINE",

        "is_backup_enabled": true,

        "backup_pending_on": "hflafghwiv33fwbycnzfgnpbaocbrorndnakn6uqhmbbpsbua6",

        "exclude_system": true,

        "exclude_hidden": true,

        "backup_details": {

            "what_to_backup": "ENTIRE_MACHINE",

            "where_to_backup": "CLOUD"

        },

        "cdp_enabled": false,

        "schedule_info": {

            "email": "mark@idrive.com",

            "start_missed_backup": false,

            "days": [

                "MON",

                "TUE",

                "WED",

                "THU",

                "FRI"

            ],

            "frequency_type": "DAILY",

            "time": "16:45:00",

            "cutoff_time": "09:00:00",

            "send_email_notification": "NEVER",

            "scheduler_disabled": falsev
        },

        "devices": [

            {

                "os": "windows",

                "version": "6.8.2.11",

                "name": "MARK-DAV1",

                "status": "online",

                "device_id": "hflafghwiv33fwbycnzfgnpbaocbrorndnakn6uqhmbbpsbua6",

                "company_id": "51324",

                "custom_tag": "Mark",

                "backup_status": "Failure",

                "last_backup": "2026-02-17T05:39:20.120",

                "next_backup": "2026-02-17T11:15:00.000",

                "backup_failure_reason": "NA",

                "next_scheduled_backupset_name": "DEFAULT",

                "user_backup_sets": {

                    "DEFAULT": {

                        "backup_id": "814757",

                        "backup_name": "CDPSIXTYMINUTESWithWIN"

                    },

                    "LOCAL": {

                        "backup_id": "367507",

                        "backup_name": "LOCALPLAN"

                    },

                    "ENTIRE_MACHINE": {

                        "backup_id": "679251",

                        "backup_name": "ENTIREPLAN"

                    }

                }

            }

        ]

    }

]
  1. Nell'elenco dei parametri della richiesta, se il campo `company_id` non è specificato, verrà presa come parametro l'azienda dell'utente associata alla chiave API.
  2. Nella lista dei parametri della richiesta, se viene specificato `company_id` e non `backup_id`, allora verranno restituiti tutti i piani di backup presenti nell'azienda corrispondenti a `company_id`
  3. Se nell'elenco dei parametri è specificato "backup_id", quel particolare piano di backup verrà recuperato dalla società corrispondente a "company_id", se specificato (l'azienda dell'altro utente).
  4. Se ai dispositivi viene applicato un piano di backup, le informazioni corrispondenti a tali dispositivi saranno presenti nella risposta nell'array "dispositivi".
  5. Se ai gruppi viene applicato un piano di backup, gli ID gruppo corrispondenti a tali gruppi saranno presenti nella risposta nell'array "groups".
Nome campo Descrizione
“_backup_abilitato Lo stato del piano di backup (abilitato/disabilitato)
backup_applicato_su Gli ID_dispositivo a cui è stato applicato correttamente il piano di backup
backup_in attesa_il Gli ID_dispositivo a cui non è stato ancora applicato il piano di backup
backup_fallito_on Gli ID_dispositivo per cui l'applicazione del piano di backup non è riuscita
dispositivi L'elenco dei dispositivi a cui è stato applicato il piano di backup
gruppi L'elenco degli ID di gruppo a cui è stato applicato il piano di backup

Codici di risposta HTTP:

  • 200 - Richiesta riuscita
  • 201 - Risorsa creata
  • 401 - Non autorizzato
  • 400 - Richiesta non valida/Parametri non validi
  • 429 - Errore di dipendenza
  • 500 - Errore interno del server

Risposta all'errore:

  1. Il "tipo" di errore di livello base/superiore è la causa generica del fallimento della richiesta e gli "errori" specifici della richiesta sono specificati in un formato array
  2. Il campo "messaggio" di livello base/superiore è irrilevante per l'elaborazione, presente per la leggibilità che descrive il "tipo" di errore di livello base/superiore
  3. Se il campo "errori" interno non è presente, gestire l'errore della richiesta utilizzando il "tipo" di errore di livello base/superiore
  4. Il campo interno "errori" contiene l'array di errori riscontrati durante l'esecuzione dell'operazione di richiesta che contiene il singolo errore "tipo", "campo" e "messaggio"/descrizione
  5. In alcuni casi verrà restituito anche un "campo" con il contenuto "errori", che indica che l'esecuzione della richiesta non è riuscita a causa di un'operazione eseguita con quel "campo" 
{

   "ok": false,

   "type": "entity_not_found",

   "message": "The specified entity being addressed either does not exist or is invalid. The request should not be retried without modification or until the indicated entity is set up.",

   "code": 400,

   "errors": [

       {

           "type": "entity_not_found",

           "field": "device_id",

           "message": "The entity corresponding to the device id specified cannot be found, not-active or not-configured"

       }

   ]

}

Tipi di errore:

Tipo di errore Tipo di errore di base Codice di stato Descrizione
intestazione_autorizzazione_mancante autenticazione_non riuscita 401 Manca l'intestazione di autorizzazione con API_KEY
malformed_authorization_header autenticazione_non riuscita 401 L'intestazione dell'autorizzazione non ha un formato corretto, il formato accettato è 'Bearer <API_KEY>'
admin_company_not_active stato_non valido 400 L'azienda dell'amministratore associato all'API_KEY è inattiva
amministratore_non_attivo stato_non valido 400 L'amministratore associato all'API_KEY è inattivo
privilegi_insufficienti autenticazione_non riuscita 401 L'utente associato all'API_KEY non è autorizzato ad accedere a questa risorsa a causa di privilegi insufficienti, contattare l'amministratore
accesso_limitato richiesta_non valida 400 Descrizione personalizzata basata sull'errore di esecuzione della richiesta
errore_elaborazione errore_elaborazione 500 Si è verificato un errore di elaborazione interna durante l'analisi dell'oggetto JSON
errore_interno errore_interno 500 Si è verificato un errore interno durante l'elaborazione della richiesta
entità_creazione_failed errore_interno 500 Impossibile creare l'entità nel sistema
entità_non_trovata entità_non_trovata 400 L'entità richiesta non è stata trovata nel sistema
richiesta_non valida richiesta_non valida 400 Descrizione personalizzata basata sull'errore di esecuzione della richiesta
parametro_non valido parametro_non valido 400 Descrizione personalizzata basata sull'errore di esecuzione della richiesta
stesso_stato stesso_stato 400 Descrizione personalizzata basata sull'errore di esecuzione della richiesta
eccezione_dipendenza eccezione_dipendenza 429 Descrizione personalizzata basata sull'errore di esecuzione della richiesta

Campi di errore:

  • Di seguito è riportato un elenco di tipi di "campo" restituiti nel payload "errori" interno insieme agli scenari in cui il "campo" potrebbe essere restituito
Campo Scenari
id_dispositivo L'ID del dispositivo specificato nella richiesta
id_azienda L'ID azienda specificato nella richiesta o l'ID azienda dell'amministratore corrispondente a API_KEY
server_notifica Qualsiasi problema di dipendenza durante l'accesso ai nostri server di backup
e-mail Indirizzi email specificati nella richiesta
set_backup Qualsiasi azione che attiva modifiche al piano di backup di un dispositivo
politica_di_backup Qualsiasi azione che attiva modifiche al piano di backup di un dispositivo
backup_policy_schedule Qualsiasi azione che attiva modifiche alla pianificazione del piano di backup di un dispositivo
stato Stato specificato nella richiesta
nome Nomi specificati nella richiesta