IDrive ^� Raccolta di API 360

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

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" 

}

Copia il codice

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

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"

  ]

}

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:

Campi richiesta nidificati (backup_details):

Campi richiesta nidificati (programmatore):

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".

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:

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