> For the complete documentation index, see [llms.txt](https://docs.devicecloud.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devicecloud.dev/rest-api/overview.md).

# Overview

The DeviceCloud REST API gives you programmatic access to the same data available in the console — test results, upload history, and flow analytics.

## Authentication

Include your API key in every request:

```
x-app-api-key: <your-api-key>
```

You can find your API key in the console under **Settings → API Key**.

## Base URL

```
https://api.devicecloud.dev
```

## Endpoints

| Resource                                  | Description                                                         |
| ----------------------------------------- | ------------------------------------------------------------------- |
| [Uploads](/rest-api/uploads.md)           | List uploads and poll run status                                    |
| [Results](/rest-api/results.md)           | Fetch results, reports, and artifacts for an upload                 |
| [Flows](/rest-api/flows.md)               | Aggregated analytics and run history per flow file                  |
| [IP Addresses](/rest-api/ip-addresses.md) | Current egress IPs for firewall allow-listing (no API key required) |
