Delete a device

DELETE

/devices/{id}

const url = 'https://localhost:8080/api/v1/devices/example';
const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://localhost:8080/api/v1/devices/example \
  --header 'Authorization: <Authorization>'

Permanently deletes a device by its id.

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Device id (UUID)

Responses

204

No Content

application/json

401

Unauthorized

application/json

object

detail

string

errors

Array<object>

object

code

string

detail

string

Allowed values: body query path

name

string

instance

string

status

integer

title

string

type

string

Example

{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

404

Not Found

application/json

object

detail

string

errors

Array<object>

object

code

string

detail

string

Allowed values: body query path

name

string

instance

string

status

integer

title

string

type

string

Example

{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

422

Unprocessable Entity

application/json

object

detail

string

errors

Array<object>

object

code

string

detail

string

Allowed values: body query path

name

string

instance

string

status

integer

title

string

type

string

Example

{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}

500

Internal Server Error

application/json

object

detail

string

errors

Array<object>

object

code

string

detail

string

Allowed values: body query path

name

string

instance

string

status

integer

title

string

type

string

Example

{
  "detail": "One or more request values are invalid.",
  "errors": [
    {
      "code": "required",
      "detail": "name is required",
      "in": "body",
      "name": "name"
    }
  ],
  "instance": "/api/v1/devices",
  "status": 422,
  "title": "Request validation failed",
  "type": "https://docs.air-iq.net/reference/errors/#validation-error"
}