---
title: "Get Serials"
method: GET
path: "/serials"
tags: ["Serials"]
---

# Get Serials

`GET /serials`

## Request

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

## Query parameters

- `type` 'edge' | 'nmc' | 'file_iq' | 'naa' | 'uaas', nullable
- `description` string, nullable
- `in_use` boolean, nullable

## Response `200`

Serials retrieved successfully

- SerialsDto
  - `items` 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

- `401`: Not authenticated
- `403`: Insufficient permissions
- `422`: Invalid input data
- `500`: Internal server 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)