# Synse Server API (v3)

**Canonical:** https://apis.io/apis/vapor-io/synse-server/  
**Provider:** Vapor IO — https://apis.io/providers/vapor-io/  
**Base URL:** http://{synse-server-host}:5000  
**Documentation:** https://synse.readthedocs.io/en/latest/server/api.v3/

Synse Server API (v3) is one of 2 APIs that [Vapor IO](https://apis.io/providers/vapor-io/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Device Management, Monitoring, Telemetry, Edge Computing, and IoT. The published artifact set on APIs.io includes API documentation, an API reference, a getting-started guide, and rate-limit docs.

Synse Server exposes a uniform HTTP and WebSocket API for reading from and writing to physical and virtual devices through protocol-specific plugins. The same 18 operations are available over both transports: status, version, config, plugin summary/detail/health, device scan, tags, device info, read, read-by-device, read cache, streamed readings (WebSocket only), asynchronous and synchronous writes, and transaction status. Synse Server is self-hosted; the base URL is the host and port of the operator's own deployment, which defaults to port 5000.

## Machine-readable artifacts (9)

- **Documentation** — https://synse.readthedocs.io/en/latest/server/intro/
- **APIReference** — https://synse.readthedocs.io/en/latest/server/api.v3/
- **GettingStarted** — https://synse.readthedocs.io/en/latest/server/user/quickstart/
- **SourceCode** — https://github.com/vapor-ware/synse-server
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/vapor-io/refs/heads/main/errors/vapor-io-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/vapor-io/refs/heads/main/conventions/vapor-io-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/vapor-io/refs/heads/main/data-model/vapor-io-data-model.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/vapor-io/refs/heads/main/rate-limits/vapor-io-rate-limits.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/vapor-io/refs/heads/main/apis.yml

## Other Vapor IO APIs (1)

- [Synse Plugin gRPC API (V3Plugin)](https://apis.io/apis/vapor-io/synse-plugin-grpc/)

## Tags

Device Management, Monitoring, Telemetry, Edge Computing, IoT

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/vapor-io/synse-server/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/vapor-io/.