IDrive^® 360 API's Collection

IDrive^® 360 API's Collection

The IDrive^® 360 API is built on REST architecture and supports JSON for both Solicitação and Resposta bodies.

Authentication is handled through an API Key. You can generate this key from My Account > API Keys in your IDrive^® 360 Management Console.

Include the generated key in every API Solicitação by adding it to the HTTP header under Authorization.

Cabeçalho de Autorização API Key

Endpoint Base:

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

Operações de Dispositivo e Empresa

Fetch Resumo da Empresa:

GET /company

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• company_id (not-Obrigatório, number): The company ID

Success Resposta:

    				{

  "name": "default",

  "status": 1,

  "company_id": 15020,

  "status_Descrição": "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_Descrição": "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_Descrição": "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_Descrição": "Active",

      "configuration_id": "eyJ0b2tlbiI6Ik5KUEhIOTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

    }

  ]

}

1. In the Solicitação parameter list, if the 'company_id' field is not specified, then the user’s company associated with the API key will be taken as parameter
2. If the 'company_id' corresponds to the API key user’s company, then sub companies of the user’s company will be returned in the payload with key 'sub_company_list'
3. If the 'company_id' corresponds to any sub company of the API key user’s company, then only that target company details will be returned
4. The Resposta will contain the details of the API key user’s company and its sub companies
5. The 'configuration_id' returned for each company will have 'private_encryption', 'full_client' options disabled by default
6. If 'private_encryption' or 'full_client' option is to be included in the 'configuration_id' use the /company/fetch_config_id API with respective parameter values
7. The 'setup_link' returned is the download link for the setup corresponding to the 'configuration_id' returned. Here by default the setup link for Windows is returned
8. If the download link for the setup corresponding to another OS is to be downloaded, use the /company/fetch_config_id API with respective parameter value

Obter ID de Configuração:

GET /company/fetch_config_id

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• company_id (not-Obrigatório, number): The company ID
• private_encryption (not-Obrigatório, boolean): If client installed in device should have private encryption [Here explain or provide link for private encryption documentation]
• full_client (not-Obrigatório, boolean): If client installed in device should have access to full-client features [Here explain or provide link for full-client documentation]
• build_type (not-Obrigatório, string, case-insensitive): The target OS for which the setup link is to be used (WIN, MAC, RPM, DEB, MSI, PKG)

Success Resposta:

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

1. In the Solicitação parameter list, if the 'company_id' field is not specified, then the user’s company associated with the API key will be taken as parameter
2. In the Solicitação parameter list, if the fields 'private_encryption', 'full_client' are not specified, then the default value of false will be taken as parameter value
3. In the Solicitação parameter list, if 'build_type' is not specified, then the default value of WIN will be taken as parameter value

Criar Empresa:

POST /company

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Body:

{

   "name": "idrive",

   "company_id": 1111

}

