---
title: "The browser extension's relay status"
method: GET
path: "/api/v1/relay/status"
tags: ["Account"]
---

# The browser extension's relay status

`GET /api/v1/relay/status`

## Request

- Base URL: `https://unbrowse.ai`
- URL: `https://unbrowse.ai/api/v1/relay/status`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://unbrowse.ai/authorize`, token URL `https://unbrowse.ai/oauth/token`, scopes: `unbrowse`)
  - HTTP bearer

Whether the workspace's Unbrowse browser extension is connected, the device, which sites it syncs or relays, and whether it is paused. Offline with no sites when the relay is not enabled.

## Response `200`

Relay status

- object
  - `online` boolean
  - `paused` boolean
  - `device` Object
  - `sites` object[]
    - `site` string
    - `sync` boolean
    - `relay` boolean
    - `writes` boolean

## Other responses

- `400`: An error
- `401`: Missing or invalid credentials. The WWW-Authenticate header names the protected-resource metadata.
- `402`: An error
- `404`: An error
- `429`: An error

---

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