IDrive ^® Collection d'API 360

IDrive ^® Collection d'API 360

Le IDrive ^® L'API 360 est basée sur l'architecture REST et prend en charge JSON pour les corps de requête et de réponse.

L'authentification est gérée via une clé API. Vous pouvez générer cette clé à partir de Mon compte > Clés API dans votre IDrive ^® Console de gestion 360.

Incluez la clé générée dans chaque requête API en l'ajoutant à l'en-tête HTTP sous Autorisation.

Clé API d'en-tête d'autorisation

Point de terminaison de base :

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

Opérations sur les appareils et l'entreprise

Récupérer le résumé de l'entreprise :

OBTENIR /société

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• company_id (non obligatoire, numéro) : l'ID de l'entreprise

Réponse réussie :

    				{

  "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. Dans la liste des paramètres de la requête, si le champ 'company_id' n'est pas précisé, alors la société de l'utilisateur associée à la clé API sera prise en paramètre
2. Si le 'company_id' correspond à la société de l'utilisateur de la clé API, alors les sous-sociétés de la société de l'utilisateur seront renvoyées dans la charge utile avec la clé 'sub_company_list'
3. Si 'company_id' correspond à une sous-société de l'entreprise de l'utilisateur de la clé API, seuls les détails de cette entreprise cible seront renvoyés
4. La réponse contiendra les détails de la société de l’utilisateur de la clé API et de ses sous-sociétés
5. Le 'configuration_id' renvoyé pour chaque entreprise aura les options 'private_encryption' et 'full_client' désactivées par défaut
6. Si l'option 'private_encryption' ou 'full_client' doit être incluse dans 'configuration_id', utilisez l'API /company/fetch_config_id avec les valeurs de paramètres respectives
7. Le 'setup_link' renvoyé est le lien de téléchargement de la configuration correspondant au 'configuration_id' renvoyé. Ici, par défaut, le lien de configuration pour Windows est renvoyé
8. Si le lien de téléchargement de la configuration correspondant à un autre système d'exploitation doit être téléchargé, utilisez l'API /company/fetch_config_id avec la valeur de paramètre correspondante

Récupérer l'ID de configuration :

GET /company/fetch_config_id

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• company_id (non obligatoire, numéro) : l'ID de l'entreprise
• private_encryption (non obligatoire, booléen) : si le client installé sur l'appareil doit disposer d'un cryptage privé [Expliquez ici ou fournissez un lien vers la documentation sur le cryptage privé]
• full_client (non obligatoire, booléen) : si le client installé sur l'appareil doit avoir accès aux fonctionnalités du client complet [expliquez ici ou fournissez un lien vers la documentation du client complet]
• build_type (non obligatoire, chaîne, insensible à la casse) : le système d'exploitation cible pour lequel le lien de configuration doit être utilisé (WIN, MAC, RPM, DEB, MSI, PKG)

Réponse réussie :

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

Copier le code

1. Dans la liste des paramètres de la requête, si le champ 'company_id' n'est pas précisé, alors la société de l'utilisateur associée à la clé API sera prise en paramètre
2. Dans la liste des paramètres de la requête, si les champs 'private_encryption' et 'full_client' ne sont pas spécifiés, alors la valeur par défaut false sera prise comme valeur du paramètre
3. Dans la liste des paramètres de la requête, si 'build_type' n'est pas spécifié, alors la valeur par défaut de WIN sera prise comme valeur de paramètre

Créer une entreprise :

POST /entreprise

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Corps de la demande :

{

   "name": "idrive",

   "company_id": 1111

}

Réponse réussie : 201 créés

    	{

  "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. Dans le corps de la requête, si le champ 'company_id' n'est pas précisé, alors la société de l'utilisateur associée à la clé API sera prise en paramètre
2. Le champ name est obligatoire dans le payload
3. La réponse après une création réussie contiendra les détails de l'entreprise
4. Le 'configuration_id' renvoyé pour la société nouvellement créée aura les options 'private_encryption' et 'full_client' désactivées par défaut
5. Si l'option 'private_encryption' ou 'full_client' doit être incluse dans 'configuration_id', utilisez l'API /company/fetch_config_id avec les valeurs de paramètres respectives
6. Le 'setup_link' renvoyé est le lien de téléchargement de la configuration correspondant au 'configuration_id' renvoyé. Ici, par défaut, le lien de configuration pour Windows est renvoyé
7. Si le lien de téléchargement de la configuration correspondant à un autre système d'exploitation doit être téléchargé, utilisez l'API /company/fetch_config_id avec la valeur de paramètre correspondante

Récupérer l'entreprise par nom :

OBTENIR /société/nom

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• name (obligatoire, chaîne) : le nom de l'entreprise
• case_sensitive (non obligatoire, booléen) : valeur spécifiant si la correspondance doit être sensible à la casse
• exact (non obligatoire, booléen) : valeur spécifiant si la correspondance doit être exacte/partielle

Réponse réussie :

        [

  {

    "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. Dans la liste des paramètres de la requête, si le champ 'case_sensitive' n'est pas spécifié, alors la valeur par défaut false (insensible à la casse) sera prise pour ce paramètre
2. Dans la liste des paramètres de la requête, si le champ 'exact' n'est pas précisé, alors la valeur par défaut true (correspondance exacte) sera prise pour ce paramètre
3. La réponse contiendra un tableau de détails sur l'entreprise correspondant au nom avec les paramètres spécifiés dans la liste des paramètres de demande au sein de la hiérarchie accessible par la clé API
4. Si le tableau est vide, cela signifie qu'aucune société dans la hiérarchie accessible par la clé API ne correspond au nom avec les paramètres spécifiés

Récupérer le résumé du périphérique :

OBTENIR /device/summary

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• company_id (non obligatoire, numéro) : l'ID de l'entreprise
• device_id (non obligatoire, chaîne) : l'ID de l'appareil

Réponse réussie :

    	[    

{

        "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. Dans la liste des paramètres de la requête, si le champ 'company_id' n'est pas précisé, alors la société de l'utilisateur associée à la clé API sera prise en paramètre
2. Si le champ 'device_id' est spécifié, le résumé de l'appareil uniquement pour cet appareil sera renvoyé dans le tableau de réponse
3. La réponse contiendra les détails de tous les appareils accessibles par l'utilisateur correspondant à la clé API

Mettre à jour la notification par e-mail pour un appareil :

PUT/device/backup_plan/email_notification

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Corps de la demande :

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}

Réponse réussie :

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
		

1. Lorsque la demande aboutit, un code d'état 200 sera renvoyé avec la charge utile de réponse ci-dessus

Créer un plan de sauvegarde :

POST /plan_de_sauvegarde

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• dry_run (non obligatoire, booléen) : Flag spécifié pour exécuter la requête sans modifications, false par défaut

Corps de la demande :

    {

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

}

Champs de demande de base :

Champs de requête imbriqués (backup_details) :

Champs de requête imbriqués (planificateur) :

Réponse réussie :

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}

1. Si la demande aboutit, une réponse avec le code d'état 201 sera renvoyée
2. Dans la réponse réussie, le champ conflicts est un tableau d'objets avec device_id et plan_name existant qui a été remplacé par le plan de sauvegarde créé dans la requête
3. Le champ apply_to contient la chaîne de devices_id séparés par des virgules des périphériques auxquels le plan de sauvegarde a été appliqué
4. Le champ not_applied_to contient la chaîne de devices_id séparés par des virgules des appareils auxquels le plan de sauvegarde n'a pas été appliqué car l'appareil n'est pas actif, c'est-à-dire (bloqué, annulé ou archivé)

Récupérer le plan de sauvegarde :

GET /plan_de_sauvegarde

Consomme : application/json

Produit : application/json

En-têtes de requête :

• Autorisation : Porteur 'api-key'

Paramètres de la demande :

• company_id (non obligatoire, numéro) : l'ID de l'entreprise
• backup_id (non obligatoire, chaîne) : l'ID du plan de sauvegarde

Réponse réussie :

    [

    {

        "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. Dans la liste des paramètres de la requête, si le champ `company_id` n’est pas précisé, alors la société de l’utilisateur associée à la clé API sera prise en paramètre.
2. Dans la liste des paramètres de la requête, si le `company_id` est spécifié et non le `backup_id`, alors tous les plans de sauvegarde présents dans l'entreprise correspondant au `company_id` seront renvoyés
3. Si `backup_id` est spécifié dans la liste des paramètres, alors ce plan de sauvegarde particulier sera récupéré auprès de la société correspondant à `company_id`, si spécifié (sinon la société de l'utilisateur).
4. Si un plan de sauvegarde est appliqué aux appareils, alors les informations correspondant à ces appareils seront présentes dans la réponse sous le tableau « appareils ».
5. Si un plan de sauvegarde est appliqué aux groupes, alors les identifiants de groupe correspondant à ces groupes seront présents dans la réponse sous le tableau « groupes ».

Codes de réponse HTTP :

• 200 - Demande réussie
• 201 - Ressource créée
• 401 - Non autorisé
• 400 - Demande invalide/Paramètres invalides
• 429 - Erreur de dépendance
• 500 - Erreur interne du serveur

Réponse d'erreur :

1. Le "type" d'erreur de niveau de base/supérieur est la cause générique de l'échec de la requête et les "erreurs" spécifiques à la requête sont spécifiées dans un format de tableau
2. Le champ "message" de niveau de base/supérieur n'est pas pertinent pour le traitement, il est présent pour des raisons de lisibilité et décrit le "type" d'erreur de niveau de base/supérieur
3. Si le champ "erreurs" interne n'est pas présent, gérez l'échec de la demande en utilisant le "type" d'erreur de niveau de base/supérieur
4. Le champ interne "erreurs" contient le tableau des erreurs rencontrées lors de l'exécution de l'opération de requête qui contient le "type", le "champ" et le "message"/description d'erreur individuels
5. Dans certains cas, un "champ" sera également renvoyé avec le contenu "erreurs", ce qui indique que l'exécution de la requête a échoué en raison d'une opération effectuée avec ce "champ"

{

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

       }

   ]

}

Types d'erreur :

Error Fields:

• A list of "field" types returned in the inner "errors" payload along with the scenarios in which the "field" might be returned are listed below