---
title: "Get tunnels project"
method: GET
path: "/api/projects/tunnels/{projectId}"
tags: ["projects"]
---

# Get tunnels project

`GET /api/projects/tunnels/{projectId}`

## Request

- Base URL: `https://rstream.io`
- URL: `https://rstream.io/api/projects/tunnels/{projectId}`
- Auth: HTTP bearer

## Path parameters

- `projectId` string, required

## Response `200`

Successful response.

- TunnelsProject
  - `id` string, required
  - `workspaceId` string, required
  - `name` string, required
  - `endpoint` string, required
  - `url` string, required: Deprecated. Use 'domain' and 'enginePort' instead.
  - `domain` string, required
  - `enginePort` integer, required
  - `turnPort` integer, required
  - `turnsPort` integer, required
  - `status` 'active' | 'unavailable' | 'error', required
  - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
  - `region` string
  - `plan` 'basic' | 'pro' | 'enterprise', required
  - `deployment` 'shared' | 'dedicated', required
  - `regionLabel` string
  - `turnDomain` string, required
  - `turnRealm` string, required
  - `routing` 'regional' | 'global', required
  - `regionalEndpoints` object[], required
    - `provider` 'aws' | 'gcp' | 'azure' | 'onpremise' | 'other', required
    - `region` string, required
    - `domain` string, required
    - `enginePort` integer, required
  - `issue` object
    - `category` 'billing' | 'administrative' | 'configuration' | 'infrastructure' | 'unknown', required
    - `code` string, required
    - `message` string, required
    - `occurredAt` string, date-time

## Other responses

- `401`: Authentication is required.
- `403`: The token is not authorized.
- `404`: Project not found.

---

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