---
title: "List transports"
method: GET
path: "/transports"
tags: ["Administration"]
---

# List transports

`GET /transports`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/transports`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/transports/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of transports

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `protocol` 'UDP' | 'TCP' | 'TLS': The transport protocol: Can be either: - `UDP`: - `TCP`: - `TLS`:
    - `port` integer: A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
    - `verification` 'DISABLE' | 'OPTIONAL' | 'MANDATORY': Indicates if PBX wishes (Optional) or requires (Mandatory) TLS clients to present a client certificate: - `DISABLE`: disable client certificate. - `OPTIONAL`: client authentication optional. - `MANDATORY`: force client authentication.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)