# Aranya Client API

**Canonical:** https://apis.io/apis/spideroak/spideroak-aranya-client/  
**Provider:** SpiderOak — https://apis.io/providers/spideroak/  
**Documentation:** https://aranya-project.github.io/technical-apis

Aranya Client API is published by [SpiderOak](https://apis.io/providers/spideroak/) on the [APIs.io](https://apis.io/) network. Tagged areas include Zero Trust, Access Control, Encryption, Identity and Access Management, and Policy. The published artifact set on APIs.io includes API documentation, an API reference, a getting-started guide, and authentication docs.

The Aranya Client API is the library interface an application uses to talk to the Aranya daemon. It covers team creation, device onboarding and removal, role and permission management (including custom roles with rank-based authorization), label-based segmentation, sync-peer configuration over QUIC/TCP with certificate-based mTLS, and Aranya Fast Channels (AFC) encrypted send/receive channels. It is published in two bindings — a Rust API (aranya-client crate) and a C API (aranya-client.h, generated by cbindgen and documented with Doxygen). There is no HTTP surface: the client speaks to a local daemon over a Unix domain socket whose path is set by the caller via aranya_client_config_builder_set_daemon_uds_path.

## Machine-readable artifacts (9)

- **Documentation** — https://aranya-project.github.io/technical-apis
- **APIReference** — https://aranya-project.github.io/aranya/capi/v7.0.1
- **GettingStarted** — https://aranya-project.github.io/getting-started/walkthrough
- **SourceCode** — https://github.com/aranya-project/aranya
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/spideroak/refs/heads/main/errors/spideroak-error-codes.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/spideroak/refs/heads/main/data-model/spideroak-data-model.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/spideroak/refs/heads/main/authentication/spideroak-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/spideroak/refs/heads/main/conventions/spideroak-conventions.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/spideroak/refs/heads/main/apis.yml

## Tags

Zero Trust, Access Control, Encryption, Identity and Access Management, Policy

---

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