API Explorer

API Explorer

Explore the UnboundBytes API documentation. View all available endpoints, their parameters, request/response schemas, and examples.

Note

This documentation is generated from our OpenAPI specification. Download the spec below to use with your favorite API tools.

Interactive API Reference

Use one of these tools to explore the API interactively:

Swagger Editor (Recommended)

The fastest way to explore the API:

1. Visit editor.swagger.io
2. Click File > Import URL
3. Enter: https://docs.unboundbytes.com/openapi.yaml
4. Browse endpoints, view schemas, and try requests

Redocly

For a polished documentation view:

1. Visit redocly.github.io/redoc
2. The spec loads automatically
3. Browse the three-panel layout with examples

Scalar

For a modern interactive experience:

1. Visit scalar.com
2. The spec loads automatically
3. Generate code snippets and test requests

Download OpenAPI Specification

OpenAPI YAML Download the OpenAPI 3.0 specification in YAML format

OpenAPI JSON Download the OpenAPI 3.0 specification in JSON format

Using with API Clients

Postman

Import into Postman for API testing:

1. Open Postman
2. Click Import > Link
3. Enter: https://docs.unboundbytes.com/openapi.yaml
4. Configure authentication in Collection variables

Insomnia

Import into Insomnia for development:

1. Open Insomnia
2. Click Application > Preferences > Data > Import Data > From URL
3. Enter: https://docs.unboundbytes.com/openapi.yaml

Code Generation

Generate client libraries from the spec:

# Using openapi-generator-cli
npx @openapitools/openapi-generator-cli generate \
  -i https://docs.unboundbytes.com/openapi.yaml \
  -g typescript-fetch \
  -o ./generated-client

# Using Orval (TypeScript)
npx orval --input https://docs.unboundbytes.com/openapi.yaml \
  --output ./src/api

API Endpoint Categories

Health and Status

Basic health and monitoring endpoints:

Method	Endpoint	Description
GET	/health	Service health check
GET	/ready	Readiness check
GET	/live	Liveness check
GET	/metrics	Prometheus metrics

Device Pairing

Endpoints for the device pairing flow:

Method	Endpoint	Description
POST	/v1/pairing/initiate	Start device pairing
POST	/v1/pairing/prepare-activation	Get activation token
POST	/v1/pairing/activate	Complete pairing
POST	/v1/pairing/auto-activate	Auto-activate via enrollment token
GET	/v1/pairing/status/{fingerprint}	Check pairing status

Devices

Device management endpoints:

Method	Endpoint	Description
GET	/v1/hosts	List all devices
POST	/v1/hosts	Register a device
GET	/v1/hosts/{deviceId}	Get device details
DELETE	/v1/hosts/{deviceId}	Delete a device
POST	/v1/hosts/{deviceId}/heartbeat	Send heartbeat
POST	/v1/hosts/{deviceId}/rotate-secret	Rotate device secret
GET	/v1/hosts/{deviceId}/volumes	List device volumes

Commands

Command queue endpoints:

Method	Endpoint	Description
GET	/v1/hosts/{deviceId}/commands	Poll command queue
POST	/v1/hosts/{deviceId}/commands	Queue a command
POST	/v1/hosts/{deviceId}/commands/{commandId}/ack	Acknowledge command

Deployments

Deployment management endpoints:

Method	Endpoint	Description
GET	/v1/deployments	List deployments
POST	/v1/deployments	Create deployment
GET	/v1/deployments/{deploymentId}	Get deployment
PATCH	/v1/deployments/{deploymentId}	Update deployment
DELETE	/v1/deployments/{deploymentId}	Delete deployment
GET	/v1/deployments/{deploymentId}/dashboard	Deployment dashboard

Backups

Backup management endpoints:

