IDrive^® 360 API Koleksiyonu

IDrive^® 360 API Koleksiyonu

IDrive^® 360 API, REST mimarisi üzerine insa edilmistir ve hem istek hem de yanit gövdeleri için JSON desteklemektedir.

Kimlik dogrulama bir API Anahtari araciligiyla gerçeklestirilir. Bu anahtari IDrive^® 360 Yönetim Konsolu'ndaki Hesabim > API Anahtarlari bölümünden olusturabilirsiniz.

Olusturulan anahtari Authorization basligi altinda HTTP basligina ekleyerek her API istegine dahil edin.

Yetkilendirme Basligi API Anahtari

Temel Uç Nokta:

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

Cihaz ve Sirket Islemleri

Sirket Özetini Getir:

GET /company

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• company_id (zorunlu degil, sayi): Sirket kimligi

Basari Yaniti:

    				{

  "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. Istek parametre listesinde 'company_id' alani belirtilmemisse, API anahtariyla iliskili kullanicinin sirketi parametre olarak alinir
2. Eger 'company_id' API anahtari kullanicisinin sirketine karsilik geliyorsa, kullanicinin sirketinin alt sirketleri yanitta 'sub_company_list' anahtariyla döndürülür
3. Eger 'company_id' API anahtari kullanicisinin sirketinin herhangi bir alt sirketine karsilik geliyorsa, yalnizca o hedef sirketin ayrintilari döndürülür
4. Yanit, API anahtari kullanicisinin sirketinin ve alt sirketlerinin ayrintilarini içerir
5. Her sirket için döndürülen 'configuration_id', varsayilan olarak 'private_encryption' ve 'full_client' seçenekleri devre disi birakilmis sekilde gelir
6. 'configuration_id' içine 'private_encryption' veya 'full_client' seçenegi eklenecekse, ilgili parametre degerleriyle /company/fetch_config_id API'sini kullanin
7. Döndürülen 'setup_link', döndürülen 'configuration_id' degerine karsilik gelen kurulum için indirme baglantisidir. Varsayilan olarak Windows kurulum baglantisi döndürülür
8. Baska bir IS için kurulum indirme baglantisi gerekiyorsa, ilgili parametre degeriyle /company/fetch_config_id API'sini kullanin

Yapilandirma Kimligini Getir:

GET /company/fetch_config_id

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• company_id (zorunlu degil, sayi): Sirket kimligi
• private_encryption (zorunlu degil, mantiksal): Cihaza yüklenen istemcinin özel sifrelemeye sahip olup olmayacagi
• full_client (zorunlu degil, mantiksal): Cihaza yüklenen istemcinin tam istemci özelliklerine erisimi olup olmayacagi
• build_type (zorunlu degil, dize, büyük/küçük harf duyarsiz): Kurulum baglantisinin kullanilacagi hedef IS (WIN, MAC, RPM, DEB, MSI, PKG)

Basari Yaniti:

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

1. Istek parametre listesinde 'company_id' alani belirtilmemisse, API anahtariyla iliskili kullanicinin sirketi parametre olarak alinir
2. Istek parametre listesinde 'private_encryption' ve 'full_client' alanlari belirtilmemisse, varsayilan false degeri parametre degeri olarak alinir
3. Istek parametre listesinde 'build_type' belirtilmemisse, varsayilan WIN degeri parametre degeri olarak alinir

Sirket Olustur:

POST /company

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Gövdesi:

{

   "name": "idrive",

   "company_id": 1111

}

Basari Yaniti: 201 Olusturuldu

    	{

  "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. Istek gövdesinde 'company_id' alani belirtilmemisse, API anahtariyla iliskili kullanicinin sirketi parametre olarak alinir
2. name alani, istek gövdesinde zorunludur
3. Basarili olusturmanin ardindan yanit, sirketin ayrintilarini içerir
4. Yeni olusturulan sirket için döndürülen 'configuration_id', varsayilan olarak 'private_encryption' ve 'full_client' seçenekleri devre disi birakilmis sekilde gelir
5. 'configuration_id' içine 'private_encryption' veya 'full_client' seçenegi eklenecekse, ilgili parametre degerleriyle /company/fetch_config_id API'sini kullanin
6. Döndürülen 'setup_link', döndürülen 'configuration_id' degerine karsilik gelen kurulum için indirme baglantisidir. Varsayilan olarak Windows kurulum baglantisi döndürülür
7. Baska bir IS için kurulum indirme baglantisi gerekiyorsa, ilgili parametre degeriyle /company/fetch_config_id API'sini kullanin

Sirketi Ada Göre Getir:

GET /company/name

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• name (zorunlu, dize): Sirket adi
• case_sensitive (zorunlu degil, mantiksal): Eslesmenin büyük/küçük harfe duyarli olup olmayacagini belirten deger
• exact (zorunlu degil, mantiksal): Eslesmenin tam/kismi olup olmayacagini belirten deger

Basari Yaniti:

        [

  {

    "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. Istek parametre listesinde 'case_sensitive' alani belirtilmemisse, bu parametre için varsayilan false (büyük/küçük harf duyarsiz) degeri alinir
2. Istek parametre listesinde 'exact' alani belirtilmemisse, bu parametre için varsayilan true (tam eslesme) degeri alinir
3. Yanit, API anahtari tarafindan erisilebilen hiyerarsideki istek parametre listesinde belirtilen ayarlarla ada uyusan sirket ayrintilarinin bir dizisini içerir
4. Dizi bossa, API anahtari tarafindan erisilebilen hiyerarside belirtilen ayarlarla ada uyusan sirket bulunamadigini gösterir

Cihaz Özetini Getir:

GET /device/summary

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• company_id (zorunlu degil, sayi): Sirket kimligi
• device_id (zorunlu degil, dize): Cihaz kimligi

Basari Yaniti:

    	[    

{

        "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. Istek parametre listesinde 'company_id' alani belirtilmemisse, API anahtariyla iliskili kullanicinin sirketi parametre olarak alinir
2. 'device_id' alani belirtilirse, yalnizca o cihazin özeti yanit dizisinde döndürülür
3. Yanit, API anahtarina karsilik gelen kullanici tarafindan erisilebilen tüm cihazlarin ayrintilarini içerir

Bir Cihaz için E-posta Bildirimini Güncelle:

PUT/device/backup_plan/email_notification

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Gövdesi:

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}

Basari Yaniti:

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
		

1. Istek basarili oldugunda, yukaridaki yanit yüküyle birlikte 200 durum kodu döndürülür

Yedekleme Plani Olustur:

POST /backup_plan

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• dry_run (zorunlu degil, mantiksal): Istegi degisiklik yapmadan çalistirmak için belirtilen bayrak, varsayilan olarak false

Istek Gövdesi:

    {

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

}

Temel Istek Alanlari:

Iç Içe Istek Alanlari (backup_details):

Iç Içe Istek Alanlari (scheduler):

Basari Yaniti:

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}

1. Istek basariliysa, 201 durum koduyla bir yanit döndürülür
2. Basari yanitinda, conflicts alani; istekte olusturulan yedekleme planiyla degistirilen device_id ve mevcut plan_name degerlerini içeren nesnelerden olusan bir dizidir
3. applied_to alani, yedekleme planinin uygulandigi cihazlarin virgülle ayrilmis device_id dizesini içerir
4. not_applied_to alani, cihaz etkin olmadigi için (engellendi, iptal edildi veya arsivlendi) yedekleme planinin uygulanamadigi cihazlarin virgülle ayrilmis device_id dizesini içerir

Yedekleme Planini Getir:

GET /backup_plan

Kabul Eder: application/json

Üretir: application/json

Istek Basliklari:

• Authorization: Bearer 'api-key'

Istek Parametreleri:

• company_id (zorunlu degil, sayi): Sirket kimligi
• backup_id (zorunlu degil, dize): Yedekleme plani kimligi

Basari Yaniti:

    [

    {

        "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. Istek parametre listesinde `company_id` alani belirtilmemisse, API anahtariyla iliskili kullanicinin sirketi parametre olarak alinir.
2. Istek parametre listesinde `company_id` belirtilmis ancak `backup_id` belirtilmemisse, `company_id`'ye karsilik gelen sirketteki tüm yedekleme planlari döndürülür
3. Parametre listesinde `backup_id` belirtilmisse, belirtilen `company_id`'ye karsilik gelen sirketten (belirtilmezse kullanicinin sirketinden) o yedekleme plani getirilir.
4. Bir yedekleme plani cihazlara uygulanmissa, o cihazlara ait bilgiler yanitta "devices" dizisi altinda yer alir.
5. Bir yedekleme plani gruplara uygulanmissa, o gruplara ait grup kimlikleri yanitta "groups" dizisi altinda yer alir.

HTTP Yanit Kodlari:

• 200 - Istek Basarili
• 201 - Kaynak Olusturuldu
• 401 - Yetkisiz
• 400 - Geçersiz istek / Geçersiz parametreler
• 429 - Bagimlilik hatasi
• 500 - Dahili Sunucu Hatasi

Hata Yaniti:

1. Temel/üst düzey hata "type" degeri, istek hatasinin genel nedenidir; istege özgü "errors" ise dizi biçiminde belirtilir
2. Temel/üst düzey "message" alani isleme açisindan önemsizdir; yalnizca temel/üst düzey hata "type" degerini açiklayan okunabilirlik amaçlidir
3. Iç "errors" alani mevcut degilse, istek hatasini temel/üst düzey hata "type" degerini kullanarak ele alin
4. Iç "errors" alani, istek islemi sirasinda karsilasilan hatalarin dizisini içerir; her hata kendi "type", "field" ve "message"/açiklama degerlerini barindirir
5. Bazi durumlarda, "errors" içerigiyle birlikte bir "field" de döndürülür; bu durum, istek yürütmesinin söz konusu "field" ile gerçeklestirilen bir islem nedeniyle basarisiz oldugunu gösterir

{

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

       }

   ]

}

Hata Türleri:

Hata Alanlari:

• Iç "errors" yükünde döndürülen "field" türlerinin listesi ve "field" degerinin döndürülebilecegi senaryolar asagida listelenmistir