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

# Get tunnels project usage

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

## Request

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

## Path parameters

- `projectId` string, required

## Response `200`

Successful response.

- TunnelsProjectUsage
  - `metrics` object, required
    - `bandwidthTunnels` object
      - `id` string, required
      - `name` string, required
      - `value` number, required
      - `max` number, required
      - `unit` string, required
    - `bandwidthTurn` object
      - `id` string, required
      - `name` string, required
      - `value` number, required
      - `max` number, required
      - `unit` string, required
    - `connections` object
      - `id` string, required
      - `name` string, required
      - `value` number, required
      - `max` number, required
      - `unit` string, required
    - `time` object
      - `id` string, required
      - `name` string, required
      - `value` number, required
      - `max` number, required
      - `unit` string, required
  - `currentPeriod` object, required
    - `start` string, date-time, required
    - `end` string, date-time, required

## Other responses

- `401`: Authentication is required.
- `403`: The token is not authorized.
- `404`: Project or usage 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)