Delete Device

del https://app.mk.io/api/v1/projects/:project_name/fleet/devices/:name

Delete a device. If the device does not exist, this API will return a 204. To learn more about devices, read Device Concept.

RBAC Capability Required: fleet.device.delete

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

• project_name string Required
• name string Required

Query parameters

• $force boolean Optional
  Force the delete of this device
• $reason string Optional
  Must be set to one of Failed|Maintenance|Storage|Other - if 'Other', the additional 'notes' query parameter is required with a brief description of the reason
• $notes string Optional
  Other reason description - minimum 5 characters, maximum 255 characters

Response

• 200 Device deleted.
  No response body.
• 204 Nothing to delete.
  No response body.

Errors

• 400 Bad Request
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code

• 401 Unauthorized
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code

• 403 Forbidden
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code

• 404 Not Found
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code

• 409 This could be due to one of: -

  • The device is not connected. The device should be reconnected (recommended) or a force delete used (not recommended).
  • Interface(s) on this device are referenced by one or more sources or destinations and those references must be removed before deletion.

No response body.

• 429 Too Many Requests
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code

• 500 Internal Server Error
  error object ErrorDetail Required
  Pertinent information about the error

  • code string Required
    The error code.
  • detail string Required
    The error message.
  • extraDetail map from strings to any Optional
    Extra information regarding this error.
  • ref string Required
    A reference to the request that caused the error.
  • status integer Required
    The HTTP status code