# Pearl REST API base URL, authentication, and versioning

# Pearl device REST API

The Pearl device REST API is an HTTP interface for controlling recording, streaming, inputs, outputs, scheduled events, and system functions on a Pearl device over the network. It is version 2.0 of the API.

*Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.*

All requests are sent to the device itself. The base path is `/api/v2.0`, appended to the device address:

```
http://<device-ip>/api/v2.0/<endpoint>
http://<hostname>/api/v2.0/<endpoint>
```

Use `https://` instead of `http://` if HTTPS is configured on the device.

**Authentication.** The API uses HTTP Basic authentication. Send an `Authorization` header with base64-encoded `username:password` credentials on every request:

```
Authorization: Basic <base64-of-username:password>
```

A request with `curl` looks like this:

```
curl -u admin:<password> http://<device-ip>/api/v2.0/system/status
```

**Request and response bodies.** Bodies are JSON (`Content-Type: application/json`). Some endpoints take their parameters in the query string instead of a body — for example, renaming a channel or adding a bookmark.

**Support contact.** Questions about the API go to Epiphan support at https://www.epiphan.com/support/.

> product: pearl-family · topic: security · source: pearl-rest-api.md · updated: Oct 7, 2026