Referencia de la API

Operación Bulk: Eliminar Devices

Este endpoint elimina uno o más Device(s) a la vez.

❗️

+++Atención+++

Este endpoint es extremadamente poderoso. Pero un gran poder conlleva una gran responsabilidad.

La eliminación de Devices NO puede deshacerse. Por favor, haz una copia de seguridad de todos los datos de los Devices antes de eliminar uno o más Devices.

Solicitud HTTP

Para eliminar uno o más Device(s), haz una petición POST a la siguiente URL:

HTTP MethodURL
POSThttps://api.netux.com/api/v2.0/devices/_/bulk/delete/

🚧

Es un POST

Ten en cuenta que es una petición POST y no una petición DELETE.

Parámetros de consulta

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.

Parámetros de cuerpo

El cuerpo es un array que contiene uno o más <device_key>. Cada objeto <device_key> puede contener los siguientes parámetros de cuerpo:

ParameterTypeDescription
device_keyStringThe id or label of the Device, label should use the prefix ~

📘

<device_key>

Recuerda que el <device_key> tiene 3 formatos válidos:

-<device_id> : "6e309da44fc8455a9cceb5aa"

-<etiqueta_device>: "~second-device" //Recuerda añadir la ~ antes de el label del Device

-JSON de <device_id>: { "id": "1237809ca5pIhpjgc345fc" }

❗️

+++ATENCIÓN+++

Por favor, ten MUCHO cuidado al usar este endpoint, ¿por qué? Porque es posible borrar muchos Device a la vez.

Te proponemos 1 alternativa segura:

  • Haz una petición Obtener todos los Devices usando el parámetro de consulta fields=id. Esto devuelve un Array de los Device Ids. Simplemente copia este Array y utilízalo en el cuerpo de este endpoint. De este modo, te aseguras de que sólo se eliminan los Devices previstos en ese Array y no cualquier otro.

Cabecera

ParameterRequired?Description
X-Auth-TokenYesAuthentication Token of account
X-Bulk-OperationBooleanNeed to be set to True for the bulk operation to work
Content-TypeString (application/json)Content type of body
$ curl -X DELETE 'https://api.netux.com/api/v2.0/devices/_/bulk/delete/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
 -H 'Content-Type: application/json' \
 -H 'X-Bulk-Operation: True' \
 -d '[
  "6e309da44fc8455a9cceb5aa",
  "~second-device",
  "~third-device",
  {
    "id": "1237809ca5pIhpjgc345fc"
  }
]'

Respuesta

Devuelve un Task Id del proceso asíncrono.

{
  "task": {
    "id": "tyg54645501a9ca5714e7b098721"
  }
}

{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}

{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}

{
    "detail": "Header `X-BULK-OPERATION` should be provided for bulk operation."
}