Method	Endpoint	Description
GET	/v1/backups	List all backups
GET	/v1/hosts/{deviceId}/backups	List device backups
POST	/v1/hosts/{deviceId}/backups	Create backup
POST	/v1/hosts/{deviceId}/backups/{backupId}/restore	Restore backup
POST	/v1/hosts/{deviceId}/backups/{backupId}/verify	Verify backup
GET	/v1/backups/{backupId}/download	Download backup

Tunnels

Tunnel management endpoints:

Method	Endpoint	Description
GET	/v1/hosts/{deviceId}/tunnels	List tunnels
POST	/v1/hosts/{deviceId}/tunnels	Create tunnel
GET	/v1/hosts/{deviceId}/tunnels/{tunnelId}/credentials	Get credentials
PUT	/v1/hosts/{deviceId}/tunnels/{tunnelId}	Update tunnel
DELETE	/v1/hosts/{deviceId}/tunnels/{tunnelId}	Delete tunnel
POST	/v1/tunnels	Create global tunnel
GET	/v1/tunnels/{tunnelId}/health	Check tunnel health
POST	/v1/tunnels/{tunnelId}/stop	Stop tunnel
DELETE	/v1/tunnels/{tunnelId}	Delete tunnel

Applications

Application management endpoints:

Method	Endpoint	Description
GET	/v1/apps	List applications
POST	/v1/apps	Create application
GET	/v1/apps/{appId}	Get application
PATCH	/v1/apps/{appId}	Update application
DELETE	/v1/apps/{appId}	Delete application
PUT	/v1/apps/{appId}	Replace application
GET	/v1/apps/{appId}/secrets	Get app secrets
POST	/v1/apps/{appId}/secrets/rotate	Rotate secrets
POST	/v1/apps/{appId}/rollback	Rollback application
GET	/v1/app-templates	List app templates

Tenants

Tenant management endpoints:

Method	Endpoint	Description
GET	/v1/tenants/{tenantId}	Get tenant
GET	/v1/tenants/{tenantId}/dashboard/summary	Dashboard summary
GET	/v1/tenants/{tenantId}/metrics/health	Health metrics
GET	/v1/tenants/{tenantId}/metrics/activity	Activity metrics
GET	/v1/tenants/{tenantId}/metrics/resources	Resource metrics

Batch Operations

Bulk operation endpoints:

Method	Endpoint	Description
GET	/v1/batch	List batch operations
POST	/v1/batch	Create batch operation
GET	/v1/batch/{operationId}	Get operation status

Webhooks

Webhook subscription management:

Method	Endpoint	Description
GET	/v1/webhooks	List webhooks
POST	/v1/webhooks	Create webhook
GET	/v1/webhooks/{webhookId}	Get webhook
PUT	/v1/webhooks/{webhookId}	Update webhook
DELETE	/v1/webhooks/{webhookId}	Delete webhook

Billing

Payment and subscription endpoints:

Method	Endpoint	Description
GET	/v1/billing/plans	List available plans
GET	/v1/tenants/{tenantId}/billing	Get billing info
PUT	/v1/tenants/{tenantId}/billing/plan	Change plan
POST	/v1/billing/paddle/checkout	Start checkout
POST	/v1/billing/paddle/cancel	Cancel subscription

Roles (RBAC)

Role-based access control endpoints:

Method	Endpoint	Description
GET	/v1/roles	List tenant roles
GET	/v1/roles/me	Get my role
PUT	/v1/roles/{userId}	Set user role (owner only)
DELETE	/v1/roles/{userId}	Remove user (owner only)

Invites

Team invitation endpoints:

Method	Endpoint	Description
GET	/v1/tenants/{tenantId}/invites	List invites
POST	/v1/tenants/{tenantId}/invites	Create invite
DELETE	/v1/tenants/{tenantId}/invites/{inviteId}	Revoke invite
GET	/v1/invites/{token}/validate	Validate invite (public)
POST	/v1/invites/{token}/accept	Accept invite (public)

Next Steps

• API Overview - Learn about API conventions
• Authentication - Configure authentication
• SDK Quick Start - Get started with the SDK
• TypeScript SDK - Full SDK documentation