IDrive^® 360 API-Sammlung

IDrive^® 360 API-Sammlung

Die IDrive^® 360 API basiert auf der REST-Architektur und unterstützt JSON sowohl für Anfrage- als auch für Antwortkörper.

Die Authentifizierung erfolgt über einen API-Schlüssel. Sie können diesen Schlüssel in Ihrer IDrive^® 360-Verwaltungskonsole unter Mein Konto > API-Schlüssel generieren.

Fügen Sie den generierten Schlüssel in jede API-Anfrage ein, indem Sie ihn im HTTP-Header unter Authorization angeben.

Autorisierungs-Header API-Schlüssel

Basis-Endpunkt:

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

Geräte- und Unternehmensoperationen

Unternehmensübersicht abrufen:

GET /company

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• company_id (nicht erforderlich, Zahl): Die Unternehmens-ID

Erfolgreiche Antwort:

    				{

  "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. In der Anfrage-Parameterliste: Wenn das Feld 'company_id' nicht angegeben ist, wird das Unternehmen des Benutzers mit dem API-Schlüssel als Parameter verwendet
2. Wenn die 'company_id' dem Unternehmen des API-Schlüssel-Benutzers entspricht, werden die Unterunternehmen im Payload unter dem Schlüssel 'sub_company_list' zurückgegeben
3. Wenn die 'company_id' einem Unterunternehmen des API-Schlüssel-Benutzers entspricht, werden nur die Details des Zielunternehmens zurückgegeben
4. Die Antwort enthält die Details des Unternehmens des API-Schlüssel-Benutzers und seiner Unterunternehmen
5. Die für jedes Unternehmen zurückgegebene 'configuration_id' hat standardmäßig die Optionen 'private_encryption' und 'full_client' deaktiviert
6. Wenn 'private_encryption' oder 'full_client' in der 'configuration_id' enthalten sein soll, verwenden Sie die /company/fetch_config_id API mit den entsprechenden Parameterwerten
7. Der zurückgegebene 'setup_link' ist der Download-Link für das Setup entsprechend der zurückgegebenen 'configuration_id'. Standardmäßig wird der Setup-Link für Windows zurückgegeben
8. Wenn der Download-Link für das Setup eines anderen Betriebssystems benötigt wird, verwenden Sie die /company/fetch_config_id API mit dem entsprechenden Parameterwert

Konfigurations-ID abrufen:

GET /company/fetch_config_id

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• company_id (nicht erforderlich, Zahl): Die Unternehmens-ID
• private_encryption (nicht erforderlich, Boolescher Wert): Ob der auf dem Gerät installierte Client private Verschlüsselung verwenden soll
• full_client (nicht erforderlich, Boolescher Wert): Ob der auf dem Gerät installierte Client Zugriff auf Full-Client-Funktionen haben soll
• build_type (nicht erforderlich, Zeichenfolge, Groß-/Kleinschreibung egal): Das Zielbetriebssystem, für das der Setup-Link verwendet werden soll (WIN, MAC, RPM, DEB, MSI, PKG)

Erfolgreiche Antwort:

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

1. In der Anfrage-Parameterliste: Wenn das Feld 'company_id' nicht angegeben ist, wird das Unternehmen des Benutzers mit dem API-Schlüssel als Parameter verwendet
2. In der Anfrage-Parameterliste: Wenn die Felder 'private_encryption' und 'full_client' nicht angegeben sind, wird der Standardwert false als Parameterwert verwendet
3. In der Anfrage-Parameterliste: Wenn 'build_type' nicht angegeben ist, wird der Standardwert WIN als Parameterwert verwendet

Unternehmen erstellen:

POST /company

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Text:

{

   "name": "idrive",

   "company_id": 1111

}

Erfolgreiche Antwort: 201 Erstellt

    	{

  "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. Im Anfrage-Text: Wenn das Feld 'company_id' nicht angegeben ist, wird das Unternehmen des Benutzers mit dem API-Schlüssel als Parameter verwendet
2. Das Feld 'name' ist im Payload erforderlich
3. Die Antwort nach erfolgreicher Erstellung enthält die Details des Unternehmens
4. Die für das neu erstellte Unternehmen zurückgegebene 'configuration_id' hat standardmäßig die Optionen 'private_encryption' und 'full_client' deaktiviert
5. Wenn 'private_encryption' oder 'full_client' in der 'configuration_id' enthalten sein soll, verwenden Sie die /company/fetch_config_id API mit den entsprechenden Parameterwerten
6. Der zurückgegebene 'setup_link' ist der Download-Link für das Setup entsprechend der zurückgegebenen 'configuration_id'. Standardmäßig wird der Setup-Link für Windows zurückgegeben
7. Wenn der Download-Link für das Setup eines anderen Betriebssystems benötigt wird, verwenden Sie die /company/fetch_config_id API mit dem entsprechenden Parameterwert

Unternehmen nach Name abrufen:

GET /company/name

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• name (erforderlich, Zeichenfolge): Der Unternehmensname
• case_sensitive (nicht erforderlich, Boolescher Wert): Gibt an, ob die Übereinstimmung Groß-/Kleinschreibung berücksichtigen soll
• exact (nicht erforderlich, Boolescher Wert): Gibt an, ob die Übereinstimmung exakt oder teilweise sein soll

Erfolgreiche Antwort:

        [

  {

    "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. In der Anfrage-Parameterliste: Wenn das Feld 'case_sensitive' nicht angegeben ist, wird der Standardwert false (Groß-/Kleinschreibung ignoriert) für diesen Parameter verwendet
2. In der Anfrage-Parameterliste: Wenn das Feld 'exact' nicht angegeben ist, wird der Standardwert true (exakte Übereinstimmung) für diesen Parameter verwendet
3. Die Antwort enthält ein Array mit Unternehmensdetails, die dem Namen mit den in der Anfrage-Parameterliste angegebenen Einstellungen innerhalb der für den API-Schlüssel zugänglichen Hierarchie entsprechen
4. Wenn das Array leer ist, bedeutet dies, dass kein Unternehmen in der für den API-Schlüssel zugänglichen Hierarchie mit dem Namen und den angegebenen Einstellungen gefunden wurde

Geräteübersicht abrufen:

GET /device/summary

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• company_id (nicht erforderlich, Zahl): Die Unternehmens-ID
• device_id (nicht erforderlich, Zeichenfolge): Die Geräte-ID

Erfolgreiche Antwort:

    	[    

{

        "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. In der Anfrage-Parameterliste: Wenn das Feld 'company_id' nicht angegeben ist, wird das Unternehmen des Benutzers mit dem API-Schlüssel als Parameter verwendet
2. Wenn das Feld 'device_id' angegeben ist, wird nur die Geräteübersicht dieses Geräts im Antwort-Array zurückgegeben
3. Die Antwort enthält die Gerätedetails aller Geräte, auf die der Benutzer entsprechend dem API-Schlüssel zugreifen kann

E-Mail-Benachrichtigung für ein Gerät aktualisieren:

PUT/device/backup_plan/email_notification

Verarbeitet: application/json

Erzeugt: application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Text:

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}

Erfolgreiche Antwort:

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
		

1. Wenn die Anfrage erfolgreich ist, wird ein 200-Statuscode mit dem obigen Antwort-Payload zurückgegeben

Backup-Plan erstellen:

POST /backup_plan

Verarbeitet:application/json

Erzeugt:application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• dry_run (nicht erforderlich, Boolescher Wert): Flag zum Ausführen der Anfrage ohne Änderungen, standardmäßig false

Anfrage-Text:

    {

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

}

Basis-Anfrage-Felder:

Verschachtelte Anfrage-Felder (backup_details):

Verschachtelte Anfrage-Felder (Zeitplan):

Erfolgreiche Antwort:

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}

1. Wenn die Anfrage erfolgreich ist, wird eine Antwort mit Statuscode 201 zurückgegeben
2. In der Erfolgsantwort ist das Feld 'conflicts' ein Array von Objekten mit device_id und dem bestehenden plan_name, der durch den in der Anfrage erstellten Backup-Plan ersetzt wurde
3. Das Feld applied_to enthält eine durch Kommas getrennte Zeichenfolge der device_id-Werte der Geräte, auf die der Backup-Plan angewendet wurde
4. Das Feld not_applied_to enthält eine kommagetrennte Liste der device_id-Werte der Geräte, auf die der Backup-Plan nicht angewendet werden konnte, da das Gerät inaktiv (gesperrt, storniert oder archiviert) ist

Backup-Plan abrufen:

GET /backup_plan

Verarbeitet:application/json

Erzeugt:application/json

Anfrage-Header:

• Authorization: Bearer 'api-key'

Anfrage-Parameter:

• company_id (nicht erforderlich, Zahl): Die Unternehmens-ID
• backup_id (nicht erforderlich, Zeichenfolge): Die Backup-Plan-ID

Erfolgreiche Antwort:

    [

    {

        "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. In der Anfrage-Parameterliste: Wenn das Feld `company_id` nicht angegeben ist, wird das Unternehmen des API-Schlüssel-Benutzers als Parameter verwendet.
2. In der Anfrage-Parameterliste: Wenn `company_id` angegeben ist, aber nicht `backup_id`, werden alle Backup-Pläne des entsprechenden Unternehmens zurückgegeben
3. Wenn `backup_id` angegeben ist, wird dieser Backup-Plan aus dem Unternehmen entsprechend `company_id` abgerufen (sonst Unternehmen des Benutzers).
4. Wenn ein Backup-Plan auf Geräte angewendet wurde, sind die zugehörigen Geräteinformationen in der Antwort unter dem "devices" array.
5. Wenn ein Backup-Plan auf Gruppen angewendet wurde, sind die Gruppen-IDs in der Antwort unter dem "groups" array.

HTTP-Antwortcodes:

• 200 - Anfrage erfolgreich
• 201 - Ressource erstellt
• 401 - Nicht autorisiert
• 400 - Ungültige Anfrage / Ungültige Parameter
• 429 - Abhängigkeitsfehler
• 500 - Interner Serverfehler

Fehlerantwort:

1. Der übergeordnete Fehler-"type" ist die allgemeine Ursache für den Anfragefehler; die anfragespezifischen "errors" werden in einem Array-Format angegeben
2. Das übergeordnete Feld "message" ist für die Verarbeitung irrelevant und dient nur der Lesbarkeit; es beschreibt den übergeordneten Fehler-"type"
3. Wenn das innere Feld "errors" nicht vorhanden ist, behandeln Sie den Anfragefehler anhand des übergeordneten Fehler-"type"
4. Das innere Feld "errors" enthält das Array der bei der Anfrageverarbeitung aufgetretenen Fehler mit individuellem Fehler-"type", "field" und "message"/Beschreibung
5. In bestimmten Fällen wird auch ein "field" im "errors"-Inhalt zurückgegeben, was darauf hinweist, dass die Anfrage aufgrund einer Operation mit diesem "field" fehlgeschlagen ist

{

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

       }

   ]

}

Fehlertypen:

Fehlerfelder:

• Nachfolgend sind die "field"-Typen aufgeführt, die im inneren "errors"-Payload zurückgegeben werden, zusammen mit den entsprechenden Szenarien