---
title: "Decommission Serial"
method: PATCH
path: "/serials/{serial_id}"
tags: ["Serials"]
---

# Decommission Serial

`PATCH /serials/{serial_id}`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/serials/{serial_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/serials/:serial_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `serial_id` string, uuid, required

## Request body

- SerialPatchRequestDto
  - `decommission` boolean

## Response `200`

Appliance decommissioned successfully.

- SerialDto
  - `id` string, uuid, required
  - `type` 'edge' | 'nmc' | 'file_iq' | 'naa' | 'uaas', required
  - `in_use` boolean
  - `description` string, nullable
  - `build` string, nullable
  - `available_build` string, nullable
  - `users` integer, nullable
  - `fqdns` string[], nullable
  - `last_config_backup_date` string, nullable

## Other responses

- `409`: Appliance owns volumes or is in a state that does not allow for decommission
- `422`: Validation Error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)