---
title: "Preview Alias"
method: GET
path: "/api/admin/aliases/preview"
tags: ["admin-aliases", "admin-aliases"]
---

# Preview Alias

`GET /api/admin/aliases/preview`

## Request

- Base URL: `https://grandline.luzomi.com`
- URL: `https://grandline.luzomi.com/api/admin/aliases/preview`
- Auth: none declared

Run the same alias resolver the public search uses, so an operator can
'test' what a user typing `q` will resolve to before/after adding a row.

## Query parameters

- `q` string, required
- `limit` integer

## Response `200`

Successful Response

- PortSearchHit[]
  - `port_id` integer, required
  - `port_name` string, required
  - `country_iso2` string, required
  - `routable` boolean
  - `nearest_routable` PortRow
    - `port_id` integer, required
    - `port_name` string, required
    - `country_iso2` string, required
  - `lat` number, nullable
  - `lon` number, nullable
  - `matched_alias` string, nullable
  - `canonical_name` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/luzomi/apis/grandline-api.md) · [All operations](https://skmtc.dev/luzomi/apis/grandline-api/llms.txt) · [OpenAPI document](https://skmtc.dev/luzomi/apis/grandline-api/revisions/4ce06aea012b?raw)