Delete device

DELETE

/api/v1/devices/{id}

const url = 'http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000';
const options = {method: 'DELETE', headers: {'X-API-Key': '<X-API-Key>'}};

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

curl --request DELETE \
  --url http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000 \
  --header 'X-API-Key: <X-API-Key>'

Requests deletion of a device (FM-1359). Every deployment is first withdrawn from the device; the device stays listed with deletionRequestedAt set until it has confirmed the removals (or the removal timeout has passed), and is then soft-deleted. A device with nothing to withdraw is deleted at once.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Device UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

204

Device deleted, or deletion requested while its deployments are withdrawn

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

404

Device not found