Success Resposta: 201 Created

    	{

  "name": "idrive",

  "status": 1,

  "company_id": 12223,

  "status_Descrição": "Active",

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

1. In the Solicitação body, if the 'company_id' field is not specified, then the user’s company associated with the API key will be taken as parameter
2. The name field is mandatory in the payload
3. The Resposta after successful creation will contain the details of the company
4. The 'configuration_id' returned for the newly created company will have 'private_encryption', 'full_client' options disabled by default
5. If 'private_encryption' or 'full_client' option is to be included in the 'configuration_id' use the /company/fetch_config_id API with respective parameter values
6. The 'setup_link' returned is the download link for the setup corresponding to the 'configuration_id' returned. Here by default the setup link for Windows is returned
7. If the download link for the setup corresponding to another OS is to be downloaded, use the /company/fetch_config_id API with respective parameter value

Obter Empresa por Nome:

GET /company/name

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• name (Obrigatório, string): The company name
• case_sensitive (not-Obrigatório, boolean): Value specifying if the matching should be case sensitive
• exact (not-Obrigatório, boolean): Value specifying if the matching should be exact/partial

Success Resposta:

        [

  {

    "name": "MSP-1",

    "status": 1,

    "company_id": 15816,

    "status_Descrição": "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_Descrição": "Active",

    "configuration_id": "eyJ0b2tlbiI6Ik5KUEhIOTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

  }

]

1. In the Solicitação parameter list, if the 'case_sensitive' field is not specified, then the default value of false (case insensitive) will be taken for this parameter
2. In the Solicitação parameter list, if the 'exact' field is not specified, then the default value of true (exact matching) will be taken for this parameter
3. The Resposta will contain an array of company details matching the name with settings specified in the Solicitação parameter list within the hierarchy accessible by the API key
4. If the array is empty, it signifies that no company in the hierarchy accessible by the API key is found matching the name with settings specified

Obter Resumo do Dispositivo:

GET /device/summary

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• company_id (not-Obrigatório, number): The company ID
• device_id (not-Obrigatório, string): The device ID

Success Resposta:

    	[    

{

        "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 the Solicitação parameter list, if the 'company_id' field is not specified, then the user’s company associated with the API key will be taken as parameter
2. If 'device_id' field is specified, the device summary of only that device will be returned in the Resposta array
3. The Resposta will contain the device details of all devices accessible by the user corresponding to the API key

Atualizar Notificação por E-mail for a Device:

PUT/device/backup_plan/email_notification

Consumes: application/json

Produces: application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Body:

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}

Success Resposta:

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
		

1. When the Solicitação is successful a 200 status code will be returned with the above Resposta payload

Criar Plano de Backup:

POST /backup_plan

Consumes:application/json

Produces:application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• dry_run (not-Obrigatório, boolean): Flag specified to run the Solicitação without modifications, false by default

Solicitação Body:

    {

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

}

Base Solicitação Fields:

Nested Solicitação Fields (backup_details):

Nested Solicitação Fields (scheduler):

Success Resposta:

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}

1. If the Solicitação is successful, a Resposta with status code 201 will be returned
2. In the success Resposta, the field conflicts is an array of objects with device_id and existing plan_name which has been replaced with the backup plan created in the Solicitação
3. The field applied_to contains the string of comma separated device_id of devices to which the backup plan has been applied to
4. The field not_applied_to contains the string of comma separated device_id of devices to which the backup plan has not been applied to due to the device not being active i.e., (blocked, canceled or archived)

Obter Plano de Backup:

GET /backup_plan

Consumes:application/json

Produces:application/json

Solicitação Headers:

• Authorization: Bearer 'api-key'

Solicitação Parameters:

• company_id (not-Obrigatório, number): The company ID
• backup_id (not-Obrigatório, string): The backup plan ID

Success Resposta:

    [

    {

        "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 the Solicitação parameter list, if the `company_id` field is not specified, then the user’s company associated with the API key will be taken as parameter.
2. In the Solicitação parameter list, if the `company_id` is specified and not the `backup_id`, then all the backup plans present in the company corresponding to `company_id`will be returned
3. If `backup_id`is specified in the parameter list, then that particular backup plan will be fetched from the company corresponding to `company_id`, if specified (else user’s company).
4. If a backup plan is applied to devices, then the information corresponding to those devices will be present in the Resposta under the "devices" array.
5. If a backup plan is applied to groups, then group ids corresponding to those groups will be present in the Resposta under the "groups" array.

HTTP Resposta codes:

• 200 - Solicitação Success
• 201 - Created resource
• 401 - Unauthorized
• 400 - Invalid Solicitação/ Invalid parameters
• 429 - Dependency error
• 500 - Internal Server Error

Error Resposta:

1. The base/top level error "type" is the generic cause for Solicitação failure and the Solicitação specific "errors" are specified in an array format
2. The base/top level "message" field is irrelevant for processing, present for readability which describes the base/top level error "type"
3. If the inner "errors" field is not present, handle the Solicitação failure using the base/top level error "type"
4. The inner "errors" field contains the array of errors encountered while performing the Solicitação operation which contains the individual error "type", "field" and "message"/Descrição
5. In certain cases, a "field" will also be returned with the "errors" content, which indicates that the Solicitação execution failed due to an operation performed with that "field"

{

   "ok": false,

   "type": "entity_not_found",

   "message": "The specified entity being addressed either does not exist or is invalid. The Solicitação 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"

       }

   ]

}

Error Types:

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