IDrive^® 360 API's Collection

IDrive^® 360 API's Collection

O IDrive^® 360 API é construído na arquitetura REST e suporta JSON para os corpos de Solicitação e Resposta.

A autenticação é feita por meio de uma chave API. Você pode gerar essa chave a partir de Minha conta > Chaves de API no seu IDrive^® 360 Management Console.

Inclua a chave gerada em cada Solicitação de API adicionando-a ao cabeçalho HTTP em Authorization.

Cabeçalho de Autorização API Key

Endpoint Base:

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

Operações de Dispositivo e Empresa

Obter Resumo da Empresa:

GET /company

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• company_id (não-Obrigatório, número): O ID da empresa

Resposta de Sucesso:

    				{

  "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. Na lista de parâmetros da Solicitação, se o campo 'company_id' não for especificado, a empresa do usuário associada à chave API será usada como parâmetro
2. Se o 'company_id' corresponder à empresa do usuário da chave API, então as subempresas da empresa do usuário serão retornadas na carga útil com a chave 'sub_company_list'
3. Se o 'company_id' corresponder a qualquer subempresa da empresa do usuário da chave de API, somente os detalhes da empresa-alvo serão retornados
4. A resposta conterá os detalhes da empresa do usuário da chave API e suas subempresas
5. O 'configuration_id' retornado para cada empresa terá as opções 'private_encryption' e 'full_client' desativadas por padrão
6. Se a opção 'private_encryption' ou 'full_client' for incluída em 'configuration_id', use a API /company/fetch_config_id com os respectivos valores de parâmetro
7. O 'setup_link' retornado é o link de download da configuração correspondente ao 'configuration_id' retornado. Aqui, por padrão, o link de configuração do Windows é retornado
8. Se o link de download da configuração correspondente a outro sistema operacional for baixado, use a API /company/fetch_config_id com o respectivo valor do parâmetro

Obter ID de Configuração:

GET /company/fetch_config_id

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• company_id (não-Obrigatório, número): O ID da empresa
• 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 (não-Obrigatório, string, sem distinção entre maiúsculas/minúsculas): O sistema operacional alvo para o qual o link de configuração será usado (WIN, MAC, RPM, DEB, MSI, PKG)

Resposta de Sucesso:

{

  "name": "default",

  "company_id": 123,

  "configuration_id": "eyJ0b2tlbiI6IkFUVkFXUTE3MjQyIiwiZW5jcnlwdGlvblJlcXVpcmVkIjpmYWxzZSwiZGVza3RvcEFwcFN0YXR1cyI6ZmFsc2V9",

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

}

Copy Code

1. Na lista de parâmetros da Solicitação, se o campo 'company_id' não for especificado, a empresa do usuário associada à chave API será usada como parâmetro
2. Na lista de parâmetros da Solicitação, se os campos 'private_encryption', 'full_client' não forem especificados, o valor padrão false será usado como valor do parâmetro
3. Na lista de parâmetros da Solicitação, se 'build_type' não for especificado, o valor padrão WIN será usado como valor do parâmetro

Criar Empresa:

POST /company

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Corpo da Solicitação:

{

   "name": "idrive",

   "company_id": 1111

}

Resposta de Sucesso: 201 Criado

    	{

  "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. No corpo da Solicitação, se o campo 'company_id' não for especificado, a empresa do usuário associada à chave API será usada como parâmetro
2. O campo nome é obrigatório na carga útil
3. A Resposta após a criação bem-sucedida conterá os detalhes da empresa
4. O 'configuration_id' retornado para a empresa recém-criada terá as opções 'private_encryption' e 'full_client' desativadas por padrão
5. Se a opção 'private_encryption' ou 'full_client' for incluída em 'configuration_id', use a API /company/fetch_config_id com os respectivos valores de parâmetro
6. O 'setup_link' retornado é o link de download da configuração correspondente ao 'configuration_id' retornado. Aqui, por padrão, o link de configuração do Windows é retornado
7. Se o link de download da configuração correspondente a outro sistema operacional for baixado, use a API /company/fetch_config_id com o respectivo valor do parâmetro

Obter Empresa por Nome:

GET /company/name

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• name (Obrigatório, string): O nome da empresa
• case_sensitive (não-Obrigatório, boolean): Valor que especifica se a correspondência deve diferenciar maiúsculas de minúsculas
• exact (não-Obrigatório, boolean): Valor que especifica se a correspondência deve ser exata ou parcial

Resposta de Sucesso:

        [

  {

    "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. Na lista de parâmetros da Solicitação, se o campo 'case_sensitive' não for especificado, o valor padrão false (sem distinção entre maiúsculas e minúsculas) será usado para este parâmetro
2. Na lista de parâmetros da Solicitação, se o campo 'exact' não for especificado, o valor padrão true (correspondência exata) será usado para este parâmetro
3. A Resposta conterá um array com detalhes da empresa correspondentes ao nome com as configurações especificadas na lista de parâmetros da Solicitação dentro da hierarquia acessível pela chave API
4. Se a matriz estiver vazia, significa que não foi encontrada nenhuma empresa na hierarquia acessível pela chave de API que corresponda ao nome com as configurações especificadas

Obter Resumo do Dispositivo:

GET /device/summary

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• company_id (não-Obrigatório, número): O ID da empresa
• device_id (não-Obrigatório, string): O ID do dispositivo

Resposta de Sucesso:

    	[    

{

        "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. Na lista de parâmetros da Solicitação, se o campo 'company_id' não for especificado, a empresa do usuário associada à chave API será usada como parâmetro
2. Se o campo 'device_id' for especificado, o resumo do dispositivo apenas desse dispositivo será retornado na matriz Resposta
3. A resposta conterá os detalhes de todos os dispositivos acessíveis pelo usuário correspondentes à chave API

Atualizar Notificação por E-mail para um Dispositivo:

PUT/device/backup_plan/email_notification

Consome: application/json

Produz: application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Corpo da Solicitação:

	{

  "device_id": "wtrp2zjidqr4hlsfz9vmebvtmudrpdfkayaskeunmq4civffo9",

  "backup_set": "DEFAULT",

  "type": "ALWAYS",

  "emails": [

    "test@idrive.com",

    "support@idrive.com"

  ]

}

Resposta de Sucesso:

			{

  "ok": true,

  "message": "Email notification settings updated successfully"

}
		

1. Quando a Solicitação for bem-sucedida, um código de status 200 será retornado com o payload da Resposta acima

Criar Plano de Backup:

POST /backup_plan

Consome:application/json

Produz:application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• dry_run (não-Obrigatório, boolean): Flag para executar a Solicitação sem modificações, false por padrão

Corpo da Solicitação:

    {

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

Resposta de Sucesso:

                {

  "conflicts": [

    {

      "device_id": "1l3d3bxrgf2fpwblc5qoyiezihz5behf6lbab6ljsngkomgonx",

      "plan_name": "Default backup plan"

    }

  ],

  "backup_id": "406717",

  "where_to_backup": "CLOUD", 

  "not_applied_to": "",

  "status": 201

}

1. Se a Solicitação for bem-sucedida, uma Resposta com código de status 201 será retornada
2. Na Resposta de sucesso, o campo conflicts é um array de objetos com device_id e plan_name existente que foi substituído pelo plano de backup criado na Solicitação
3. O campo apply_to contém a sequência de device_id separados por vírgula dos dispositivos aos quais o plano de backup foi aplicado.
4. O campo not_applied_to contém a sequência de device_id separados por vírgula de dispositivos aos quais o plano de backup não foi aplicado devido ao dispositivo não estar ativo, ou seja, (bloqueado, cancelado ou arquivado)

Obter Plano de Backup:

GET /backup_plan

Consome:application/json

Produz:application/json

Cabeçalhos da Solicitação:

• Authorization: Bearer 'api-key'

Parâmetros da Solicitação:

• company_id (não-Obrigatório, número): O ID da empresa
• backup_id (não-Obrigatório, string): O ID do plano de backup

Resposta de Sucesso:

    [

    {

        "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. Na lista de parâmetros da Solicitação, se o campo `company_id` não for especificado, a empresa do usuário associada à chave API será usada como parâmetro.
2. Na lista de parâmetros da Solicitação, se `company_id` for especificado e não `backup_id`, todos os planos de backup presentes na empresa correspondente ao `company_id`serão retornados
3. Se `backup_id` for especificado na lista de parâmetros, então esse plano de backup específico será obtido da empresa correspondente a `company_id`, se especificado (caso contrário, a empresa do usuário).
4. Se um plano de backup for aplicado aos dispositivos, as informações correspondentes a esses dispositivos estarão presentes na Resposta na matriz "dispositivos".
5. Se um plano de backup for aplicado a grupos, os IDs de grupo correspondentes a esses grupos estarão presentes na Resposta na matriz "grupos".

Códigos de Resposta HTTP:

• 200 - Sucesso da Solicitação
• 201 - Recurso criado
• 401 - Não autorizado
• 400 - Solicitação inválida / Parâmetros inválidos
• 429 - Erro de dependência
• 500 - Erro interno do servidor

Resposta de Erro:

1. O "type" de erro base/nível superior é a causa genérica de falha da Solicitação e os "errors" específicos da Solicitação são especificados em formato de array
2. O campo "mensagem" de nível base/superior é irrelevante para processamento, presente para legibilidade que descreve o "tipo" de erro de nível base/superior
3. Se o campo interno "errors" não estiver presente, trate a falha da Solicitação usando o "type" de erro base/nível superior
4. O campo interno "errors" contém o array de erros encontrados ao executar a operação da Solicitação, que inclui o "type", "field" e "message"/Descrição de cada erro individual
5. Em certos casos, um "field" também será retornado com o conteúdo "errors", indicando que a execução da Solicitação falhou devido a uma operação realizada com esse "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"

       }

   ]

}

Tipos de Erro:

Campos de Erro:

• Uma lista de tipos de "campos" retornados na carga útil de "erros" internos, juntamente com os cenários em que o "campo" pode ser retornado, está listada abaixo